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!
Testing
Tests can be run with:
python -m unittest discover tests -b
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
1 maintainer
Metadata
1 maintainer
Release files for pyrefinebio 0.4.11
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| pyrefinebio-0.4.11.tar.gz | 43.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyrefinebio-0.4.11-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 110.5 kB
Release files / pyrefinebio-0.4.11.tar.gz
| Download URL | pyrefinebio-0.4.11.tar.gz |
|---|---|
| Size | 43.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ac314a7e4ab4e4edd665e4242a3423712504d4497cd6f1b39d89cea02b60be2c
|
|
BLAKE2b-256 checksum How to use checksums |
67c8749c19dd95236917ee6ebab6edf24df0531e09b70fccb228b46057d3f84e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.12.0
|
Release files / pyrefinebio-0.4.11-py3-none-any.whl
| Download URL | pyrefinebio-0.4.11-py3-none-any.whl |
|---|---|
| Size | 66.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7229ce0fe41dccf75495ab40c6149a4dda07f06c30370201f9c060faef5dc255
|
|
BLAKE2b-256 checksum How to use checksums |
2da92d6827c791f0f5f828e1f8c13e979faedf6604f473c5a4bf4ee29cfbc284
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.12.0
|
Security for pyrefinebio 0.4.11
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
