Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 1.02 KB

README.md

File metadata and controls

48 lines (30 loc) · 1.02 KB
Raw

Markus API

Python interface to the api for a MarkUs instance.

Installation

Install this package with pip:

$ pip install markusapi

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)

Compatibility

  • version 0.2 of this package is compatible with MarkUs version < 2.0
  • version 0.3 of this package is compatible with MarkUs version >= 2.0

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