'A simplified aggegate of FRED data using fredapi package'
Project description
lazy_fred
lazy_fred: Effortless FRED Data Collection
lazy_fred is a Python library designed to simplify the process of collecting economic data from the Federal Reserve Economic Data (FRED) API. It automates searching for relevant series, filtering by frequency and popularity, and exporting the data into convenient CSV files.
Features
- Automated Search: Searches FRED across various economic categories.
- Filtered Selection: Selects series based on popularity and frequency (daily, weekly, monthly).
- Error Handling: Includes retry mechanisms and logging for robust data collection.
- CSV Export: Saves the collected data in separate CSV files for easy analysis.
Installation
-
Clone the Repository:
git clone https://github.com/your-username/lazy_fred.git
-
Install Dependencies:
pip install -r requirements.txt
-
Obtain a FRED API Key:
-
Visit the FRED website and get your free API key.
-
Create a
.env
file in the project root directory and add your API key:API_KEY=your_api_key_here
-
Usage
-
Configure Search Categories:
- Modify the
search_categories
list in the script to include the categories of interest.
- Modify the
-
Run the Script:
python lazy_fred.py
-
Output:
- The script will create three CSV files in your project directory:
lazy_fred_Search.csv
: Contains the search results from FRED.daily_data.csv
: Contains daily time series data.monthly_data.csv
: Contains monthly time series data.weekly_data.csv
: Contains weekly time series data.
- The script will create three CSV files in your project directory:
Code Structure
-
AccessFred
Class:- Handles API key retrieval and validation.
-
collect_categories
Class:- Executes searches across categories and consolidates results.
-
daily_export
,monthly_export
, andweekly_export
Classes:- Filter series by frequency and popularity.
- Collect and export time series data.
Contributions
Contributions are welcome! Feel free to open issues or submit pull requests.
License
This project is licensed under the MIT License.
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
library for interacting with the FRED API.
Contact
For any questions or feedback, please open an issue in the repository.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for lazy_fred-0.1.63-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 135f48dbcfdec2347d6135f537b5775d6796867e180b865912e1a01dcf7ca437 |
|
MD5 | d08fb31af520585d3bcb22dbce243744 |
|
BLAKE2b-256 | eeb8fbe4f602c30808b902e556add0284232d4436fc30e24161d36412b36c456 |