Metadata-Version: 2.1
Name: ipr
Version: 3.0.0
Summary: UNKNOWN
Home-page: UNKNOWN
Author: graphkb
Author-email: graphkb@bcgsc.ca
Maintainer: graphkb
Maintainer-email: graphkb@bcgsc.ca
License: UNKNOWN
Description: 
        # IPR
        
        ![build](https://github.com/bcgsc/pori_ipr_python/workflows/build/badge.svg) [![PyPi](https://img.shields.io/pypi/v/ipr.svg)](https://pypi.org/project/ipr) [![codecov](https://codecov.io/gh/bcgsc/pori_ipr_python/branch/master/graph/badge.svg)](https://codecov.io/gh/bcgsc/pori_ipr_python) [![PyPI - Downloads](https://img.shields.io/pypi/dm/ipr)](https://pypistats.org/packages/ipr)
        
        This repository is part of the [platform for oncogenomic reporting and interpretation](https://github.com/bcgsc/pori).
        
        This python tool takes in variant inputs as tab-delimited files and annotates them using GraphKB.
        The resulting output is uploaded to IPR as a report. Additional report content such as images and
        metadata can be passed to be included in the report upload.
        
        For documentation on how to create reports using this adaptor, see the [main docuementation site](https://github.com/bcgsc/pori) for the platform.
        
        ## Getting Started
        
        ### Install (For developers)
        
        clone this repository
        
        ```bash
        git clone https://github.com/bcgsc/pori_ipr_python.git
        cd pori_ipr_python
        ```
        
        create a virtual environment
        
        ```bash
        python3 -m venv venv
        source venv/bin/activate
        ```
        
        install the package and its development dependencies
        
        ```bash
        pip install -e .[dev]
        ```
        
        Run the tests
        
        ```bash
        pytest tests
        ```
        
        ## Documentation
        
        The user documentation for this tool is hosted with the [main docuementation site](https://github.com/bcgsc/pori).
        
        Developers: Any updates to this tool should be edited and reflected in the main site documentation as well.
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: deploy
Provides-Extra: test
Provides-Extra: doc
