Skip to main content

Handy REST API client on your terminal

Project description

Handy REST API client on your terminal

PyPI version Build Status asciicast

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/rapidstack/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

Help menu

recli help

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/t
recli post testing/t --kwargs title=abcd userId=10
recli put testing/t/1 --kwargs title=abcd
recli patch testing/t1 --kwargs title=xyz
recli delete testing/t/1

Special formatting of data

List

recli list testing/t

Show

recli show testing/t/1

Save a request for later use

recli get testing/t/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

Check the great TODO list on project board

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

RESTEasyCLI-0.3.5.tar.gz (17.1 kB view hashes)

Uploaded Source

Built Distribution

RESTEasyCLI-0.3.5-py3-none-any.whl (23.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page