Skip to main content

Surveil API Client Library

Project description

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/v2
export SURVEIL_AUTH_URL=http://localhost:8080/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:8080/v2',
                  auth_url='http://localhost:8080/v2/auth',
                  version='2_0')
hosts = c.config.hosts.list()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-surveilclient-0.4.1.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

python_surveilclient-0.4.1-py2-none-any.whl (31.7 kB view details)

Uploaded Python 2

File details

Details for the file python-surveilclient-0.4.1.tar.gz.

File metadata

File hashes

Hashes for python-surveilclient-0.4.1.tar.gz
Algorithm Hash digest
SHA256 e9c57ff800230b2905972d7783c7a180fb51f502ae98bba29993f6ade61b782a
MD5 c26dc7586ae5db3f4963d47cdf4fd0f4
BLAKE2b-256 5d97dc52befef90b32ec42309d1bf7cf107293972ce5a4c6cf0c3cb32b5319d6

See more details on using hashes here.

Provenance

File details

Details for the file python_surveilclient-0.4.1-py2-none-any.whl.

File metadata

File hashes

Hashes for python_surveilclient-0.4.1-py2-none-any.whl
Algorithm Hash digest
SHA256 05dcafc42b66d045f0940f786f6d8e826d3d4674b15c4738b830da4353443b1a
MD5 b025b7747cdbea0935246d3a018261a5
BLAKE2b-256 0fd56ab780db1b7942127b8e0a8fb63de3d4c22cd3b8406e62742c30af88fd7b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page