Contributing

Installing prerequisites

Make sure you have Python 3.6+ installed on your system. If you don’t have it yet, follow these instructions.

Preparing environment

Fork the main Resolwe SDK for Python git repository.

If you don’t have Git installed on your system, follow these instructions.

Clone your fork (replace <username> with your GitHub account name) and change directory:

git clone https://github.com/<username>/resolwe-bio-py.git
cd resolwe-bio-py

Prepare Resolwe SDK for Python for development:

pip install -e .[docs,package,test]

Note

We recommend using venv to create an isolated Python environment.

Running tests

Run unit tests:

py.test

Coverage report

To see the tests’ code coverage, use:

py.test --cov=resdk

To generate an HTML file showing the tests’ code coverage, use:

py.test --cov=resdk --cov-report=html

Building documentation

python setup.py build_sphinx