Client library for surveil API.
Go to file
Grégory Starck a9d93864dd Fix: correctly handle help with any argument possibility
Change-Id: I13478ccfe805c3cb6c21b3d395122cebae176dcd
2015-02-02 19:04:25 -05:00
doc Added basic lib 2014-12-16 17:29:26 -05:00
surveilclient Fix: correctly handle help with any argument possibility 2015-02-02 19:04:25 -05:00
tools Added bash completion script 2014-12-22 10:34:45 -05:00
.gitignore Added CLI interface 2014-12-21 15:39:04 -05:00
.gitreview Added .gitreview 2014-06-25 20:10:08 +00:00
.testr.conf Added CLI interface 2014-12-21 15:39:04 -05:00
README.rst Added bash completion 2014-12-22 10:24:03 -05:00
requirements.txt HTTPClient improvements 2014-12-22 18:21:36 -05:00
setup.cfg Added bash completion 2014-12-22 10:24:03 -05:00
setup.py Added basic lib 2014-12-16 17:29:26 -05:00
test-requirements.txt HTTPClient improvements 2014-12-22 18:21:36 -05:00
tox.ini Added CLI interface 2014-12-21 15:39:04 -05:00

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:8080/v1

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/monasca.bash_completion

Python API

To use the python API, simply create a client with the endpoint:

from surveilclient.v1_0 import client
c = client.Client('http://localhost:8080/v1')
hosts = c.hosts.list()