Metadata-Version: 2.1
Name: ref-builder
Version: 0.11.0
Summary: 
License: MIT
Author: Ian Boyes
Author-email: igboyes@gmail.com
Maintainer: Ian Boyes
Maintainer-email: igboyes@gmail.com
Requires-Python: >=3.12,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: arrow (>=1.3.0,<2.0.0)
Requires-Dist: biopython (>=1.84,<2.0)
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: orjson (>=3.10.6,<4.0.0)
Requires-Dist: platformdirs (>=4.2.2,<5.0.0)
Requires-Dist: pydantic (>=2.8.2,<3.0.0)
Requires-Dist: requests (>=2.32.3,<3.0.0)
Requires-Dist: rich (>=13.7.1,<14.0.0)
Requires-Dist: structlog (>=24.2.0,<25.0.0)
Description-Content-Type: text/markdown

# Reference Builder

Build and maintain reference sets of pathogen genome sequences.

## Installation

```shell script
pip install ref-builder
```

## Environmental Variables

Ref Builder uses the NCBI API to fetch genome data.

Unauthenticated requests are limited to 3 per second. Setting NCBI account credentials
in your environmental variables can increase the allowed rate to 10 requests per
second.

| Name | Description |
|----|---------|
| `NCBI_EMAIL` | The e-mail address used for your NCBI account |
| `NCBI_API_KEY` | The [API key](https://www.ncbi.nlm.nih.gov/account/settings/) associated with your NCBI account. |
