Metadata-Version: 1.0
Name: python-surveilclient
Version: 0.11.0
Summary: Surveil API Client Library
Home-page: UNKNOWN
Author: UNKNOWN
Author-email: UNKNOWN
License: UNKNOWN
Description: Python bindings to the Surveil API
        ==================================
        
        This is a client library for Surveil built on the Surveil API.
        
        Command-line API
        ----------------
        
        Installing this package gets you a shell command, ``surveil``, that you
        can use to interact with the Surveil API.
        
        You'll need to provide the Surveil API URL. You can do this with the
        ``--surveil-api-url`` parameter, but it's easier to just set it as environment
        variable::
        
            export SURVEIL_API_URL=http://localhost:5311/v2
            export SURVEIL_AUTH_URL=http://localhost:5311/v2/auth
        
        You'll find complete documentation on the shell by running ``surveil help``.
        
        Bash completion
        ~~~~~~~~~~~~~~~
        
        Basic command tab completion can be enabled by sourcing the bash completion script::
        
            source /usr/local/share/surveil.bash_completion
        
        Python API
        ----------
        
        To use the python API, simply create a client with the endpoint::
        
              from surveilclient import client
              c = client.Client('http://localhost:5311/v2',
                                auth_url='http://localhost:5311/v2/auth',
                                version='2_0')
              hosts = c.config.hosts.list()
        
        
        How to use it
        -------------
        
        Config-host-update::
        
            surveil config-host-update --host_name [host_name] --address [ADDRESS] --custom_fields '{"_field1": "value1", "_field2": "value2"}'
        
        
Platform: UNKNOWN
