Metadata-Version: 2.4
Name: markusapi
Version: 0.5.0
Summary: Python API client for MarkUs
Author: Sam Maldonado, Alessio Di Sandro, Misha Schwartz
License-Expression: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Dist: requests~=2.32.5
Maintainer: David Liu
Maintainer-email: David Liu <david@cs.toronto.edu>
Requires-Python: >=3.9
Project-URL: Homepage, https://github.com/MarkUsProject/markus-api
Project-URL: Issues, https://github.com/MarkUsProject/markus-api/issues
Description-Content-Type: text/markdown

# Markus API

Python interface to the api for a [MarkUs](https://github.com/MarkUsProject/Markus) instance.

## Installation

Install this package with pip:

```
$ pip install markusapi
```

## Requirements

* python 3.6+
* the `url` of a running [MarkUs website](https://github.com/MarkUsProject/Markus)
* 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](https://github.com/MarkUsProject/Markus/wiki/RESTfulApiDocumentation)

