Skip to content

A fully-featured FRED Command Line Interface & Python API wrapper.

License

Notifications You must be signed in to change notification settings

zachspar/fred-py-api

Folders and files

NameName
Last commit message
Last commit date
Jun 29, 2024
Jun 29, 2024
Jun 29, 2024
Jan 5, 2024
Jun 29, 2024
Mar 25, 2024
Jun 22, 2022
Jun 29, 2024
Jun 29, 2024

Repository files navigation

PyPI version Documentation Status Supported Python Versions codecov

Fred CLI & Python API

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

Table of Contents

Installation:

Install fred in a couple of ways.

Homebrew

brew install fred

PyPI

pip install fred-py-api

Python API Documentation:

Wiki:

FRED References:

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

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

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

_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