Skip to main content

res is a tiny command line HTTP client

Project description

# res
A tiny command-line HTTP client. Easily interact with HTTP calls at a faster speed within your terminal. Built on top of the requests library and meant to be a command line wrapper for requests.

Current version: v0.1.7

```
res v0.1.7

HTTP it up with python. Use res to make command line http calls. I made this to make
the development of my REST API to be a little bit easier.

Usage:
res (-h | --help)
res (-v | --version)
res <method> <url> [options]

Options:
-d --data=<data> Send request data
-H --HEADER=<header> Defines custom headers
-a --auth=<auth> Authenticaton with 'user' and 'password' keys
-p --params=<params> Send request parameters
-b --bytes Returns content response in bytes
-r --raw Returns content response in raw format
-j --json Decodes content response from json
-c --cookie=<cookie> Defines cookies
-x --proxy=<proxy> Sends proxy with protocal as key and the port as value
-i --include Include headers
-h --help Show this screen.
-v --version Show version.
```

# Install
To download and install res, you must follow the instructions below.

### Install via PIP
```
$ pip install res
```

### Install via setup.py
First you need to get a copy of the source. I'm going to use git and clone it to my local machine.

Clone the repository into a folder
```
git clone https://github.com/jawerty/res.git res
```

Install with setup.py
```
$ cd res
$ python setup.py install
```

# Usage
Example GET, POST, PUT and DELETE calls
```
$ res GET http://example.com

$ res POST http://example.com

$ res PUT http://example.com

$ res DELETE http://example.com
```

Include headers
```
$ res GET http://example.com -i
```

Send request data to the body
```
$ res POST http://example.com -d "{
'Hello':'World',
'REST':'API'
}"
```

Authorization
```
$ res POST http://example.com -a "{
'user':'jawerty',
'password':'noneofyourbusiness'
}"
```

Parameters
```
$ res POST http://example.com -p "{ 'q':'names' }"
```

### Change data response content (new in v0.1.7)

Binary response -> bytes
```
$ res GET http://example.com -b
```
or
```
$ res GET http://example.com --bytes
```


Raw socket response -> raw
```
$ res GET http://example.com -r
```
or
```
$ res GET http://example.com --raw
```


JSON response decoder -> json
```
$ res GET http://example.com -j
```
or
```
$ res GET http://example.com --json
```

### Interactive Console
The interactive console current (v0.1.7) cannot pass any arguments that require dictionaries (i.e. --data, --proxy, --cookie, etc.). However, arguments like --bytes, --encoding, --raw, etc., are allowed.
```
$ res console
>>> get http://example.com -e `// -e is for encoding`
UTF-8
>>> get http://example.com
`response content....`
>>>
```

There are even more HTTP options that are compatible with res. Run the command at `$ res -h` to see all of the functions res wraps around.

# Contact
If you would like to contact me for further information on the project, see the info below.

Email: jawerty210@gmail.com

Github: jawerty

Twitter: @jawerty

Blog: <http://wrightdev.herokuapp.com>

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

res-0.1.7.tar.gz (3.8 kB view details)

Uploaded Source

File details

Details for the file res-0.1.7.tar.gz.

File metadata

  • Download URL: res-0.1.7.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for res-0.1.7.tar.gz
Algorithm Hash digest
SHA256 1f4b463214eb36bf080d1b2effd616a60b1943c07a6fea8ffd1017d70a643b55
MD5 6eaad1cd33f1f44a5920a26f0c4e0508
BLAKE2b-256 46601ea0f5cdcf4468236bec4356d937fb73210de80252de7ddfc1de4e0464be

See more details on using hashes here.

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