WDBio
Wikidata-related functions for bioinformatics
💪 Getting Started
TODO show in a very small amount of space the MOST useful thing your package can do. Make it as short as possible! You have an entire set of docs for later.
🚀 Installation
The most recent code and data can be installed directly from GitHub with:
$ pip install git+https://github.com/jvfe/wdbio.git
👐 Contributing
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.md for more information on getting involved.
👋 Attribution
⚖️ License
The code in this package is licensed under the MIT license.
🍪 Cookiecutter
This package was created with @audreyfeldroy's cookiecutter package using @jvfe's fork of @cthoyt's cookiecutter-snekpack template.
🛠️ For Developers
See developer instructions
The final section of the README is for if you want to get involved by making a code contribution.
Development Installation
To install in development mode, use the following:
$ git clone git+https://github.com/jvfe/wdbio.git
$ cd wdbio
$ pip install -e .
🥼 Testing
After cloning the repository and installing tox with pip install tox, the unit tests in the tests/ folder can be
run reproducibly with:
$ tox
Additionally, these tests are automatically re-run with each commit in a GitHub Action.
📦 Making a Release
After installing the package in development mode and installing
tox with pip install tox, the commands for making a new release are contained within the finish environment
in tox.ini. Run the following from the shell:
$ tox -e finish
This script does the following:
- Uses Bump2Version to switch the version number in the
setup.cfgandwdbio/__init__.pyto not have the-devsuffix - Packages the code in both a tar archive and a wheel using
build - Uploads to PyPI using
twine. Be sure to have a.pypircfile configured to avoid the need for manual input at this step - Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
- Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can
use
tox -e bumpversion -- minorafter.
Release files for wdbio 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| wdbio-0.0.2.tar.gz | 5.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| wdbio-0.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.5 kB
Release files / wdbio-0.0.2.tar.gz
| Download URL | wdbio-0.0.2.tar.gz |
|---|---|
| Size | 5.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
371305ed508d622631721a75e48197562582c11b77fd37dc9aad1a0bbaec70bd
|
|
BLAKE2b-256 checksum How to use checksums |
a46b1529c813576aeba39cb5f5077df1e78a0aa9d1fefb852b0f3eb621d61ae5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.9
|
Release files / wdbio-0.0.2-py3-none-any.whl
| Download URL | wdbio-0.0.2-py3-none-any.whl |
|---|---|
| Size | 4.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e96ec6f326c58cf40721faec1126f475544cf1a2c11ee00ec5e35fd7e8d49400
|
|
BLAKE2b-256 checksum How to use checksums |
a0bfd624b380f12b76576d7db0839bafe0f16682d52e27fc7ea72ebe09b7158b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.9
|
