python adapter for interacting with the GraphKB API
Project description
GraphKB (Python)
Python adapter package for querying the GraphKB API. See the user manual
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, mkdocs-material, and markdown_refdocs.
First install the documentation dependencies
pip install .[doc]
Then generate the user manual files
markdown_refdocs graphkb -o docs/reference
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
python3 -m http.server -d build-docs
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/*
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.