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
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
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.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0071081dd0b1ff7d171f88681cd1f9e691cba6b320f9de8b24ec03b1880e94d0 |
|
MD5 | 0a646cad26244fcdc28e88c3eae6d0fa |
|
BLAKE2b-256 | 047025705be9bb26e79ba2baaca74a273001c583bf48a17f77f8586187c819ae |