💡The current version of this Python client is still a beta version.
This means that it is still under development, which may result in frequent and extensive API changes, unstable behavior, etc.

⚡️ Quickstart

As a quick example, we demonstrate how to set up and configure a StreamPipes client.

You can simply install the StreamPipes library by running the following command

pip install streampipes

# if you want to have the current development state you can also execute
pip install git+https://github.com/apache/streampipes.git#subdirectory=streampipes-client-python

>>> from streampipes.client import StreamPipesClient
>>> from streampipes.client.config import StreamPipesClientConfig
>>> from streampipes.client.credential_provider import StreamPipesApiKeyCredentials

>>> config = StreamPipesClientConfig(
...     credential_provider = StreamPipesApiKeyCredentials(
...         username = "test@streampipes.apache.org",
...         api_key = "DEMO-KEY",
...         ),
...     host_address = "localhost",
...     http_disabled = True,
...     port = 80
...)

>>> client = StreamPipesClient(client_config=config)
>>> client.describe()

Hi there!
You are connected to a StreamPipes instance running at http://localhost:80.
The following StreamPipes resources are available with this client:
6x DataStreams
1x DataLakeMeasures

For more information about how to use the StreamPipes client visit our introduction example.