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.1.1.tar.gz (16.1 kB view details)

Uploaded Source

Built Distribution

debio-0.1.1-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file debio-0.1.1.tar.gz.

File metadata

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

File hashes

Hashes for debio-0.1.1.tar.gz
Algorithm Hash digest
SHA256 ece423fb830c2b8e8f2a2d7ce5ffb9033095524a4113c04de1c2747ad4c062f5
MD5 7fefe7b514b9f4d77a8c1d6adfacdec2
BLAKE2b-256 09671a1094cba37535201bb9a54a96c9aa3aa6fe8a0d264a31b1bfecae567a04

See more details on using hashes here.

Provenance

File details

Details for the file debio-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: debio-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 10.0 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.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 66156b0324570439b8c109b7b807942ef041157a4ab0c7f107aa43a868332f2f
MD5 2a7dc9483453e97ab78dfce047b85af7
BLAKE2b-256 3e51b3af65973f61111fe5e54ae990a60eaf5af8253b3c1a7e45148ac9308900

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