| Name | bioxai JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | None |
| Summary | BioX: A foundation for reproducible bioinformatics tooling |
| upload_time | 2025-08-27 16:18:02 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License
Copyright (c) 2025 Rahul Brahma
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE. |
| keywords |
bioinformatics
biology
biox
science
toolkit
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
```bash
pip install bioxai
```
## Usage
```python
from biox import hello
print(hello())
```
## Development
- Python >= 3.9
- Create venv, then:
```bash
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
Raw data
{
"_id": null,
"home_page": null,
"name": "bioxai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Rahulk Brahma <rahu.brahma@uni-greifswald.de>",
"keywords": "bioinformatics, biology, biox, science, toolkit",
"author": null,
"author_email": "Rahulk Brahma <rahu.brahma@uni-greifswald.de>",
"download_url": "https://files.pythonhosted.org/packages/4b/f3/f42969eac1e4f60fc77cbdd2e79ca2a06221666193dba3884e17d675bb24/bioxai-0.0.2.tar.gz",
"platform": null,
"description": "# BioX\n\nBioX is a modern, production-grade Python package scaffold for reproducible bioinformatics tooling.\n\n## Features\n\n- src/ layout with Hatch builds\n- Typed code (mypy), linted and formatted with Ruff\n- Pytest + Coverage configuration\n- Pre-commit hooks\n- GitHub Actions CI for tests, lint, type-checking\n- Publishing to PyPI via GitHub Actions (API token) or Twine\n\n## Installation\n\n```bash\npip install bioxai\n```\n\n## Usage\n\n```python\nfrom biox import hello\nprint(hello())\n```\n\n## Development\n\n- Python >= 3.9\n- Create venv, then:\n\n```bash\npip install -U pip\npip install -e .[dev]\npre-commit install\npytest\n```\n\n## Releasing\n\n1. Update `CHANGELOG.md` and bump `__version__` in `src/biox/__init__.py`.\n2. Create a git tag like `v0.1.0` and push.\n3. GitHub Actions will build and publish to PyPI if `PYPI_API_TOKEN` is configured in repo secrets, or publish locally with Twine.\n\n## License\n\nMIT\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Rahul Brahma\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in\n all copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n THE SOFTWARE.",
"summary": "BioX: A foundation for reproducible bioinformatics tooling",
"version": "0.0.2",
"project_urls": {
"Changelog": "https://github.com/takshan/biox/blob/main/CHANGELOG.md",
"Documentation": "https://github.com/takshan/biox#readme",
"Homepage": "https://github.com/takshan/biox",
"Issues": "https://github.com/takshan/biox/issues",
"Source": "https://github.com/takshan/biox"
},
"split_keywords": [
"bioinformatics",
" biology",
" biox",
" science",
" toolkit"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5e148b844aaacbaed9500dc7b5087e969e9e68ff817b60c14343f0377149b83b",
"md5": "541ec475904165a8bf231380a15fc182",
"sha256": "95af6fcb1cfaa656c5d81828a926e285801bfc94ca590baf963d83f582a253d3"
},
"downloads": -1,
"filename": "bioxai-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "541ec475904165a8bf231380a15fc182",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 3632,
"upload_time": "2025-08-27T16:18:00",
"upload_time_iso_8601": "2025-08-27T16:18:00.785214Z",
"url": "https://files.pythonhosted.org/packages/5e/14/8b844aaacbaed9500dc7b5087e969e9e68ff817b60c14343f0377149b83b/bioxai-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4bf3f42969eac1e4f60fc77cbdd2e79ca2a06221666193dba3884e17d675bb24",
"md5": "060d50eb1d19c8b971db019f3c14c35c",
"sha256": "2d3715f7f44e3a1c1b2b1fdde90d37e9c309364083fa02684ee4b44cfa3ce4b8"
},
"downloads": -1,
"filename": "bioxai-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "060d50eb1d19c8b971db019f3c14c35c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 3221,
"upload_time": "2025-08-27T16:18:02",
"upload_time_iso_8601": "2025-08-27T16:18:02.832850Z",
"url": "https://files.pythonhosted.org/packages/4b/f3/f42969eac1e4f60fc77cbdd2e79ca2a06221666193dba3884e17d675bb24/bioxai-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-27 16:18:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "takshan",
"github_project": "biox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bioxai"
}
