You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by bo...@apache.org on 2023/02/09 15:14:43 UTC
[streampipes] branch dev updated: chore(naming): fix some references to `streampipes_client` (#1244)
This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/streampipes.git
The following commit(s) were added to refs/heads/dev by this push:
new eace8d6b8 chore(naming): fix some references to `streampipes_client` (#1244)
eace8d6b8 is described below
commit eace8d6b8ce65b0ecc947ec4530d4aee03adbe15
Author: Tim <50...@users.noreply.github.com>
AuthorDate: Thu Feb 9 16:14:34 2023 +0100
chore(naming): fix some references to `streampipes_client` (#1244)
* chore(naming): fix some references to `streampipes_client`
* fix formatting
Signed-off-by: bossenti <bo...@posteo.de>
* update Python installation options
Signed-off-by: bossenti <bo...@posteo.de>
* revert version
Signed-off-by: bossenti <bo...@posteo.de>
---------
Signed-off-by: bossenti <bo...@posteo.de>
---
streampipes-client-python/README.md | 8 ++++++++
...introduction-to-streampipes-python-client.ipynb | 2 ++
...cting-data-from-the-streampipes-data-lake.ipynb | 6 +++---
...ive-data-from-the-streampipes-data-stream.ipynb | 10 +++++-----
...ine-learning-on-a-streampipes-data-stream.ipynb | 22 +++++++++++-----------
.../docs/getting-started/installation.md | 4 +++-
6 files changed, 32 insertions(+), 20 deletions(-)
diff --git a/streampipes-client-python/README.md b/streampipes-client-python/README.md
index 64663f893..eef32abd8 100644
--- a/streampipes-client-python/README.md
+++ b/streampipes-client-python/README.md
@@ -45,6 +45,14 @@ and the amazing universe of data analytics libraries in Python. </p>
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
+```bash
+%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
+```
+
```python
>> > from streampipes.client import StreamPipesClient
>> > from streampipes.client.client_config import StreamPipesClientConfig
diff --git a/streampipes-client-python/docs/examples/1-introduction-to-streampipes-python-client.ipynb b/streampipes-client-python/docs/examples/1-introduction-to-streampipes-python-client.ipynb
index 70bc8259e..b034c02a7 100644
--- a/streampipes-client-python/docs/examples/1-introduction-to-streampipes-python-client.ipynb
+++ b/streampipes-client-python/docs/examples/1-introduction-to-streampipes-python-client.ipynb
@@ -35,6 +35,8 @@
"execution_count": null,
"outputs": [],
"source": [
+ "%pip install streampipes\n",
+ "# if you want to have the current development state you can also execute\n",
"%pip install git+https://github.com/apache/streampipes.git#subdirectory=streampipes-client-python"
],
"metadata": {
diff --git a/streampipes-client-python/docs/examples/2-extracting-data-from-the-streampipes-data-lake.ipynb b/streampipes-client-python/docs/examples/2-extracting-data-from-the-streampipes-data-lake.ipynb
index 79a148fba..b7001a6d8 100644
--- a/streampipes-client-python/docs/examples/2-extracting-data-from-the-streampipes-data-lake.ipynb
+++ b/streampipes-client-python/docs/examples/2-extracting-data-from-the-streampipes-data-lake.ipynb
@@ -64,7 +64,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
- "2022-12-04 21:19:21,832 - streampipes_client.client.client - [INFO] - [client.py:127] [_set_up_logging] - Logging successfully initialized with logging level INFO.\n"
+ "2022-12-04 21:19:21,832 - streampipes.client.client - [INFO] - [client.py:127] [_set_up_logging] - Logging successfully initialized with logging level INFO.\n"
]
}
],
@@ -94,7 +94,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
- "2022-12-04 21:19:23,599 - streampipes_client.endpoint.endpoint - [INFO] - [endpoint.py:153] [_make_request] - Successfully retrieved all resources.\n"
+ "2022-12-04 21:19:23,599 - streampipes.endpoint.endpoint - [INFO] - [endpoint.py:153] [_make_request] - Successfully retrieved all resources.\n"
]
}
],
@@ -212,7 +212,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
- "2022-12-04 21:19:30,505 - streampipes_client.endpoint.endpoint - [INFO] - [endpoint.py:153] [_make_request] - Successfully retrieved all resources.\n"
+ "2022-12-04 21:19:30,505 - streampipes.endpoint.endpoint - [INFO] - [endpoint.py:153] [_make_request] - Successfully retrieved all resources.\n"
]
}
],
diff --git a/streampipes-client-python/docs/examples/3-getting-live-data-from-the-streampipes-data-stream.ipynb b/streampipes-client-python/docs/examples/3-getting-live-data-from-the-streampipes-data-stream.ipynb
index 8f06991ff..c05162df5 100644
--- a/streampipes-client-python/docs/examples/3-getting-live-data-from-the-streampipes-data-stream.ipynb
+++ b/streampipes-client-python/docs/examples/3-getting-live-data-from-the-streampipes-data-stream.ipynb
@@ -57,7 +57,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
- "2022-12-14 10:43:37,664 - streampipes_client.client.client - [INFO] - [client.py:127] [_set_up_logging] - Logging successfully initialized with logging level INFO.\n"
+ "2022-12-14 10:43:37,664 - streampipes.client.client - [INFO] - [client.py:127] [_set_up_logging] - Logging successfully initialized with logging level INFO.\n"
]
}
],
@@ -88,7 +88,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
- "2022-12-14 10:43:39,944 - streampipes_client.endpoint.endpoint - [INFO] - [endpoint.py:153] [_make_request] - Successfully retrieved all resources.\n"
+ "2022-12-14 10:43:39,944 - streampipes.endpoint.endpoint - [INFO] - [endpoint.py:153] [_make_request] - Successfully retrieved all resources.\n"
]
},
{
@@ -309,8 +309,8 @@
"name": "stdout",
"output_type": "stream",
"text": [
- "2022-12-14 10:43:42,810 - streampipes_client.endpoint.endpoint - [INFO] - [endpoint.py:153] [_make_request] - Successfully retrieved all resources.\n",
- "2022-12-14 10:43:42,812 - streampipes_client.functions.function_handler - [INFO] - [function_handler.py:82] [initializeFunctions] - Using NatsBroker for <__main__.ExampleFunction object at 0x000001F2EF298D90>\n"
+ "2022-12-14 10:43:42,810 - streampipes.endpoint.endpoint - [INFO] - [endpoint.py:153] [_make_request] - Successfully retrieved all resources.\n",
+ "2022-12-14 10:43:42,812 - streampipes.functions.function_handler - [INFO] - [function_handler.py:82] [initializeFunctions] - Using NatsBroker for <__main__.ExampleFunction object at 0x000001F2EF298D90>\n"
]
}
],
@@ -555,7 +555,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
- "2022-12-14 10:44:53,309 - streampipes_client.functions.broker.nats_broker - [INFO] - [nats_broker.py:67] [disconnect] - Stopped connection to stream: urn:streampipes.apache.org:eventstream:uPDKLI\n"
+ "2022-12-14 10:44:53,309 - streampipes.functions.broker.nats_broker - [INFO] - [nats_broker.py:67] [disconnect] - Stopped connection to stream: urn:streampipes.apache.org:eventstream:uPDKLI\n"
]
},
{
diff --git a/streampipes-client-python/docs/examples/4-using-online-machine-learning-on-a-streampipes-data-stream.ipynb b/streampipes-client-python/docs/examples/4-using-online-machine-learning-on-a-streampipes-data-stream.ipynb
index 5b5c297f1..c2de994a9 100644
--- a/streampipes-client-python/docs/examples/4-using-online-machine-learning-on-a-streampipes-data-stream.ipynb
+++ b/streampipes-client-python/docs/examples/4-using-online-machine-learning-on-a-streampipes-data-stream.ipynb
@@ -42,7 +42,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
- "2023-01-27 16:04:24,784 - streampipes_client.client.client - [INFO] - [client.py:128] [_set_up_logging] - Logging successfully initialized with logging level INFO.\n"
+ "2023-01-27 16:04:24,784 - streampipes.client.client - [INFO] - [client.py:128] [_set_up_logging] - Logging successfully initialized with logging level INFO.\n"
]
}
],
@@ -65,7 +65,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
- "2023-01-27 16:04:28,212 - streampipes_client.endpoint.endpoint - [INFO] - [endpoint.py:163] [_make_request] - Successfully retrieved all resources.\n"
+ "2023-01-27 16:04:28,212 - streampipes.endpoint.endpoint - [INFO] - [endpoint.py:163] [_make_request] - Successfully retrieved all resources.\n"
]
},
{
@@ -238,19 +238,19 @@
"name": "stdout",
"output_type": "stream",
"text": [
- "2023-01-27 16:04:35,599 - streampipes_client.endpoint.endpoint - [INFO] - [endpoint.py:163] [_make_request] - Successfully retrieved all resources.\n",
- "2023-01-27 16:04:35,599 - streampipes_client.functions.function_handler - [INFO] - [function_handler.py:64] [initializeFunctions] - Create output data stream \"sp:spdatastream:cwKPoo\" for the function \"65cf8b86-bcdf-433e-a1c7-3e920eab55d0\"\n",
- "2023-01-27 16:04:37,766 - streampipes_client.endpoint.endpoint - [INFO] - [endpoint.py:163] [_make_request] - Successfully retrieved all resources.\n",
- "2023-01-27 16:04:37,767 - streampipes_client.functions.function_handler - [INFO] - [function_handler.py:78] [initializeFunctions] - Using NatsBroker for RiverFunction\n"
+ "2023-01-27 16:04:35,599 - streampipes.endpoint.endpoint - [INFO] - [endpoint.py:163] [_make_request] - Successfully retrieved all resources.\n",
+ "2023-01-27 16:04:35,599 - streampipes.functions.function_handler - [INFO] - [function_handler.py:64] [initializeFunctions] - Create output data stream \"sp:spdatastream:cwKPoo\" for the function \"65cf8b86-bcdf-433e-a1c7-3e920eab55d0\"\n",
+ "2023-01-27 16:04:37,766 - streampipes.endpoint.endpoint - [INFO] - [endpoint.py:163] [_make_request] - Successfully retrieved all resources.\n",
+ "2023-01-27 16:04:37,767 - streampipes.functions.function_handler - [INFO] - [function_handler.py:78] [initializeFunctions] - Using NatsBroker for RiverFunction\n"
]
},
{
"name": "stdout",
"output_type": "stream",
"text": [
- "2023-01-27 16:04:37,791 - streampipes_client.functions.broker.nats_broker - [INFO] - [nats_broker.py:48] [_makeConnection] - Connected to NATS at localhost:4222\n",
- "2023-01-27 16:04:37,791 - streampipes_client.functions.broker.nats_broker - [INFO] - [nats_broker.py:48] [_makeConnection] - Connected to NATS at localhost:4222\n",
- "2023-01-27 16:04:37,792 - streampipes_client.functions.broker.nats_broker - [INFO] - [nats_broker.py:58] [createSubscription] - Subscribed to stream: sp:spdatastream:xboBFK\n"
+ "2023-01-27 16:04:37,791 - streampipes.functions.broker.nats_broker - [INFO] - [nats_broker.py:48] [_makeConnection] - Connected to NATS at localhost:4222\n",
+ "2023-01-27 16:04:37,791 - streampipes.functions.broker.nats_broker - [INFO] - [nats_broker.py:48] [_makeConnection] - Connected to NATS at localhost:4222\n",
+ "2023-01-27 16:04:37,792 - streampipes.functions.broker.nats_broker - [INFO] - [nats_broker.py:58] [createSubscription] - Subscribed to stream: sp:spdatastream:xboBFK\n"
]
}
],
@@ -289,8 +289,8 @@
"name": "stdout",
"output_type": "stream",
"text": [
- "2023-01-27 16:04:57,303 - streampipes_client.functions.broker.nats_broker - [INFO] - [nats_broker.py:82] [disconnect] - Stopped connection to stream: sp:spdatastream:xboBFK\n",
- "2023-01-27 16:04:57,304 - streampipes_client.functions.broker.nats_broker - [INFO] - [nats_broker.py:82] [disconnect] - Stopped connection to stream: sp:spdatastream:cwKPoo\n"
+ "2023-01-27 16:04:57,303 - streampipes.functions.broker.nats_broker - [INFO] - [nats_broker.py:82] [disconnect] - Stopped connection to stream: sp:spdatastream:xboBFK\n",
+ "2023-01-27 16:04:57,304 - streampipes.functions.broker.nats_broker - [INFO] - [nats_broker.py:82] [disconnect] - Stopped connection to stream: sp:spdatastream:cwKPoo\n"
]
}
],
diff --git a/streampipes-client-python/docs/getting-started/installation.md b/streampipes-client-python/docs/getting-started/installation.md
index e6ddce8ed..a5145d42a 100644
--- a/streampipes-client-python/docs/getting-started/installation.md
+++ b/streampipes-client-python/docs/getting-started/installation.md
@@ -18,10 +18,12 @@
# 📚 Installation
-The StreamPipes Python Client is meant to work with Python 3.8 and above. Installation can be done via `pip`:
+The StreamPipes Python library is meant to work with Python 3.8 and above. Installation can be done via `pip`:
You can install the latest development version from GitHub, as so:
```bash
+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
```