Handy REST API client on your terminal
Project description
Handy REST API client on your terminal
Get started with an interactive demo
NOTE: This demo requires supported version of python and virtualenv to be installed
curl -L https://raw.githubusercontent.com/sayanarijit/RESTEasyCLI/master/tools/demo.sh -o demo.sh
chmod +x demo.sh
./demo.sh
Installation
# Install it globally
sudo pip install -U resteasycli
# OR
# Install it locally
pip install -U --user resteasycli
Usage
Initialize workspace
mkdir myworkspace
cd myworkspace
recli init
# Few template files should be generated namely: auth.yml headers.yml saved.yml sites.yml
Do CRUD requests
recli get testing/todos
recli post testing/todos --kwargs title=abcd userId=10
recli put testing/todos/1 --kwargs title=abcd
recli patch testing/todo1 --kwargs title=xyz
recli delete testing/todos/1
Special formatting of data
List
recli list testing/todos
Show
recli show testing/todos/1
Save a request for later use
recli get testing/todos/1 -s my_request
# Request will be saved in saved.yml as "my_request"
Do or redo a saved request
# Without formatting
recli do remind_shopping
# Same as
recli redo remind_shopping
# With formatting
recli dolst remind_shopping -m GET -k
# Same as
recli redo-list remind_shopping --method GET --kwargs
Most importantly fake a request
recli redo-show remind_shopping -m GET -k --fake
# It can be used with -s to save the request for later use without doing it
recli redo-show remind_shopping -m GET -k --fake -s get_todos
TODO list
Contribution guide
This is a new born project and has lots of scope for improvements.
If you feel that you can help with any of above TODO list or if you have a totally unique idea, feel free to jump right in.
Here are some tips to start contributing to this project right away.
Instead of directly creating pull requests, create a issue first to check it’s relevence and save efforts. However,
If you find a bug, feel free to directly create pull requests by forking master branch
Awesome if commit messages and pull request description are clear and concise
One of it’s depedency RESTEasy has a gitter channel for any doubt or discussion related to this project or RESTEasy
Use pipenv to install/update dependencies
Do not modify README.rst file. It’s auto generated using m2r (Installed as a dev dependency). While updating README.md file, use plugin for auto TOC update.
Run ./tools/before_push.sh before pushing. It will take care of house keeping stuffs like generating README.rst, checking if VERSOIN info is updated correctly in all files etc.
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 RESTEasyCLI-0.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46bc3203fdb32377421168da7cefc4fa59e08d2a32961fe103601f93a2f39fd5 |
|
MD5 | 59b8e6140ab23e9384ee8d09b5757e6c |
|
BLAKE2b-256 | c3812c697bb65eecfd23164f90af11db91b73ac88b4e374d010b9ebce2ec789f |