|
1 | 1 | Sysdig Monitor/Secure Python client library |
2 | 2 | === |
3 | 3 |
|
4 | | -[](https://travis-ci.org/draios/python-sdc-client) |
| 4 | + |
5 | 5 | [](https://pypi.python.org/pypi/sdcclient) |
6 | 6 |
|
7 | 7 | A Python client API for Sysdig Monitor/Sysdig Secure. |
8 | 8 |
|
9 | | -This module is a wrapper around the Sysdig Monitor/Sysdig Secure APIs, which are documented [here](http://support.sysdigcloud.com/hc/en-us/articles/205233166-The-Sysdig-Cloud-API-Specification). It exposes most of the sysdig REST API functionality as an easy to use and easy to install Python interface. The repository includes a rich set of examples (in the [examples](examples/) subdir) that quickly address several use cases. |
| 9 | +This module is a wrapper around the Sysdig Monitor/Sysdig Secure APIs. It exposes most of the sysdig REST API functionality as an easy to use and easy to install Python interface. The repository includes a rich set of examples (in the [examples](examples/) subdir) that quickly address several use cases. |
10 | 10 |
|
11 | 11 | Installation |
12 | 12 | ------------ |
13 | | -#### Automatic w/ PyPI ([virtualenv](http://virtualenv.readthedocs.org/en/latest/) is recommended.) |
| 13 | +#### Automatic with PyPI |
14 | 14 | pip install sdcclient |
15 | 15 |
|
16 | | -#### Manual |
17 | | - git clone https://github.com/draios/python-sdc-client.git |
18 | | - cd python-sdc-client |
19 | | - python setup.py install |
| 16 | +#### Manual (development only) |
20 | 17 |
|
21 | | -#### One-step cmdline to create virtualenv, install client, and gain access to sample programs |
| 18 | +This method requires [Poetry](https://python-poetry.org/) installed |
22 | 19 |
|
23 | | -``` |
24 | | -$ virtualenv python-sdc-env && source python-sdc-env/bin/activate && pip install sdcclient && git clone https://github.com/draios/python-sdc-client && python python-sdc-client/examples/set_secure_system_falco_rules.py --help |
25 | | -``` |
| 20 | + git clone https://github.com/sysdiglabs/sysdig-sdk-python.git |
| 21 | + cd python-sdc-client |
| 22 | + poetry install |
26 | 23 |
|
27 | 24 | Quick start |
28 | 25 | ----------- |
@@ -61,7 +58,9 @@ For an example on how to parse this output, take a look at a simple example like |
61 | 58 |
|
62 | 59 | Function List & Documentation |
63 | 60 | ----------------------------- |
64 | | -For the list of available functions in the current `master` branch of this repo and corresponding docs, refer to the [Python Script Library documentation page](http://python-sdc-client.readthedocs.io/en/latest/). Equivalent docs for the functions in the most recent "stable" release (which is what you'd get via `pip` install, and corresponds to the most recent [release](https://github.com/draios/python-sdc-client/releases)) are located [here](http://python-sdc-client.readthedocs.io/en/stable/). |
| 61 | +**Work in progress** |
| 62 | + |
| 63 | +Fully documented methods is in our roadmap and will be available soon. |
65 | 64 |
|
66 | 65 | On-Premises Installs |
67 | 66 | -------------------- |
|
0 commit comments