lazy-fred 0.1.66

'A simplified aggegate of FRED data using fredapi package'

lazy_fred: Effortless FRED Data Collection

lazy_fred is a Python library designed to simplify collecting economic data from the Federal Reserve Economic Data (FRED) API. It searches across categories, filters series by popularity/frequency, and exports results to CSV files.

Features

• Automated search across FRED categories
• Filtered selection by frequency (daily/weekly/monthly) and popularity
• Retry and logging for robust data collection
• CSV exports for the filtered series + daily/weekly/monthly observations

Installation

From PyPI (recommended)

python -m pip install --upgrade lazy_fred

From source (Poetry)

poetry install

Configure your FRED API key

lazy_fred expects a FRED API_KEY. You can provide it either by:

1. Creating a local .env file in your working directory:

   API_KEY=your_fred_api_key_here
   

2. Or exporting it as an environment variable:

   set API_KEY=your_fred_api_key_here
   

If API_KEY is missing, the CLI will prompt you for it and write it to .env.

Quick start (CLI)

After installation, run:

lazy-fred

The CLI is interactive and will prompt you to:

• add/remove/clear categories
• run the data collection

Note: because it uses input(), it is intended for interactive terminals.

Output files

When you choose run, the project will generate these CSV files in your current directory:

• filtered_series.csv
• daily_data.csv
• weekly_data.csv
• monthly_data.csv

Programmatic usage

import lazy_fred as lf

lf.run_fred_data_collection("insert_api_key_here")

This will also start the interactive menu (it blocks on input()).

Development

• Lint: poetry run ruff check .
• Tests (requires a real key): API_KEY=<your_key> poetry run pytest

Release process

1) Bump version

Update version in pyproject.toml (for example, 0.1.66 -> 0.1.67), then commit and push.

2) Publish via GitHub Trusted Publishing (recommended)

This repository includes .github/workflows/publish-pypi.yml.

It publishes to PyPI automatically when you:

• publish a GitHub Release, or
• push a version tag matching v* (example: v0.1.67)

Example:

git tag v0.1.67
git push origin v0.1.67

Requirements:

• PyPI project lazy_fred must have this GitHub repository configured as a Trusted Publisher.

3) Poetry fallback publish (manual)

If you need a manual fallback path, run the same GitHub workflow from the Actions tab with:

• publish_method = poetry

This method uses:

• poetry publish --build --skip-existing
• repository secret PYPI_API_TOKEN

4) Verify release

After publish, confirm the new version appears at:

• https://pypi.org/project/lazy_fred/

Disclaimer

This library is not affiliated with or endorsed by the Federal Reserve Bank of St. Louis or the FRED project.

Acknowledgments

This project utilizes the fredapi and fred libraries for interacting with the FRED API.

Contributions

Contributions are welcome. Feel free to open issues or submit pull requests.

License

MIT