TUI REST client to analyze API endpoints
Freud is a TUI API endpoint analyzer utilizing Python Prompt Toolkit and Requests. It allows creating and saving request headers, authentication (basic and digest), and body using both integrated forms and your native editor.
Currently, it is designed and tested for receiving JSON, XML, and HTML responses, but more can be added later as needed.
First, create an environment (recommended):
python -m venv .venv . .venv/bin/activate
Then you can either install through PyPI...
pip install freud
or from sources
git clone https://github.com/stloma/freud python setup.py install
Key shortcuts depend on which window you are in. There are 4 windows: server list (left window), response headers (top right), response body (middle right), and server summary (bottom).
Server list/left window
- New server:
- Select server:
- Edit selected server:
- Edit authentication:
- Edit body:
- Send request for selected server:
- Delete selected server:
- Sort servers:
- Top/bottom of server list:
- New server:
Header window, Response body window, Server summary window
h/j/k/lVi keybindings for movement
o: Open response body in external editor
- Key Binding Quick Reference:
- Next window:
- Previous window:
Changing default configuration
- Settings file:
Freud is still in development, but should work well for most use cases.
Currently, it is designed to handle JSON, XML, and HTML responses; I haven't tested others. If you would like it to handle something specific, you can either submit a PR or create an issue and I'll add it!
- Add more authentication types (e.g., OAuth, Bearer Token, etc.)
- Handle more Content-Types (MIME types)
- Cookie handling
- Add capability to organize requests under categories
- Increase testing coverage
- Python: 3.5+
- Python Prompt Toolkit, Requests, Pygments
- set $EDITOR environment variable
export EDITOR=$(which vim)
python install -e '.[dev]' pytest
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash||File type||Python version||Upload date|
|freud-0.1.2-py3-none-any.whl (30.0 kB) View hashes||Wheel||py3|
|freud-0.1.2.tar.gz (21.0 kB) View hashes||Source||None|