bvbrc documentation#

Welcome to the documentation for bvbrc!

The Bacterial and Viral Bioinformatics Resource Center (BV-BRC) is an online resource for research in bacterial and viral infectious disease. BV-BRC provides a Data API that can be used to request data from BV-BRC in your own workflows.

bvbrc is a python package that is intended to make interacting with the BV-BRC Data API within python code feel straightfoward and intuitive. Take a look at the quickstart to get started!

Installation#

bvbrc can be installed from PyPI using pip:

pip install bvbrc

If you want to be able to convert the API responses to a pandas or polars DataFrame, then you must also install the appropriate package:

pip install pandas

pip install polars

Contributing#

This project is open source and contributions are welcome! If you are interested in contributing, please visit the GitHub page to find out more.