bedboss


Namebedboss JSON
Version 0.4.0 PyPI version JSON
download
home_pagehttps://databio.org
SummaryPipelines for genomic region file to produce bed files, and it's statistics
upload_time2024-08-26 17:33:53
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseBSD2
keywords project bioinformatics sequencing ngs workflow
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <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/9e/ee/d8b7a78d4fee058cdb9bd920e74ef40d96d0c714d2b09927d6860e91b5e7/bedboss-0.4.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.4.0",
    "project_urls": {
        "Homepage": "https://databio.org"
    },
    "split_keywords": [
        "project",
        " bioinformatics",
        " sequencing",
        " ngs",
        " workflow"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "923cbd61df4ce2c40ecad3f6ddb6919a0bb509da4f7ac4d52fb88ad273660ebc",
                "md5": "c90756bcf743f891ff966031e436359f",
                "sha256": "b44d6e6269238b7d66b96d592073f30a295f7e47e35597a37d14a74ac55848dc"
            },
            "downloads": -1,
            "filename": "bedboss-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c90756bcf743f891ff966031e436359f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 46585,
            "upload_time": "2024-08-26T17:33:51",
            "upload_time_iso_8601": "2024-08-26T17:33:51.832398Z",
            "url": "https://files.pythonhosted.org/packages/92/3c/bd61df4ce2c40ecad3f6ddb6919a0bb509da4f7ac4d52fb88ad273660ebc/bedboss-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9eeed8b7a78d4fee058cdb9bd920e74ef40d96d0c714d2b09927d6860e91b5e7",
                "md5": "89a9fca80f432eb81a8ec7154e585602",
                "sha256": "08b5dd589edbcfcc25ddacf9310b1f86f94077495d7f37cba8d4779f5d09d7b4"
            },
            "downloads": -1,
            "filename": "bedboss-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "89a9fca80f432eb81a8ec7154e585602",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 39477,
            "upload_time": "2024-08-26T17:33:53",
            "upload_time_iso_8601": "2024-08-26T17:33:53.342119Z",
            "url": "https://files.pythonhosted.org/packages/9e/ee/d8b7a78d4fee058cdb9bd920e74ef40d96d0c714d2b09927d6860e91b5e7/bedboss-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-26 17:33:53",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "bedboss"
}
        
Elapsed time: 0.75426s