x/python-surveilclient
Code Issues Proposed changes

Documented CLI in README

Browse Source 
Change-Id: I5c7142c6c3eb370c8896249fa15e37e0bf9b27a4
This commit is contained in:
aviau 2014-12-21 15:54:43 -05:00
parent b74a34956c
commit ec946e1df3
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.rst
View File

@ -3,6 +3,19 @@ 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``.
Python API
----------