Add README Quickstart with prerequisites; update author email

- README: add a 5-minute Quickstart with a Python 3.9+ prerequisites
  block (OS-specific python3/pip notes + venv step for PEP-668 systems)
- pyproject: set author email to david.boyd1@dc.gov

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-06-25 14:54:39 -04:00
parent 74ba9fe781
commit 5c8e0f11f3
2 changed files with 36 additions and 1 deletions

View File

@ -5,6 +5,41 @@ A small, dependency-light Python library for pulling U.S. Bureau of Labor Statis
productivity — with pre-built series-ID helpers so you never have to hand-encode a productivity — with pre-built series-ID helpers so you never have to hand-encode a
series ID. series ID.
---
## ⚡ Quickstart (5 minutes)
**Prerequisites:** Python **3.9 or newer** — get it at
[python.org/downloads](https://www.python.org/downloads/) if needed, then verify with
`python3 --version`. On macOS/Linux use `python3` / `pip3`; on Windows use `python` /
`pip`. On recent Ubuntu/Debian, create a virtual environment first so `pip` will run:
`python3 -m venv .venv && . .venv/bin/activate`.
```bash
# 1. Register a FREE BLS API key (instant, emailed in seconds):
# https://data.bls.gov/registrationEngine/
# 2. Set up config (config.example.py ships a template):
cp config.example.py config.py
export BLS_API_KEY="your-key-here" # config.py reads this env var
# 3. Install the one dependency:
pip install -r requirements.txt
# 4. Generate the DC/MD/VA unemployment report:
python3 generate_report.py # → dc_md_va_unemployment_report.html
```
**Want to see the output first?** Open the included `dc_md_va_unemployment_report.html`
in any browser — it's a finished sample, fully self-contained, no internet required.
**Where to go next:** `docs/BLS_Library_Overview.md` for the full tour · `USAGE.md` for
the API · `series_id_formats.md` for building your own series IDs.
> **Note:** You must use **your own** free BLS key. No key is included in this package.
---
```python ```python
from bls_client import BLSClient from bls_client import BLSClient
from bls_client.queries import employment, prices from bls_client.queries import employment, prices

View File

@ -9,7 +9,7 @@ description = "Dependency-light Python client for the U.S. Bureau of Labor Stati
readme = "README.md" readme = "README.md"
requires-python = ">=3.9" requires-python = ">=3.9"
license = { text = "MIT" } license = { text = "MIT" }
authors = [{ name = "Dave Boyd", email = "dave@tiggr.org" }] authors = [{ name = "Dave Boyd", email = "david.boyd1@dc.gov" }]
keywords = ["bls", "economics", "labor-statistics", "cpi", "jolts", "unemployment", "wages"] keywords = ["bls", "economics", "labor-statistics", "cpi", "jolts", "unemployment", "wages"]
dependencies = ["requests>=2.28"] dependencies = ["requests>=2.28"]