Metadata-Version: 2.4
Name: parsimony-fred
Version: 0.7.0
Summary: FRED (Federal Reserve Economic Data) connector for the parsimony framework
Project-URL: Homepage, https://fred.stlouisfed.org
Project-URL: Repository, https://github.com/ockham-sh/parsimony-connectors
Project-URL: Issues, https://github.com/ockham-sh/parsimony-connectors/issues
Author-email: "Ockham.sh" <team@ockham.sh>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: connectors,data,finance,fred,parsimony
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: pandas<3,>=2.3.0
Requires-Dist: parsimony-core<0.8,>=0.7
Requires-Dist: pydantic<3,>=2.11.1
Provides-Extra: dev
Requires-Dist: mypy>=1.10; extra == 'dev'
Requires-Dist: pytest-asyncio>=1.3.0; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=9.0.3; extra == 'dev'
Requires-Dist: respx>=0.22.0; extra == 'dev'
Requires-Dist: ruff>=0.15.10; extra == 'dev'
Description-Content-Type: text/markdown

# parsimony-fred

**FRED (Federal Reserve Economic Data) connector for the [parsimony](https://github.com/ockham-sh/parsimony) framework.**

Part of the [parsimony-connectors](https://github.com/ockham-sh/parsimony-connectors) monorepo. Distributed standalone on PyPI as `parsimony-fred`.

## What it does

Once installed, this plugin is discovered automatically and exposes the following connectors:

| Connector | Kind | Tool-tagged | Description |
|---|---|---|---|
| `fred_search` | connector | yes | Keyword search across FRED series (id, title, units, frequency). |
| `fred_fetch` | connector | — | Fetch observation-level data for a FRED series by `series_id`. |

## Install

```bash
pip install parsimony-fred
```

Pulls in a compatible `parsimony-core` automatically.

## Configuration

```bash
export FRED_API_KEY="<your-key>"
```

Get a key at <https://fred.stlouisfed.org/docs/api/api_key.html>.

Verify discovery:

```bash
python -c "from parsimony import discover; print([p.name for p in discover.iter_providers()])"
```

## Quick start

```python
import asyncio
from parsimony_fred import CONNECTORS

async def main():
    connectors = CONNECTORS
    result = await connectors["fred_fetch"](series_id="UNRATE")
    print(result.data.head())

asyncio.run(main())
```

For multi-plugin composition:

```python
from parsimony import discover
connectors = discover.load_all()
```

## Catalog discovery

FRED ships a native search endpoint, so this plugin does **not** publish an
embedded catalog. Use `fred_search` for keyword discovery — it calls
`/series/search` directly against the FRED API.

## Development

```bash
uv sync --extra dev
uv run pytest
```

Release-blocking conformance test: `uv run pytest tests/test_conformance.py`.

## Provider

- Homepage: <https://fred.stlouisfed.org>
- API docs: <https://fred.stlouisfed.org/docs/api/fred/>

## License

Apache-2.0 — see [LICENSE](./LICENSE).
