Skip to content

EMBL-EBI-TSI/aap-client-python

Repository files navigation

https://travis-ci.org/EMBL-EBI-TSI/aap-client-python.svg?branch=master Documentation Status

Overview

This library is meant to be used in the backed to interact with Tokens produced by EBI's AAP

Cryptographic files here shouldn't be used in production, they're just for testing :)

Usage

To install the package, enable the virtual environment where it's going to be used and run $ pip install aap-client-python

To use the Flask functionality this needs to be installed: $ pip install aap-client-python[flask]

Developing

To prepare the environment for developing the library, create a virtual environment, go to project root and then run:

$ pip install -e .[dev]

Testing

The recommended way is to test using detox. This allows for testing in all the supported python versions using virtual environments effortlessly. To use, install it, then run in the project root:

$ pip install detox
$ detox

Alternatively, testing can be done in the same environment as the dev one by installing it's dependencies, then running pytest:

$ pip install -e .[test]
$ python -m pytest -s