Handy REST API client on your terminal
Project description
Handy REST API client on your terminal
Installation
pip install --user resteasycli
# OR
pipenv install resteasycliUsage
Initialize workspace
mkdir myworkspace
cd myworkspace
recli init
# Few template files should be generated namely: auth.yml headers.yml saved.yml sites.ymlDo 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/1Special formatting of data
List
recli list testing/todosShow
recli show testing/todos/1Save 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 --kwargsMost 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_todosTODO list
[x] CRUD requests
[x] Formatted outputs
[x] Save requests feature
[x] Refactored sites, headers, authentication methods, saved requests
[ ] Add syntax verifier/fixer for workspace files
[ ] Add full usage documentation with examples
[ ] Add smart auto completions
[ ] Fix interactive mode
[ ] Code coverage > 90%
[ ] Test cases with different environment variables
[ ] API server for full end to end test with custom headers, authentication
[ ] Add more authentication methods
[ ] Add proxy support
[ ] Token detection for automatic authentication headers update
[ ] Generate and publish API documentation feature
[ ] Initialize workspace from generated API documentation
[ ] Release version 1
[ ] Design a icon for it and it’s dependency RESTEasy
[ ] Write a blog post, create a youtube video on it
[ ] Postman compatibility
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
While updating README file, use plugin for auto TOC update. Both README.md and README.rst should be in sync. One easy way is to update README.md and generate README.rst from it using m2r (included as dev dependency)
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
File details
Details for the file RESTEasyCLI-0.3.1.tar.gz.
File metadata
- Download URL: RESTEasyCLI-0.3.1.tar.gz
- Upload date:
- Size: 15.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 19d7f81befed3fd4376a8c91725cec6778dec0fe231d166d786d6687bc1efd4b |
|
| MD5 | 7ae1701d5ea7a786751b55a7ffa5bac9 |
|
| BLAKE2b-256 | 3f475dd3ed117a8065010163d8dd252cd42e7635869757fa16d13cdf52dffbb3 |
Provenance
File details
Details for the file RESTEasyCLI-0.3.1-py3-none-any.whl.
File metadata
- Download URL: RESTEasyCLI-0.3.1-py3-none-any.whl
- Upload date:
- Size: 19.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 950ded5de7cf1facca5ecd02acdb71e61fc1bc06ada3c51ac6fb82a6205e2107 |
|
| MD5 | f921088784914c4d6eea473ad3dfb01d |
|
| BLAKE2b-256 | f885a22542c3c4f51708dde13f56635d91be35629989be1ae2718e9d35edb784 |
