Skip to main content

Make http requests to json apis

Project description

Papir is an acronym for “Python API Requests”.

The main purpose is to make custom http requests to json APIs, prettify and colorize the full response (headers + json content).

Json files are used to post, put, patch or delete and to customize the http headers.

Basic http authentication and gzip compression are supported.

Simple example:

$ papir httpbin.org/get
https://raw.githubusercontent.com/pdrb/papir/master/papir.png

Notes

  • Works on Python 3.3+

  • Uses only Python standard library for maximum compatibility

  • Small and simple source code that can be read in a few minutes

Install

Install using pip:

pip install papir

or

Download and set executable permission on the script file:

chmod +x papir.py

or

Download and run using the python interpreter:

python3 papir.py

Usage

Usage: papir url [options] [method]

make http requests to json apis

Options:
--version        show program's version number and exit
-d DATA_FILE     json file to post, put, patch or delete
-h HEADERS_FILE  json file containing additional headers
-t TIMEOUT       timeout in seconds to wait for response (default: 10)
-a AUTH          basic http authentication in the format username:password
-f, --follow     follow redirects (default: disabled)
-v, --verbose    show request headers (default: disabled)

Examples

Assuming the file “data.json” exists containing:

{
    "name": "Bob",
    "age": 30
}

Make a post request using that data:

$ papir example.org -d data.json

To use a different http method just inform it:

$ papir example.org -d data.json put

To customize the request headers, create a json file like:

{
    "Auth-User": "user",
    "Auth-Token": "1234",
    "User-Agent": "myagent"
}

And add it to the request:

$ papir example.org -h headers.json

Obviously, you can mix it with all kinds of http methods:

$ papir example.org -h headers.json -d data.json patch

Simple basic auth:

$ papir example.org -a user:pass

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

papir-0.1.2.tar.gz (5.2 kB view details)

Uploaded Source

File details

Details for the file papir-0.1.2.tar.gz.

File metadata

  • Download URL: papir-0.1.2.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.9.1 pkginfo/1.4.1 requests/2.18.4 setuptools/33.1.1 requests-toolbelt/0.8.0 tqdm/4.19.5 CPython/2.7.14

File hashes

Hashes for papir-0.1.2.tar.gz
Algorithm Hash digest
SHA256 95c3857106eace66dc10006a7d1995f7a6879087efc1123f545051c2f7ef1e48
MD5 67461f8260f7bff4fad6d1f665793db4
BLAKE2b-256 b71c5afa48a84929625fe957f1d40755c3e85a122d60cb2fed53b4181cbe972a

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