Metadata-Version: 1.1
Name: hgicommon
Version: 1.3.1
Summary: Common Python code used in HGI projects.
Home-page: https://github.com/wtsi-hgi/python-common
Author: Colin Nolan
Author-email: colin.nolan@sanger.ac.uk
License: LGPL
Description-Content-Type: UNKNOWN
Description: |Build Status| |codecov.io|
        
        Common Python used in HGI projects
        ==================================
        
        How to use
        ----------
        
        Prerequisites
        ~~~~~~~~~~~~~
        
        -  Python >= 3.5
        
        Installation
        ~~~~~~~~~~~~
        
        Stable releases can be installed via PyPI:
        
        .. code:: bash
        
            $ pip3 install hgicommon
        
        Bleeding edge versions can be installed directly from GitHub:
        
        .. code:: bash
        
            $ 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:
        
        .. code:: bash
        
            $ pip3 install -q -r requirements.txt
            $ pip3 install -q -r test_requirements.txt
        
        Testing
        ~~~~~~~
        
        Using nosetests, in the project directory, run:
        
        .. code:: bash
        
            $ nosetests -v
        
        To generate a test coverage report with nosetests:
        
        .. code:: bash
        
            $ 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 <LICENSE.txt>`__.
        
        Copyright (c) 2015, 2016 Genome Research Limited
        
        .. |Build Status| image:: https://travis-ci.org/wtsi-hgi/python-common.svg
           :target: https://travis-ci.org/wtsi-hgi/python-common
        .. |codecov.io| image:: https://codecov.io/gh/wtsi-hgi/python-common/graph/badge.svg
           :target: https://codecov.io/github/wtsi-hgi/python-common
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.5
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
