Metadata-Version: 2.1
Name: pyhiapi
Version: 0.2.0
Summary: PyHiAPI - Simple test API
Home-page: https://github.com/ryanjjung/pyhiapi
Author: Ryan Jung
Author-email: ryanjjung@gmail.com
License: LICENCE
Description: # pyhiapi
        
        The API that just says hi!
        
        A very simple API endpoint, easily deployable for testing purposes.
        
        ## Installation
        
            sudo pip install pyhiapi
        
        ## Usage
        
            usage: hi.py [-h] [-b BIND] [-f RESPONSE_FILE] [-p PORT] [-r CODE]
            
            optional arguments:
              -h, --help            show this help message and exit
              -b BIND, --bind-address BIND
                                    Address to bind the server to
              -f RESPONSE_FILE, --response-file RESPONSE_FILE
                                    A file containing a custom response message
              -p PORT, --port PORT  The port to listen on
              -r CODE, --response_code CODE
                                    The response code to send back to requests
        
        hiapi defaults to `localhost:4000` and a `200 OK` response.
        
        You can override all command line arguments using the following environment variables:
        
        * `HIAPI_BIND_ADDR`
        * `HIAPI_RESPONSE_FILE`
        * `HIAPI_PORT`
        * `HIAPI_RESPONSE_CODE`
        
        When these variables are present, the corresponding command line arguments will be **completely ignored*.
        
        ## Testing
        
        You can just curl the service, perhaps like this:
        
            $ curl -i http://localhost:4000/
        
            HTTP/1.0 200 OK
            Content-Type: text/html; charset=utf-8
            Content-Length: 4
            Server: Werkzeug/0.9.6 Python/2.7.8
            Date: Fri, 23 Jan 2015 03:38:14 GMT
        
            Hi!
        
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
