Common Python code used in HGI projects.
Project description
Common Python used in HGI projects
How to use
Prerequisites
Python >= 3.5
Installation
Stable releases can be installed via PyPI:
$ pip3 install hgicommon
Bleeding edge versions can be installed directly from GitHub:
$ pip3 install git+https://github.com/wtsi-hgi/python-common.git@<commit_id_or_branch_or_tag>#egg=hgicommon
To declare this library as a dependency of your project, add it to your requirement.txt file.
Development
Setup
Install both library dependencies and the dependencies needed for testing:
$ pip3 install -q -r requirements.txt
$ pip3 install -q -r test_requirements.txt
Testing
Using nosetests, in the project directory, run:
$ nosetests -v
To generate a test coverage report with nosetests:
$ nosetests -v --with-coverage --cover-package=hgicommon --cover-inclusive nosetests -v --with-coverage --cover-package=hgicommon --cover-inclusive --exclude-test-file=excluded_tests.txt
License
LGPL.
Copyright (c) 2015, 2016 Genome Research Limited