# Capsule8 api-python
This repo is as a wrapper repo around the [Capsule8](https://github.com/capsule8/capsule8) sensor api.
## Install with pip
```
pip install capsule8
```
## Install with virtualenv
```
virtualenv test_capsule8
cd test_capsule8
source bin/activate
pip install capsule8
```
## Examples
In order to run the examples you need to have a running [capsule8](https://github.com/capsule8/capsule8) sensor on your machine. Once you have a running sensor you can run the examples. Be sure that the capsule8 sensor socket chowned by the current user.
```
sudo chown $USER /var/run/capsule8/sensor.sock
```
Then you can run the SensorClient and start streaming capsule8 sensor telemetry. In this example, every process events pid will be printed to stdout
```
from capsule8.sensor import SensorClient
from itertools import islice
s = SensorClient()
s.subscribe({"event_filter": {
"process_events": [
{"type": "PROCESS_EVENT_TYPE_FORK"},
{"type": "PROCESS_EVENT_TYPE_EXEC"},
{"type": "PROCESS_EVENT_TYPE_EXIT"}
]
}})
max_events = 5
for event in islice(s.telemetry(), max_events):
print(event.events[0].event.process_pid)
```
This repo is as a wrapper repo around the [Capsule8](https://github.com/capsule8/capsule8) sensor api.
## Install with pip
```
pip install capsule8
```
## Install with virtualenv
```
virtualenv test_capsule8
cd test_capsule8
source bin/activate
pip install capsule8
```
## Examples
In order to run the examples you need to have a running [capsule8](https://github.com/capsule8/capsule8) sensor on your machine. Once you have a running sensor you can run the examples. Be sure that the capsule8 sensor socket chowned by the current user.
```
sudo chown $USER /var/run/capsule8/sensor.sock
```
Then you can run the SensorClient and start streaming capsule8 sensor telemetry. In this example, every process events pid will be printed to stdout
```
from capsule8.sensor import SensorClient
from itertools import islice
s = SensorClient()
s.subscribe({"event_filter": {
"process_events": [
{"type": "PROCESS_EVENT_TYPE_FORK"},
{"type": "PROCESS_EVENT_TYPE_EXEC"},
{"type": "PROCESS_EVENT_TYPE_EXIT"}
]
}})
max_events = 5
for event in islice(s.telemetry(), max_events):
print(event.events[0].event.process_pid)
```
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
capsule8-1.7.tar.gz
(31.5 kB
view details)
File details
Details for the file capsule8-1.7.tar.gz.
File metadata
- Download URL: capsule8-1.7.tar.gz
- Upload date:
- Size: 31.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
825e63ec1deb97756edc1ec74ddd63d3c137c0d506bc7eac24cbf112fbfdd039
|
|
| MD5 |
6d2d4d8c7c02195b0a531abf6406f5f0
|
|
| BLAKE2b-256 |
fca859ab411e452147b4eb2377d371017ae81f8d5d360e464bc1b31cb36a98cd
|
