graphkb 1.15.0

python adapter for interacting with the GraphKB API

GraphKB (Python)

This repository is part of the platform for oncogenomic reporting and interpretation.

Python adapter package for querying the GraphKB API. See the user manual

• Getting Started
  • Install (For developers)
  • Run Tests
• Generating the Documentation
• 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 -U pip setuptools
pip install -e .[dev]

Run Tests

pytest tests

Generating the Documentation

User documentation for this repository is hosted in the central PORI repository

Deployment (Publishing)

Install the deployment dependencies

pip install .[deploy]

Build the distribution files

python setup.py install sdist bdist_wheel

Upload the distibutions to the package server (-r is defined in your pypirc)

twine upload -r bcgsc dist/*