Skip to main content

A community-curated, decentralized biomedical ontology.

Project description

DeBiO

Tests PyPI PyPI - Python Version PyPI - License Documentation Status Codecov status Cookiecutter template from @cthoyt Code style: black Contributor Covenant

A community-curated, decentralized biomedical ontology.

🚀 Installation

The most recent code and data can be installed directly from GitHub with:

$ pip install git+https://github.com/biopragmatics/debio.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 @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/biopragmatics/debio.git
$ cd debio
$ 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.

📖 Building the Documentation

The documentation can be built locally using the following:

$ git clone git+https://github.com/biopragmatics/debio.git
$ cd debio
$ tox -e docs
$ open docs/build/html/index.html

The documentation automatically installs the package as well as the docs extra specified in the setup.cfg. sphinx plugins like texext can be added there. Additionally, they need to be added to the extensions list in docs/source/conf.py.

📦 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:

  1. Uses Bump2Version to switch the version number in the setup.cfg, src/debio/version.py, and docs/source/conf.py to not have the -dev suffix
  2. Packages the code in both a tar archive and a wheel using build
  3. Uploads to PyPI using twine. Be sure to have a .pypirc file configured to avoid the need for manual input at this step
  4. Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
  5. 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 minor after.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

debio-0.0.3.dev0.tar.gz (15.3 kB view details)

Uploaded Source

Built Distribution

debio-0.0.3.dev0-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file debio-0.0.3.dev0.tar.gz.

File metadata

  • Download URL: debio-0.0.3.dev0.tar.gz
  • Upload date:
  • Size: 15.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for debio-0.0.3.dev0.tar.gz
Algorithm Hash digest
SHA256 d6d474ffcdd3555f39b2fcf9b533218be183dbbb72d4f4c3e566a79d31520031
MD5 1c7c0174cd498c829e584571bc3bde65
BLAKE2b-256 7e58c3cc08c8f230cceebb5ae35bc9e17c7d885df395f924f5da23b195718221

See more details on using hashes here.

Provenance

File details

Details for the file debio-0.0.3.dev0-py3-none-any.whl.

File metadata

  • Download URL: debio-0.0.3.dev0-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for debio-0.0.3.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 8916632e13bbfe1cf7bee8be551d32b9872e335a5981847ff209478af35bc004
MD5 9542b82bbab2dd4e46ce6a538ef224ad
BLAKE2b-256 48ad5d3cded472d53aff6ade1e7c6060b6f0bf479202fc8db8e0f3945c2a54fe

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page