Metadata-Version: 2.1
Name: bbconf
Version: 0.4.0a3
Summary: Configuration package for bedbase project
Home-page: https://databio.org
Author: Michal Stolarczyk
Author-email: michal@virginia.edu
License: BSD2
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# bbconf

![Run pytests](https://github.com/databio/bbconf/workflows/Run%20pytests/badge.svg)
[![codecov](https://codecov.io/gh/databio/bbconf/branch/master/graph/badge.svg)](https://codecov.io/gh/databio/bbconf)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)


*BEDBASE* project configuration package

## What is this?

`bbconf` standardizes reporting of [bedstat](https://github.com/databio/bedstat) and [bedbuncher](https://github.com/databio/bedsbuncher) results. It formalizes a way for these pipelines and downstream tools to communicate -- the produced results can easily and reliably become an
input for the server ([bedhost](https://github.com/databio/bedhost)). The object exposes API for interacting with the results and is backed by a [PostgreSQL](https://www.postgresql.org/) database.

## Installation

Install from [GitHub releases](https://github.com/databio/bbconf/releases) or from PyPI using `pip`:
```
pip install --user bbconf
```

## Documentation
- [Bedbase configuration file](docs/config.ipynb)
- [Usage demonstration](docs/demo.ipynb)
- [Python API](docs/bbc_api.md)
