Metadata-Version: 2.1
Name: resht
Version: 0.9.0
Summary: RESTFul HTTP command-line interface and shell
Home-page: https://github.com/jfillmore/resht
Author: Jonny Fillmore
Author-email: git@jkf.im
License: UNKNOWN
Description: ```
        usage: rest-cli http-verb|command API [API_PARAMS] [ARGUMENTS]
        
        ARGUMENTS
        ---------------------------------------------------------------------------
        
        HTTP OPTIONS (each may be specified multiple times)
           -f, --form               Override default of sending JSON data
           -H, --header HEADER      HTTP header (e.g. 'Foo: bar') .
           -Q, --query QUERY_DATA   Query data to include (e.g. foo=bar&food=yummy).
           -d, --data NAME[+]=PATH  Store response data; '+' also adds variable to the env
        
        
        OTHER OPTIONS (may also be set via 'set' command)
           -B, --basic USER:PASS    HTTP basic authentication.
           -C, --no-color           Do not color formatted JSON responses.
           -h, --help               This information.
           -I, --invert             Invert colors in formatted JSON responses.
           -j, --json STRING        Append JSON-encoded list to API parameters.
           -O, --oauth CK CS T TS   Authenticate via OAuth using the supplied consumer key, secret, token, and token secret.
           -q, --quiet              Do not print API return response.
           -r, --raw                Don't format response data; return raw response.
           -s, --shell              Shell mode for running multiple APIs within a session.
           -u, --url URL            URL to the API location (default: https://localhost/).
           -v, --verbose            Print verbose debugging info to stderr.
           -x, --extract PATH       Parse JSON/(X)HTML to only return requested data; may be repeated.
           -X, --exclude PATH       Exclude specified path from JSON data; may be repeated.
        
        API PARAMS
        ---------------------------------------------------------------------------
        Dictionaries can be created on demand using dot notation. Multiple params within the same dictionary will merge together. Values are always encoded as strings unless ":=" is used to assign the value.
        
           foo                      {"foo": true}
           !foo                     {"foo": false}
           foo=bar                  {"foo": "bar"}
           foo.bar=3 foo.bard=abc   {"foo": {"bar": "3", "bard": "abc"}}
           foo:='{"bar":3}'         {"foo": {"bar": 3}}
           foo.bar:=3.14            {"foo": {"bar": 3.14}}
        
        Variables in memory (e.g. shown by 'data' command) may be referenced using "+=" as the operator.
        
        
        HTML/XML PATHS (--extract, --data)
        ---------------------------------------------------------------------------
        Values are extracted using 'pgquery', a Python port of jQuery. This can be used to extract and store values from input forms.
        
        
        JSON PATHS  (--extract, --exclude, --data)
        ---------------------------------------------------------------------------
        The JSON data can be filtered based on index, key matches, ranges, etc.
        
            Arrays:
                By Index:
                 - 'foo/0', 'foo/2', 'foo/-1' (last item)
                By Range:
                 - 'foo/:' or 'foo/*' (all items within the array),
                 - 'foo/2:', 'foo/:2', 'foo/1:5', 'foo/-2:' (last 2),
                 - 'foo/:-2' (all but last two),
                 - 'foo/1:-3' (between first and up until 3rd to last)
            Dictionaries:
                Regular Expressions:
                 - 'foo/b..?r' = foo/bar, foo/beer
                 - 'foo/bar/.*[pP]assw(or)?d' == anything within foo/bar that looks like a password
        
        SHELL COMMANDS
        ---------------------------------------------------------------------------
           cd                       Change the base URL (e.g. "cd customers/8; cd ../9").
           help                     This information.
           quit                     Adios! (quit shell).
           set                      Set configuration options.
           config                   List current configuration infomation.
           sh CMD                   Run a BASH shell command.
           data [NAME] [-=NAME]     List variables in memory, optionally by name; -= to remove from memory
           env [NAME] [[+-]=NAME]   List environmental variables, optionally by name; += or -= to add/remove 'data' from the environment
           > FILE                   Write API response to specified file.
           >> FILE                  Append API response to specified file.
        
        EXAMPLES:
        ---------------------------------------------------------------------------
            rest-cli -u https://foo.com/api -s
            > get site/foo.com -v
            > post site -j domain=foo.com
            > cd site/foo.com
            > get ./
        ```
        
        # Known Bugs
        
        - using '-s' with an API specified doesn't retain initial headers/CWD
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
