An open source library for the extraction of Federal Reserve Data.
Project description
FedTools
An open source Python library for the scraping of Federal Reserve data.
By default, all modules within FedTools use 10 threads to increase scraping speed. By default, the Output is a Pandas DataFrame, indexed by release date of the materials. Additional serialised storage methods are optional.
Installation
From Command Line:
$ python FedMinutes.py
Saves a Pickled Pandas DataFrame 'dataset.pkl', which contains all Meeting Minutes within search range, indexed by Date.
From Python:
pip install FedTools
from FedTools import MonetaryPolicyCommittee
Usage
From Command Line:
$ python FedMinutes.py
Saves a Pickled Pandas DataFrame 'dataset.pkl', which contains all Meeting Minutes within search range, indexed by Date.
From Python:
pip install FedTools
from FedTools import MonetaryPolicyCommittee
dataset = MonetaryPolicyCommittee().find_statements()
MonetaryPolicyCommittee().pickle_data("DIRECTORY")
Returns a Pandas DataFrame 'dataset', which contains all Meeting Minutes, indexed by Date and a '.pkl' file saved within "DIRECTORY".
To edit input default arguments:
monetary_policy = MonetaryPolicyCommittee(
main_url = 'https://www.federalreserve.gov',
calendar_url = 'https://www.federalreserve.gov/monetarypolicy/fomccalendars.htm',
historical_split = 2014,
verbose = True,
max_threads = 10)
dataset = monetary_policy.find_statements()
# serialise, save to "DIRECTORY":
monetary_policy.pickle_data("DIRECTORY")
All parameters above are optional, with a short explanation of each parameter outlined below:
Argument | Description |
---|---|
main_url | Federal Reserve Open Monetary Policy (FOMC) website URL. (str) |
calendar_url | URL containing a list of FOMC Meeting dates. (str) |
historical_split | year(s) considered as historical (check here). (int) |
verbose | boolean determining printing during scraping. (bool) |
thread_num | the number of threads to use for web scraping. (int) |
Project details
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
File details
Details for the file FedTools-0.0.1.tar.gz
.
File metadata
- Download URL: FedTools-0.0.1.tar.gz
- Upload date:
- Size: 4.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85ef3f705190f90c4e54b67f718186cd204d38f862adf05d7b8e0cdcd6ffc0e0 |
|
MD5 | 501adf62408ebea8f60c998c0ae03743 |
|
BLAKE2b-256 | 12caaa10f7afc4c2de5e547bdec6d97a0c5230e7a9b2f590562ad0b126fed44f |
File details
Details for the file FedTools-0.0.1-py3-none-any.whl
.
File metadata
- Download URL: FedTools-0.0.1-py3-none-any.whl
- Upload date:
- Size: 5.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | feb4672500a1898c91ba25fbd1e0d7356c1997e5cecd4ef2014b5eeef47dbcbe |
|
MD5 | b0f5d2da077e2276d7a65cab23927d22 |
|
BLAKE2b-256 | bbed538cb88d9eb08be4d7413a1f56243cfaeb261bb458c2a9587f3d137b61fd |