Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 923 Bytes

README.md

File metadata and controls

44 lines (27 loc) · 923 Bytes

Markus API

Python interface to the api for a MarkUs instance.

Installation

Install this package with pip:

$ pip install git+https://github.com/MarkusProject/markus-api.git

Requirements

  • python 3.6+
  • the url of a running MarkUs website
  • your api_key (this can be obtained from the dashboard page of the MarkUs website)

Usage Example

Create a new Markus Api object:

import markusapi

api_key = 'mysecretapikey='
url = 'https://localhost:3000'

api = markusapi.Markus(api_key, url)

Print all user information

user_info = api.get_all_users()
print(user_info)

Additional Info

Check out the MarkUs API documentation for details on API calls:

https://github.com/MarkUsProject/Markus/wiki/RESTfulApiDocumentation