Metadata-Version: 2.4
Name: fred-py-api
Version: 1.2.0
Summary: A fully featured FRED Command Line Interface & Python API client library.
Author-email: Zachary Spar <zachspar@gmail.com>
Project-URL: Homepage, https://github.com/zachspar/fred_py_api
Project-URL: Bug Tracker, https://github.com/zachspar/fred_py_api/issues
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.17.3
Requires-Dist: click>=7.0
Provides-Extra: ci
Requires-Dist: black==22.6.0; extra == "ci"
Requires-Dist: coverage==6.4.2; extra == "ci"
Provides-Extra: dev
Requires-Dist: black==22.6.0; extra == "dev"
Requires-Dist: coverage==6.4.2; extra == "dev"
Requires-Dist: tox==3.25.1; extra == "dev"
Requires-Dist: sphinx==7.2.6; extra == "dev"
Dynamic: license-file

[![PyPI version](https://badge.fury.io/py/fred-py-api.svg)](https://badge.fury.io/py/fred-py-api)
[![Documentation Status](https://readthedocs.org/projects/fred-py-api/badge/?version=latest)](https://fred-py-api.readthedocs.io/en/latest/?badge=latest)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/fred-py-api?style=flat)](https://pypi.org/project/fred-py-api/)
[![codecov](https://codecov.io/gh/zachspar/fred-py-api/branch/main/graph/badge.svg?token=BG1948D8Y7)](https://codecov.io/gh/zachspar/fred-py-api)

# Fred CLI & Python API
A fully-featured FRED Command-Line Interface & Python API Wrapper.

## Python API Documentation:
- [fred-py-api Docs](https://fred-py-api.readthedocs.io/en/latest/)

## Wiki:
- [fred-py-api Wiki](https://github.com/zachspar/fred-py-api/wiki)

## FRED References:
- [Create an API Key Here](https://fredaccount.stlouisfed.org/apikey)
- [API Documentation](https://fred.stlouisfed.org/docs/api/fred/)

## Shell Auto-Completion:
Fred CLI supports auto-completion for `zsh`, `bash` and `fish` shells. See instructions
for each directly below.

### `zsh` Completions
Add this to `~/.zshrc`
```zsh
eval "$(_FRED_COMPLETE=zsh_source fred)"
eval "$(_CATEGORIES_COMPLETE=zsh_source categories)"
eval "$(_RELEASES_COMPLETE=zsh_source releases)"
eval "$(_SERIES_COMPLETE=zsh_source series)"
eval "$(_SOURCES_COMPLETE=zsh_source sources)"
eval "$(_TAGS_COMPLETE=zsh_source tags)"
```

### `bash` Completions
Add this to `~/.bashrc`
```bash
eval "$(_FRED_COMPLETE=bash_source fred)"
eval "$(_CATEGORIES_COMPLETE=bash_source categories)"
eval "$(_RELEASES_COMPLETE=bash_source releases)"
eval "$(_SERIES_COMPLETE=bash_source series)"
eval "$(_SOURCES_COMPLETE=bash_source sources)"
eval "$(_TAGS_COMPLETE=bash_source tags)"
```

### `fish` Completions
Add this to `~/.config/fish/completions/fred.fish`
```fish
_FRED_COMPLETE=fish_source fred | source
_CATEGORIES_COMPLETE=fish_source categories | source
_RELEASES_COMPLETE=fish_source releases | source
_SERIES_COMPLETE=fish_source series | source
_SOURCES_COMPLETE=fish_source sources | source
_TAGS_COMPLETE=fish_source tags | source
```
