Skip to main content

Command line REST request tool

Project description

rest-cli-client
===============
Overview
--------
A Python based command line REST client that makes saved REST requests and substitute values for variables that are defined in profiles or passed in as command line arguments.

Setup
-----
1. Copy the sample restcli.conf file (see bottow of README.md) to one of the following locations:
* The directory pointed to by the RESTCLI_CONF environment variable
* The current directory you will be running the command from
* Your users home directory

2. Edit the restcli.conf file to setup any requests/profiles you'd like to use

Examples
--------
1. Run `restcli.py` with no arguments to get a list of requests

$ restcli.py
usage: restcli.py [-h] {httpbinput,httpbinvars,httpbin} ...
restcli.py: error: too few arguments



$ restcli.py -h
usage: restcli.py [-h] {httpbinput,httpbinvars,httpbin} ...

optional arguments:
-h, --help show this help message and exit

Requests:
{httpbinput,httpbinvars,httpbin}
The request to execute

2. Run `restcli.py {profilename} -h` to get information on the saved request

$ restcli.py httpbinvars -h
usage: restcli.py httpbinvars [-h] [--profile {testprofile} | --no-profile]
[--proxy protocol:host:port]
[--verify | --no-verify]
headervar paramvar

Request name: httpbinvars
Method : get
Headers : myheader1: {{headervar}}, myheader2: myvalue2
URL : http://httpbin.org/get
Parameters: myparam1={{paramvar}}, myparam2=paramvalue2
Body :

optional arguments:
-h, --help show this help message and exit

Profiles:
Indicates which profile to use, if any, for variable substitution

--profile {testprofile}, -p {testprofile}
The name of the profile to use for variable
substitution
--no-profile No profile will be used for variable substitution

Options:
Options to use when making HTTP requests

--proxy host:port
Maps a protocol to a proxy. For example:
"http://proxy.url.com:8080". Multiple proxies can be
defined for different protocols.
--verify Verify SSL certificates.
--no-verify Do not verify SSL certificates.

Required variable arguments:
Variables that have no default value in the active profile (none)

headervar
paramvar

3. Actually make the `httpbinvars` request, notice that `{{headervar}}` and `{{paramvar}}` in the request are substituted with `value1` and `value2`.

$ restcli.py httpbinvars value1 value2
{
"url": "http://httpbin.org/get?myparam2=paramvalue2&myparam1=value2",
"headers": {
"Accept-Encoding": "gzip, deflate, compress",
"Myheader2": "myvalue2",
"X-Bluecoat-Via": "0159f16513239b9a",
"Myheader1": "value1",
"Host": "httpbin.org",
"Accept": "*/*",
"User-Agent": "python-requests/1.2.3 CPython/2.7.3 Windows/7",
"Connection": "close",
"Cache-Control": "max-stale=0"
},
"args": {
"myparam2": "paramvalue2",
"myparam1": "value2"
},
"origin": "152.219.153.75"
}


Sample restcli.conf
-------------------
{
"default_profile": "testprofile",
"options": {
"verify": false,
"proxies": {"http": "http://whatever.com:8080"}
},
"profiles": [
{
"name": "testprofile",
"headervar": "myheadervar",
"paramvar": "myparamvar"
}
],
"requests": [
{
"method": "get",
"name": "httpbinvars",
"url": "http://httpbin.org/get",
"headers": {
"myheader1": "{{headervar}}",
"myheader2": "myvalue2"
},
"params": {
"myparam1": "{{paramvar}}",
"myparam2": "paramvalue2"
}
},
{
"method": "get",
"name": "httpbin",
"body": "",
"url": "http://httpbin.org/get",
"headers": {
"myheader1": "myvalue1",
"myheader2": "myvalue2"
},
"params": {
"myparam1": "paramvalue1",
"myparam2": "paramvalue2"
}
},
{
"method": "put",
"name": "httpbinput",
"body": "{\"hello\" : \"world\"}",
"url": "http://httpbin.org/put",
"headers": {
"myheader1": "myvalue1",
"myheader2": "myvalue2"
},
"params": {
"myparam1": "paramvalue1",
"myparam2": "paramvalue2"
}
}
]
}

Project details


Release history Release notifications

This version
History Node

0.1.1

History Node

0.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
restcli-0.1.1.zip (11.5 kB) Copy SHA256 hash SHA256 Source None Jan 22, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page