Skip to main content

BioX: A foundation for reproducible bioinformatics tooling

Project description

BioX

BioX is a modern, production-grade Python package scaffold for reproducible bioinformatics tooling.

Features

  • src/ layout with Hatch builds
  • Typed code (mypy), linted and formatted with Ruff
  • Pytest + Coverage configuration
  • Pre-commit hooks
  • GitHub Actions CI for tests, lint, type-checking
  • Publishing to PyPI via GitHub Actions (API token) or Twine

Installation

pip install bioxai

Usage

from biox import hello
print(hello())

Development

  • Python >= 3.9
  • Create venv, then:
pip install -U pip
pip install -e .[dev]
pre-commit install
pytest

Releasing

  1. Update CHANGELOG.md and bump __version__ in src/biox/__init__.py.
  2. Create a git tag like v0.1.0 and push.
  3. GitHub Actions will build and publish to PyPI if PYPI_API_TOKEN is configured in repo secrets, or publish locally with Twine.

License

MIT

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

bioxai-0.0.2.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bioxai-0.0.2-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file bioxai-0.0.2.tar.gz.

File metadata

  • Download URL: bioxai-0.0.2.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for bioxai-0.0.2.tar.gz
Algorithm Hash digest
SHA256 2d3715f7f44e3a1c1b2b1fdde90d37e9c309364083fa02684ee4b44cfa3ce4b8
MD5 060d50eb1d19c8b971db019f3c14c35c
BLAKE2b-256 4bf3f42969eac1e4f60fc77cbdd2e79ca2a06221666193dba3884e17d675bb24

See more details on using hashes here.

File details

Details for the file bioxai-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: bioxai-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 3.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for bioxai-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 95af6fcb1cfaa656c5d81828a926e285801bfc94ca590baf963d83f582a253d3
MD5 541ec475904165a8bf231380a15fc182
BLAKE2b-256 5e148b844aaacbaed9500dc7b5087e969e9e68ff817b60c14343f0377149b83b

See more details on using hashes here.

Supported by

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