A python client for the refine.bio API.
Project description
refinebio-py
A python client for the refine.bio API.
Usage
pyrefinebio
can be installed via pip
$ pip install pyrefinebio
You can then import and start using it right away!
import pyrefinebio
pyrefinebio.download_dataset(
"./ds.zip",
"foo@bar.com",
dataset_dict={
"SRP066781": ["ALL"]
}
)
See the documentation for more help!
Releasing to PyPI
pyrefinebio
can automatically be released to PyPI via a GitHub action.
To trigger the action, create a new release via GitHub:
- go to the GitHub repo's release page
- click
Draft a new release
- fill out the form
- the Tag version should be in the form
vX.X.X
- the Tag version should be in the form
- click
Publish release
- the action should automatically be triggered
Documentation
The docs are generated using sphinx autodoc.
Generating the Docs
Before you can generate the docs you must install pyrefienbio and sphinx requirements.
I recommend setting up a virtual environment before installing the requirements, but that step is optional.
To install the requirements:
$ pip install -r requirements.txt
$ pip install -r docs-requirements.txt
Then, to generate the docs navigate to ./docs
and run the command:
$ make html
The output will be in ./docs/_build
Open ./docs/_build/html/*
in a browser to view the docs
Deploying the Docs to Github Pages
First, set the variable release
in ./docs/conf.py
to the correct version.
Then, clone the branch gh-pages
into a folder ./doc-output
You can use the following command to do this:
$ git clone --single-branch --branch gh-pages https://github.com/AlexsLemonade/refinebio-py.git doc-output
Navigate tho ./docs
and run the command:
$ make github
Navigate to ./doc-output
and commit and push any changes
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.
Source Distribution
Built Distribution
Hashes for pyrefinebio-0.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ed16c1ce46cdd41c7274568d95ddd9ef6a8dba11b387e0a0a1d138f68a80cbc |
|
MD5 | 58cab1d068f2390fd6dc2880630f00af |
|
BLAKE2b-256 | cad4fff2784e6745bab63a519cd3460dda77e058ea9284e19266ea6114cc383f |