SensorBee REST API Client
Project description
sensorbee-python
This is a Python client library for SensorBee REST / WebSocket API. This library also provides utility commands (sbstat and sbpeek) which can be used to monitor SensorBee topology status.
Install
pip install sensorbee-python
To use WebSocket Client API, you also need to install websocket-client:
pip install websocket-client
Requirements
Python 2.6, 2.7, 3.3, 3.4 or 3.5.
Usage
Python API
In most cases the only class you need to use is pysensorbee.api.SensorBeeAPI. Here is an example:
from pysensorbee import SensorBeeAPI
api = SensorBeeAPI('127.0.0.1', 15601)
api.create_topology('test')
api.query('test', 'CREATE SOURCE ns TYPE node_statuses;')
for r in api.query('test', 'SELECT RSTREAM * FROM ns [RANGE 1 TUPLES];'):
print(r)
See pydoc pysensorbee.api for details.
Commands
sbstat provides a brief summary of the topology status.
$ sbstat -H 127.0.0.1 -P 15601 -t test Node Status Received Error Output Sent Queued Dropped -> node_stats running (total) 5381 0 sensorbee_tmp_8 5381 0 (0.0%) :: sensorbee_tmp_8 running 5381 0 (total) 5381 0 sensorbee_tmp_select_sink_7 5381 0 (0.0%) <- sensorbee_tmp_select_sink_7 running 5381 0
sbpeek can be used to peek what tuple is currently running through the specified source/stream.
$ sbpeek -H 127.0.0.1 -P 15601 -t test -1 node_stats {"behaviors": {"remove_on_stop": false, "stop_on_disconnect": false}, "node_type": "source", "output_stats": {"num_sent_total": 5893, "outputs": {"sensorbee_tmp_58": {"queue_size": 1024, "num_sent": 0, "num_queued": 0}, "sensorbee_tmp_8": {"queue_size": 1024, "num_sent": 5893, "num_queued": 0}}, "num_dropped": 0}, "state": "running", "node_name": "node_stats"}
See sbstat --help and sbpeek --help for details.
Notice
This library is not a part of the official SensorBee project.
In addition to APIs documented in the API Specification Version 1, this library supports some undocumented APIs, including WebSocket API.
Long queries may not be accepted by SensorBee via WebSocket Client API.
This project is a successor of beepy.
License
MIT License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file sensorbee-python-0.2.0.tar.gz
.
File metadata
- Download URL: sensorbee-python-0.2.0.tar.gz
- Upload date:
- Size: 8.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f23b40e7e5ea5c17beeb3dd64241265ee2faeb88954727783359d3ed660be47 |
|
MD5 | b155bbb9a7f26e8c0cc3359c66bb5b02 |
|
BLAKE2b-256 | 4588f579a2ce1e241ecee4347f1ae48cf1ee38f94982c53d1b3cc59fe25bc070 |