Metadata-Version: 1.1
Name: biomedsheets
Version: 0.2
Summary: Python 3 library for accessing and managing BioMedical sheets
Home-page: https://github.com/bihealth/biomedsheets
Author: Manuel Holtgrewe
Author-email: manuel.holtgrewe@bihealth.de
License: MIT license
Description: =============
        BioMed Sheets
        =============
        
        .. image:: https://travis-ci.org/bihealth/biomedsheets.svg?branch=master
            :target: https://travis-ci.org/bihealth/biomedsheets
        
        .. image:: https://readthedocs.org/projects/biomedsheets/badge/?version=master
            :target: http://biomedsheets.readthedocs.io/en/master/?badge=master
        
        .. image:: https://api.codacy.com/project/badge/Grade/842a296b23d5450eb7bc525621d7f5a2
            :target: https://www.codacy.com/app/manuel-holtgrewe/biomedsheets?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=bihealth/biomedsheets&amp;utm_campaign=Badge_Grade
        
        .. image:: https://api.codacy.com/project/badge/Coverage/842a296b23d5450eb7bc525621d7f5a2
            :target: https://www.codacy.com/app/manuel-holtgrewe/biomedsheets?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=bihealth/biomedsheets&amp;utm_campaign=Badge_Coverage
        
        This project contains the documentation for the BioMedical sample sheets project.
        Further, it contains the implementation of a Python API for I/O and comfortable access to the sample sheets and some CLI tools.
        
        ------------
        Installation
        ------------
        
        It's best to start a new virtualenv
        
        ::
        
            $ virtualenv -p python3 venv
            $ source venv/bin/activate
            $ pip install -r requirements_dev.txt
            $ pip install -e .
        
        Use ``python setup.py install`` if you want to copy the files instead of creating a link only.
        
        ----------------------
        Building Documentation
        ----------------------
        
        After installation (``requirements_dev.txt`` contains the appropriate Sphinx version)
        
        ::
        
            $ cd docs
            $ make clean html
        
        Now, open ``docs/build/html/index.html``.
        
        -------------
        Running Tests
        -------------
        
        ::
        
            $ py.test
        
        
        =======================
        BioMed Sheets Changelog
        =======================
        
        ----
        v0.2
        ----
        
        - Auto-deployment to pypi
        - Fixing shortcuts to father/mother during cohort loading
        - Cleanup code (according to Flake 8)
        - Adding more tests, replacing examples by TSV files
        - Removing protein pools
        - Adding Sphinx-based ocumentation
        - Restructuring requirements txt files
        - Configurable entity name generation.
          This allows to use secondary id only for naming, e.g.
        - Fixing ``requirements*.txt`` files for always using SSH
        - Fixing sample naming for germline sample sheets
        - Adding versioneer integration
        
        ------
        v0.1.1
        ------
        
        - First actual release, versioning done using versioneer
        - Everything is new!
        
Keywords: biomedsheets
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
