Metadata-Version: 2.1
Name: py-gene-fusions
Version: 0.0.3
Summary: Package for structuring gene fusions
Home-page: https://github.com/cancervariants/py-gene-fusions
Author: Wagner Lab, Nationwide Childrens Hospital
License: MIT
Description: # py-gene-fusions
        
        Base Package for Fusion Curation
        
        ### Installation
        
        To install py-gene-fusions:
        ```commandline
        pip install py-gene-fusions
        ```
        
        For a development install, we recommend using Pipenv. See the 
        [pipenv docs](https://pipenv-fork.readthedocs.io/en/latest/#install-pipenv-today) 
        for direction on installing pipenv in your compute environment.
         
        Once installed, from the project root dir, just run:
        
        ```commandline
        pipenv lock
        pipenv sync
        ```
        
        ### Init coding style tests
        
        Code style is managed by [flake8](https://github.com/PyCQA/flake8) and checked prior to commit.
        
        We use [pre-commit](https://pre-commit.com/#usage) to run conformance tests.
        
        This ensures:
        
        * Check code style
        * Check for added large files
        * Detect AWS Credentials
        * Detect Private Key
        
        Before first commit run:
        
        ```commandline
        pre-commit install
        ```
        
        
        ### Running unit tests
        
        Running unit tests is as easy as pytest.
        
        ```commandline
        pipenv run pytest
        ```
Platform: UNKNOWN
Requires-Python: >=3.7
Description-Content-Type: text/markdown
