<h1 align="center">bedboss</h1>
<div align="center">
[![PEP compatible](https://pepkit.github.io/img/PEP-compatible-green.svg)](https://pep.databio.org/)
![Run pytests](https://github.com/bedbase/bedboss/workflows/Run%20instalation%20test/badge.svg)
[![pypi-badge](https://img.shields.io/pypi/v/bedboss?color=%2334D058)](https://pypi.org/project/bedboss)
[![pypi-version](https://img.shields.io/pypi/pyversions/bedboss.svg?color=%2334D058)](https://pypi.org/project/bedboss)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Github badge](https://img.shields.io/badge/source-github-354a75?logo=github)](https://github.com/databio/bedboss)
</div>
---
**Documentation**: <a href="https://docs.bedbase.org/bedboss" target="_blank">https://docs.bedbase.org/bedboss</a>
**Source Code**: <a href="https://github.com/databio/bedboss" target="_blank">https://github.com/databio/bedboss</a>
---
BEDboss is a command-line management tool for BEDbase. It contains pipelines that filters, standardizes, and calculates statistics for genomic interval data,
functions that enters the results into a BEDbase database, deletes bed and bedsets from the database, and indexes the data to qdrant.
## Installation
To install `bedboss` use this command:
```
pip install bedboss
```
or install the latest version from the GitHub repository:
```
pip install git+https://github.com/databio/bedboss.git
```
## Development
For development, you should install all the dependencies, create a virtual environment, and work on the local database.
The workflow is described in the [development documentation](https://docs.bedbase.org/bedboss/development).
## Testing
### Requirements test:
To test requirements, install bedboss and run:
```
bedboss requirements-check
```
### Smoke tests:
Use this docs:
- [./test/README.md](./test/README.md)
## How to generate usage documentation:
Run this command in the root of the repository:
```
cd scripts
bash update_usage_docs.sh
```
Raw data
{
"_id": null,
"home_page": "https://databio.org",
"name": "bedboss",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "project, bioinformatics, sequencing, ngs, workflow",
"author": null,
"author_email": "khorosh@virginia.edu",
"download_url": "https://files.pythonhosted.org/packages/b5/af/8241226220d5c566a891d7aa8b19e92b281a56481ca54419070e5f71e651/bedboss-0.5.0.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">bedboss</h1>\n\n<div align=\"center\">\n \n[![PEP compatible](https://pepkit.github.io/img/PEP-compatible-green.svg)](https://pep.databio.org/)\n![Run pytests](https://github.com/bedbase/bedboss/workflows/Run%20instalation%20test/badge.svg)\n[![pypi-badge](https://img.shields.io/pypi/v/bedboss?color=%2334D058)](https://pypi.org/project/bedboss)\n[![pypi-version](https://img.shields.io/pypi/pyversions/bedboss.svg?color=%2334D058)](https://pypi.org/project/bedboss)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Github badge](https://img.shields.io/badge/source-github-354a75?logo=github)](https://github.com/databio/bedboss)\n\n</div>\n\n---\n\n**Documentation**: <a href=\"https://docs.bedbase.org/bedboss\" target=\"_blank\">https://docs.bedbase.org/bedboss</a>\n\n**Source Code**: <a href=\"https://github.com/databio/bedboss\" target=\"_blank\">https://github.com/databio/bedboss</a>\n\n---\n\nBEDboss is a command-line management tool for BEDbase. It contains pipelines that filters, standardizes, and calculates statistics for genomic interval data, \nfunctions that enters the results into a BEDbase database, deletes bed and bedsets from the database, and indexes the data to qdrant.\n\n## Installation\nTo install `bedboss` use this command: \n```\npip install bedboss\n```\nor install the latest version from the GitHub repository:\n```\npip install git+https://github.com/databio/bedboss.git\n```\n\n## Development\nFor development, you should install all the dependencies, create a virtual environment, and work on the local database.\nThe workflow is described in the [development documentation](https://docs.bedbase.org/bedboss/development).\n\n\n## Testing\n\n### Requirements test:\n\nTo test requirements, install bedboss and run: \n\n```\nbedboss requirements-check\n```\n\n### Smoke tests:\n\nUse this docs:\n- [./test/README.md](./test/README.md)\n\n\n## How to generate usage documentation:\n\nRun this command in the root of the repository:\n```\ncd scripts\nbash update_usage_docs.sh\n```\n",
"bugtrack_url": null,
"license": "BSD2",
"summary": "Pipelines for genomic region file to produce bed files, and it's statistics",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://databio.org"
},
"split_keywords": [
"project",
" bioinformatics",
" sequencing",
" ngs",
" workflow"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cecacb7310c4e720133af810c42ae59b5f692515b9f77859c455cc1da944ed0a",
"md5": "b991e002f430c12179db45424bceed71",
"sha256": "310f08840ee2bb52715c3f4e6033a4b3fe71def9254cdb1aab86ec0fba2efefb"
},
"downloads": -1,
"filename": "bedboss-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b991e002f430c12179db45424bceed71",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 104238,
"upload_time": "2024-10-07T18:16:51",
"upload_time_iso_8601": "2024-10-07T18:16:51.439787Z",
"url": "https://files.pythonhosted.org/packages/ce/ca/cb7310c4e720133af810c42ae59b5f692515b9f77859c455cc1da944ed0a/bedboss-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b5af8241226220d5c566a891d7aa8b19e92b281a56481ca54419070e5f71e651",
"md5": "0df378f642be8c88f0724f6f4ac6ee2c",
"sha256": "59266028e0edb8e6498f32518de01cb4670aa751f899dc78a15d7ac6b70cafb5"
},
"downloads": -1,
"filename": "bedboss-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "0df378f642be8c88f0724f6f4ac6ee2c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 95455,
"upload_time": "2024-10-07T18:16:53",
"upload_time_iso_8601": "2024-10-07T18:16:53.194936Z",
"url": "https://files.pythonhosted.org/packages/b5/af/8241226220d5c566a891d7aa8b19e92b281a56481ca54419070e5f71e651/bedboss-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 18:16:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "bedboss"
}