streampipes 0.95.0

Python library for Apache StreamPipes

StreamPipes is a self-service (Industrial) IoT toolbox to enable non-technical users to connect , analyze and explore IoT data streams.

Apache StreamPipes for Python

Apache StreamPipes meets Python! We are working highly motivated on a Python library to interact with StreamPipes. In this way, we would like to unite the power of StreamPipes to easily connect to and read different data sources, especially in the IoT domain, and the amazing universe of data analytics libraries in Python.

---

💡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.

📚 Documentation

Please visit our documentation. There you can find information about how to get started, follow some tutorials, or discover the library via our references.

In case you want to access the documentation of the current development state, you can go here:

👉 development docs 🤓

⚡️ 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 = "[e-mail]",
        api_key = "DEMO-KEY",
    ),
    host_address = "localhost",
    https_disabled = True,
    port = 80
)

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

Output:

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 tutorial.