| Name | restcall JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | None |
| Summary | A small JSON-based command-line utility to make REST calls |
| upload_time | 2025-08-10 17:02:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License
Copyright (c) 2021 Subhadip Ghosh
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
rest
client
cli
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
bleach
build
certifi
cffi
charset-normalizer
commonmark
cryptography
docutils
greenlet
httpretty
idna
importlib-metadata
jaraco.classes
jeepney
keyring
more-itertools
msgpack
packaging
pep517
pkginfo
pycparser
Pygments
pynvim
pyperclip
readme-renderer
requests
requests-toolbelt
rfc3986
rich
SecretStorage
six
tomli
twine
uncurl
urllib3
webencodings
zipp
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# restcall
A small JSON-based command-line utility to make REST calls.
## Installation
`restcall` is distributed as a Python package and can be installed using `pip`.
```
python -m pip install restcall
```
## Usage
### Generate a template
```
restcall -t get-service-name.json
restcall -t post-service-name.json
```
### Import template from curl command
```
restcall -u curl-command.txt get-service-name.json
```
The `curl-command.txt` file contains the curl command.
### Modify the generated template
The generated template looks like this:
```json
{
"url": "",
"httpMethod": "POST",
"reqAuthType": "none",
"reqAuthToken": "",
"reqContentType": "",
"reqHeaders": {},
"reqPayload": "",
"resFile": ""
}
```
Edit the template and populate the required values.
Here are the parameters, their meaning and the allowed values:
- url - the REST URL
- httpMethod - GET, POST, PUT, PATCH, DELETE
- reqAuthType - `none`, `bearer`, `bearer_generate`, `basic`
- reqAuthToken
- the actual token if the reqAuthType is `bearer`
- filepath to the restcall template to generate the token if the reqAuthType is `bearer_generate`
- `username:password` if the reqAuthType is `basic`
- reqContentType - the request content type. eg. `application/json`
- reqHeaders - the request headers
- reqPayload - the request body. If binary, provide the file path.
- resFile - the file path for storing response externally
### Make the REST call
```
restcall get-service-name.json
```
It will generate the response file `get-service-name-res.json`.
### Output equivalent curl command:
```
restcall -c get-service-name.json
```
## SSL
By default SSL certificate verification is disabled.
## License
This repository and the files under it are licensed under the MIT license.
Raw data
{
"_id": null,
"home_page": null,
"name": "restcall",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "rest, client, cli",
"author": null,
"author_email": "Subhadip Ghosh <subhadip.sky@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3b/63/26cf38c903f4ad3392ce02a1f0d02c40a77f831a5f552826ca08956305cf/restcall-1.3.0.tar.gz",
"platform": null,
"description": "# restcall\nA small JSON-based command-line utility to make REST calls.\n\n## Installation\n`restcall` is distributed as a Python package and can be installed using `pip`.\n```\npython -m pip install restcall\n```\n\n## Usage\n\n### Generate a template\n```\nrestcall -t get-service-name.json\n\nrestcall -t post-service-name.json\n```\n\n### Import template from curl command\n```\nrestcall -u curl-command.txt get-service-name.json\n```\nThe `curl-command.txt` file contains the curl command.\n\n### Modify the generated template\n\nThe generated template looks like this:\n\n```json\n{\n \"url\": \"\",\n \"httpMethod\": \"POST\",\n \"reqAuthType\": \"none\",\n \"reqAuthToken\": \"\",\n \"reqContentType\": \"\",\n \"reqHeaders\": {},\n \"reqPayload\": \"\",\n \"resFile\": \"\"\n}\n```\nEdit the template and populate the required values.\nHere are the parameters, their meaning and the allowed values:\n- url - the REST URL\n- httpMethod - GET, POST, PUT, PATCH, DELETE\n- reqAuthType - `none`, `bearer`, `bearer_generate`, `basic`\n- reqAuthToken\n - the actual token if the reqAuthType is `bearer`\n - filepath to the restcall template to generate the token if the reqAuthType is `bearer_generate`\n - `username:password` if the reqAuthType is `basic`\n- reqContentType - the request content type. eg. `application/json`\n- reqHeaders - the request headers\n- reqPayload - the request body. If binary, provide the file path.\n- resFile - the file path for storing response externally\n\n### Make the REST call\n```\nrestcall get-service-name.json\n```\n\nIt will generate the response file `get-service-name-res.json`.\n\n### Output equivalent curl command:\n```\nrestcall -c get-service-name.json\n```\n\n## SSL\nBy default SSL certificate verification is disabled.\n\n## License\nThis repository and the files under it are licensed under the MIT license.\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2021 Subhadip Ghosh\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "A small JSON-based command-line utility to make REST calls",
"version": "1.3.0",
"project_urls": {
"Changelog": "https://github.com/subhadig/restcall/blob/master/CHANGELOG.md",
"Homepage": "https://github.com/subhadig/restcall"
},
"split_keywords": [
"rest",
" client",
" cli"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4239088241484009f7ba3762f652821da70af4624a6d235c976d0207ebdfa75a",
"md5": "110331c677c61c826d906487505d0c34",
"sha256": "507f2dae7c2e5ae2ffba12c8a641d3fd14c19c818cda190363491127370d715d"
},
"downloads": -1,
"filename": "restcall-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "110331c677c61c826d906487505d0c34",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 10335,
"upload_time": "2025-08-10T17:02:37",
"upload_time_iso_8601": "2025-08-10T17:02:37.841865Z",
"url": "https://files.pythonhosted.org/packages/42/39/088241484009f7ba3762f652821da70af4624a6d235c976d0207ebdfa75a/restcall-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3b6326cf38c903f4ad3392ce02a1f0d02c40a77f831a5f552826ca08956305cf",
"md5": "584b59c74ff9b8a522eb4db031af7d39",
"sha256": "2690261c21cd9c1a17666b3c7409b96d5a7a64629a40aadc3e741ea135a87a52"
},
"downloads": -1,
"filename": "restcall-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "584b59c74ff9b8a522eb4db031af7d39",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 9150,
"upload_time": "2025-08-10T17:02:39",
"upload_time_iso_8601": "2025-08-10T17:02:39.481668Z",
"url": "https://files.pythonhosted.org/packages/3b/63/26cf38c903f4ad3392ce02a1f0d02c40a77f831a5f552826ca08956305cf/restcall-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-10 17:02:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "subhadig",
"github_project": "restcall",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "bleach",
"specs": [
[
"==",
"5.0.1"
]
]
},
{
"name": "build",
"specs": [
[
"==",
"0.9.0"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2021.10.8"
]
]
},
{
"name": "cffi",
"specs": [
[
"==",
"1.15.1"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"2.0.12"
]
]
},
{
"name": "commonmark",
"specs": [
[
"==",
"0.9.1"
]
]
},
{
"name": "cryptography",
"specs": [
[
"==",
"38.0.4"
]
]
},
{
"name": "docutils",
"specs": [
[
"==",
"0.19"
]
]
},
{
"name": "greenlet",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "httpretty",
"specs": [
[
"==",
"1.1.4"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.3"
]
]
},
{
"name": "importlib-metadata",
"specs": [
[
"==",
"5.2.0"
]
]
},
{
"name": "jaraco.classes",
"specs": [
[
"==",
"3.2.3"
]
]
},
{
"name": "jeepney",
"specs": [
[
"==",
"0.8.0"
]
]
},
{
"name": "keyring",
"specs": [
[
"==",
"23.13.1"
]
]
},
{
"name": "more-itertools",
"specs": [
[
"==",
"9.0.0"
]
]
},
{
"name": "msgpack",
"specs": [
[
"==",
"1.0.3"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"22.0"
]
]
},
{
"name": "pep517",
"specs": [
[
"==",
"0.13.0"
]
]
},
{
"name": "pkginfo",
"specs": [
[
"==",
"1.9.2"
]
]
},
{
"name": "pycparser",
"specs": [
[
"==",
"2.21"
]
]
},
{
"name": "Pygments",
"specs": [
[
"==",
"2.13.0"
]
]
},
{
"name": "pynvim",
"specs": [
[
"==",
"0.4.3"
]
]
},
{
"name": "pyperclip",
"specs": [
[
"==",
"1.8.2"
]
]
},
{
"name": "readme-renderer",
"specs": [
[
"==",
"37.3"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.27.1"
]
]
},
{
"name": "requests-toolbelt",
"specs": [
[
"==",
"0.10.1"
]
]
},
{
"name": "rfc3986",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"12.6.0"
]
]
},
{
"name": "SecretStorage",
"specs": [
[
"==",
"3.3.3"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.16.0"
]
]
},
{
"name": "tomli",
"specs": [
[
"==",
"2.0.1"
]
]
},
{
"name": "twine",
"specs": [
[
"==",
"4.0.2"
]
]
},
{
"name": "uncurl",
"specs": [
[
"==",
"0.0.11"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"1.26.8"
]
]
},
{
"name": "webencodings",
"specs": [
[
"==",
"0.5.1"
]
]
},
{
"name": "zipp",
"specs": [
[
"==",
"3.11.0"
]
]
}
],
"lcname": "restcall"
}
