# bedboss
[![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)
---
**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 pipeline that filters, standardizes, and calculates statistics for genomic interval data,
and enters the results into a BEDbase database.
## 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": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "project,bioinformatics,sequencing,ngs,workflow",
"author": "",
"author_email": "khorosh@virginia.edu",
"download_url": "https://files.pythonhosted.org/packages/ac/44/b4022c5c1179b4d887f97261ba1ddcda03c53d447dc19fcff51ca7ad9e2f/bedboss-0.1.0.tar.gz",
"platform": null,
"description": "# bedboss\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---\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 pipeline that filters, standardizes, and calculates statistics for genomic interval data, \nand enters the results into a BEDbase database. \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.1.0",
"project_urls": {
"Homepage": "https://databio.org"
},
"split_keywords": [
"project",
"bioinformatics",
"sequencing",
"ngs",
"workflow"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9a89023b7137e921336abc1a633ec853644dc0afa2879e299e4e08d1bffbf3ed",
"md5": "ab30bbc16cf919bdb504dde131fbd882",
"sha256": "fc588d7fb7457256be37a5e9f6096ca860db8625cbfe67ab2bfabd6829376e58"
},
"downloads": -1,
"filename": "bedboss-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ab30bbc16cf919bdb504dde131fbd882",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 40532,
"upload_time": "2024-02-29T16:50:48",
"upload_time_iso_8601": "2024-02-29T16:50:48.682786Z",
"url": "https://files.pythonhosted.org/packages/9a/89/023b7137e921336abc1a633ec853644dc0afa2879e299e4e08d1bffbf3ed/bedboss-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ac44b4022c5c1179b4d887f97261ba1ddcda03c53d447dc19fcff51ca7ad9e2f",
"md5": "a390aab49bf47758951e7b2dd391df16",
"sha256": "27575239eb3e3bb7ecba0444781e070a614193355275d7cfae87437b0516960e"
},
"downloads": -1,
"filename": "bedboss-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "a390aab49bf47758951e7b2dd391df16",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 37786,
"upload_time": "2024-02-29T16:50:49",
"upload_time_iso_8601": "2024-02-29T16:50:49.998301Z",
"url": "https://files.pythonhosted.org/packages/ac/44/b4022c5c1179b4d887f97261ba1ddcda03c53d447dc19fcff51ca7ad9e2f/bedboss-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-29 16:50:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "bedboss"
}