Metadata-Version: 2.1
Name: graphkb
Version: 1.5.2
Summary: python adapter for interacting with the GraphKB API
Home-page: https://github.com/bcgsc/pori_graphkb_python
Author-email: graphkb@bcgsc.ca
License: UNKNOWN
Description: 
        # GraphKB (Python)
        
        ![build](https://github.com/bcgsc/pori_graphkb_python/workflows/build/badge.svg) [![PyPi](https://img.shields.io/pypi/v/graphkb.svg)](https://pypi.org/project/graphkb) [![codecov](https://codecov.io/gh/bcgsc/pori_graphkb_python/branch/master/graph/badge.svg)](https://codecov.io/gh/bcgsc/pori_graphkb_python) [![PyPI - Downloads](https://img.shields.io/pypi/dm/graphkb)](https://pypistats.org/packages/graphkb)
        
        Python adapter package for querying the GraphKB API. See the [user manual](https://bcgsc.github.io/pori_graphkb_python/)
        
        - [Getting Started](#getting-started)
          - [Install (For developers)](#install-for-developers)
          - [Run Tests](#run-tests)
        - [Generating the Documentation](#generating-the-documentation)
        - [Deployment (Publishing)](#deployment-publishing)
        
        ## Getting Started
        
        ### Install (For developers)
        
        clone this repository
        
        ```
        git clone https://github.com/bcgsc/pori_graphkb_python
        cd pori_graphkb_python
        ```
        
        create a virtual environment
        
        ```
        python3 -m venv venv
        source venv/bin/activate
        ```
        
        install the package and its development dependencies
        
        ```
        pip install -e .[dev]
        ```
        
        ### Run Tests
        
        ```
        pytest tests
        ```
        
        ## Generating the Documentation
        
        This documentation is generated using [mkdocs](https://www.mkdocs.org), [mkdocs-material](https://pypi.org/project/mkdocs-material), and [markdown_refdocs](https://pypi.org/project/markdown-refdocs).
        
        First install the documentation dependencies
        
        ```bash
        pip install .[doc]
        ```
        
        Then generate the user manual files
        
        ```bash
        markdown_refdocs graphkb -o docs/reference --link
        mkdocs build
        ```
        
        There should now be static html files under `build-docs`. To view the files, serve the folder using
        the built-in python http server
        
        ```bash
        python3 -m http.server -d build-docs
        ```
        
        ## Deployment (Publishing)
        
        Install the deployment dependencies
        
        ```bash
        pip install .[deploy]
        ```
        
        Build the distribution files
        
        ```bash
        python setup.py install sdist bdist_wheel
        ```
        
        Upload the distibutions to the package server (`-r` is defined in your pypirc)
        
        ```bash
        twine upload -r bcgsc dist/*
        ```
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: deploy
Provides-Extra: test
Provides-Extra: doc
