Metadata-Version: 1.0
Name: papir
Version: 0.3.0
Summary: Make http requests to json apis
Home-page: https://github.com/pdrb/papir
Author: Pedro Buteri Gonring
Author-email: pedro@bigode.net
License: MIT
Description: |Version| |Downloads| |Black| |License|
        
        papir
        =====
        
        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 is 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
        
        .. image:: https://raw.githubusercontent.com/pdrb/papir/master/papir.png
        
        
        Notes
        =====
        
        - Works on Python 3
        - Uses only Python standard library for maximum compatibility
        - Small and simple source code
        
        
        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
              -j JSON_DATA     json string to post, put, patch or delete
              -e JSON_HEADERS  json string 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)
              -i, --insecure   allow insecure SSL connections (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
        
        The json data can also be passed directly from cli::
        
            $ papir example.org -j '{"name": "Bob", "age": 30}'
        
        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
        
        Headers can also be customized directly from cli::
        
            $ papir example.org -e '{"custom-header": "foobar", "user-agent": "myagent"}'
        
        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
        
        To ignore invalid SSL certificates::
        
            $ papir https://self-signed.badssl.com/ -i
        
        
        .. |Version| image:: https://badge.fury.io/py/papir.svg
            :target: https://pypi.org/project/papir/
        
        .. |Downloads| image:: https://pepy.tech/badge/papir
             :target: https://pepy.tech/project/papir
        
        .. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
            :target: https://github.com/psf/black
        
        .. |License| image:: https://img.shields.io/pypi/l/papir.svg
            :target: https://github.com/pdrb/papir/blob/master/LICENSE
        
Keywords: http api json requests
Platform: UNKNOWN
