montagu

Python client for Montagu API


License
MIT
Install
pip install montagu==0.0.3

Documentation

montagu-py

Build Status codecov.io

Python client for Montagu API.

Initial use case is for authentication only.

Usage

The client currently supports authenticating with Montagu, and a single example endpoint.

To authenticate, instantiate the MontaguAPI class, providing base url, username and password as parameters:

api = MontaguAPI('http://localhost:8080', 'test.user@example.com', 'password')

The Montagu authentication token can be accessed on the api object:

token = api.token

The example endpoint returns a list of all diseases:

diseases = api.diseases()

Development

Clone the repo anywhere and install dependencies with (from the repo root):

pip3 install --user -r requirements.txt

Run dependencies (a local copy of Montagu API and database) with scripts/run-dev-dependencies.sh. This will also add a test user to Montagu.

Testing

Run dependencies as described above, then run pytest