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"}'
2 maintainers
Metadata
2 maintainers
Release files for python-surveilclient 0.13.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| python-surveilclient-0.13.3.tar.gz | 30.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| python_surveilclient-0.13.3-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 266.4 kB
Release files / python-surveilclient-0.13.3.tar.gz
| Download URL | python-surveilclient-0.13.3.tar.gz |
|---|---|
| Size | 30.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3e745eacb7679c83a43312545c1a090786263c500519a06ad43724f33fc69144
|
|
BLAKE2b-256 checksum How to use checksums |
ef5da66fb96bf73bb447c1f38fbe079c86d3e2cdfec7f0a020d3e83b7efc03fc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / python_surveilclient-0.13.3-py2-none-any.whl
| Download URL | python_surveilclient-0.13.3-py2-none-any.whl |
|---|---|
| Size | 235.8 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
c6923839daeda6f5e09497f2cff1e0ed1bf7981d8b8256556abfd8c78841e002
|
|
BLAKE2b-256 checksum How to use checksums |
5320355615a991ec4386e8ebfd62efea005c00a40777c8d2b19f850ac502f842
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for python-surveilclient 0.13.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
