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/03/11 15:21:38 UTC
[streampipes] branch chore/python-doc-improvements created (now b551da216)
This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a change to branch chore/python-doc-improvements
in repository https://gitbox.apache.org/repos/asf/streampipes.git
at b551da216 [DS-1253] add missing links in examples
This branch includes the following new commits:
new c2b2cb429 fix: provide proper GitHub address
new 83049074e chore: update references
new 1de5c4708 chore: update references
new b551da216 [DS-1253] add missing links in examples
The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[streampipes] 04/04: [DS-1253] add missing links in examples
Posted by bo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a commit to branch chore/python-doc-improvements
in repository https://gitbox.apache.org/repos/asf/streampipes.git
commit b551da21629f07f0ea1401025b3ecc1233586d5b
Author: bossenti <bo...@posteo.de>
AuthorDate: Sat Mar 11 16:21:05 2023 +0100
[DS-1253] add missing links in examples
Signed-off-by: bossenti <bo...@posteo.de>
---
streampipes-client-python/README.md | 5 +++++
...introduction-to-streampipes-python-client.ipynb | 26 ++++++++++++++++++----
...cting-data-from-the-streampipes-data-lake.ipynb | 4 ++--
...ive-data-from-the-streampipes-data-stream.ipynb | 2 +-
...ine-learning-on-a-streampipes-data-stream.ipynb | 2 +-
.../docs/getting-started/first-steps.md | 1 +
streampipes-client-python/mkdocs.yml | 1 +
7 files changed, 33 insertions(+), 8 deletions(-)
diff --git a/streampipes-client-python/README.md b/streampipes-client-python/README.md
index 615693da4..40828c76e 100644
--- a/streampipes-client-python/README.md
+++ b/streampipes-client-python/README.md
@@ -47,6 +47,11 @@ Please visit our documentation: https://streampipes.apache.org/docs/docs/python/
There you can find information about how to [get started](https://streampipes.apache.org/docs/docs/python/latest/getting-started/first-steps/),
follow some [examples](https://streampipes.apache.org/docs/docs/python/latest/examples/1-introduction-to-streampipes-python-client/),
or discover the library via our [references](https://streampipes.apache.org/docs/docs/python/latest/reference/client/client/).
+<br>
+
+In case you want to access the documentation of the current development state, you can go here:
+
+👉 [development docs 🤓](https://streampipes.apache.org/docs/docs/python/dev/)
## ⚡️ Quickstart
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 9c6df65b9..d3eb17eeb 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
@@ -5,8 +5,6 @@
"source": [
"# Introduction to StreamPipes Python\n",
"\n",
- "<br>\n",
- "\n",
"### Why there is an extra Python library for StreamPipes?\n",
"[Apache StreamPipes](https://streampipes.apache.org/) aims to enable non-technical users to connect and analyze IoT data streams.\n",
"To this end, it provides an easy-to-use and convenient user interface that allows one to connect to an IoT data source and create some visual\n",
@@ -38,18 +36,38 @@
"collapsed": false
}
},
+ {
+ "cell_type": "markdown",
+ "source": [
+ "If you want to have the current development state you can also execute:"
+ ],
+ "metadata": {
+ "collapsed": false
+ }
+ },
{
"cell_type": "code",
"execution_count": null,
"outputs": [],
"source": [
- "# if you want to have the current development state you can also execute\n",
+ "\n",
"%pip install git+https://github.com/apache/streampipes.git#subdirectory=streampipes-client-python"
],
"metadata": {
"collapsed": false
}
},
+ {
+ "cell_type": "markdown",
+ "source": [
+ "The corresponding documentation can be found [here](\n",
+ "https://streampipes.apache.org/docs/docs/python/dev/).\n",
+ "<br>\n"
+ ],
+ "metadata": {
+ "collapsed": false
+ }
+ },
{
"cell_type": "markdown",
"source": [
@@ -226,7 +244,7 @@
"You can invoke a variety of commands directly on this object.\n",
"\n",
"Are you curious now how you actually can get data out of StreamPipes and make use of it with Python?\n",
- "Then check out the next example on [extracting Data from the StreamPipes data lake]().\n",
+ "Then check out the next example on [extracting Data from the StreamPipes data lake](../2-extracting-data-from-the-streampipes-data-lake).\n",
"\n",
"<br>\n",
"\n",
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 780831c57..fb9facf5b 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
@@ -5,7 +5,7 @@
"source": [
"# Extracting Data from the StreamPipes data lake\n",
"\n",
- "In the first example ([Introduction to the StreamPipes Python client]()) we took the first steps with the StreamPipes Python client and learned how to set everything up.\n",
+ "In the first example ([Introduction to the StreamPipes Python client](../1-introduction-to-streampipes-python-client)) we took the first steps with the StreamPipes Python client and learned how to set everything up.\n",
"Now we are ready to get started and want to retrieve some data out of StreamPipes.\n",
"In this tutorial, we'll focus on the StreamPipes Data Lake, the component where StreamPipes stores data internally.\n",
"To get started, we'll use the `client` instance created in the first tutorial."
@@ -349,7 +349,7 @@
{
"cell_type": "markdown",
"source": [
- "For data lake measurements, the `get()` method is even more powerful than simply returning all the data for a given data lake measurement. We will look at a selection of these below. The full list of supported parameters can be found in the [docs](). <br>\n",
+ "For data lake measurements, the `get()` method is even more powerful than simply returning all the data for a given data lake measurement. We will look at a selection of these below. The full list of supported parameters can be found in the [docs](../../reference/endpoint/api/data_lake_measure/#streampipes.endpoint.api.data_lake_measure.MeasurementGetQueryConfig). <br>\n",
"Let's start by referring to the graph we created above, where we use only two columns of our data lake measurement. If we already know this, we can directly restrict the queried data to a subset of columns by using the `columns` parameter. <br>\n",
"`columns` takes a list of column names as a comma-separated string:"
],
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 8a9aba39b..c9d97a461 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
@@ -6,7 +6,7 @@
"metadata": {},
"source": [
"# Getting live data from the StreamPipes data stream\n",
- "In the last example ([Extracting Data from the StreamPipes data lake]()) we learned how to extract the stored data from a StreamPipes data lake. This tutorial is about the StreamPipes data stream and shows how to get the live data from a stream. Therefore, we first create the `client` instance as before."
+ "In the last example ([Extracting Data from the StreamPipes data lake](../2-extracting-data-from-the-streampipes-data-lake)) we learned how to extract the stored data from a StreamPipes data lake. This tutorial is about the StreamPipes data stream and shows how to get the live data from a stream. Therefore, we first create the `client` instance as before."
]
},
{
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 2e82de279..a3d933a27 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
@@ -6,7 +6,7 @@
"metadata": {},
"source": [
"# Using Online Machine Learning on a StreamPipes data stream\n",
- "The last example ([Getting live data from the StreamPipes data stream]()) showed how we can connect to a data stream, and it would be possible to use Online Machine Learning with this approach and train a model with the incoming events at the `onEvent` method. However, the StreamPipes client also provides an easier way to do this with the use of the River library for Online Machine Learning. We will have a look at this now."
+ "The last example ([Getting live data from the StreamPipes data stream](../3-getting-live-data-from-the-streampipes-data-stream)) showed how we can connect to a data stream, and it would be possible to use Online Machine Learning with this approach and train a model with the incoming events at the `onEvent` method. However, the StreamPipes client also provides an easier way to do this with the use of the River library for Online Machine Learning. We will have a look at this now."
]
},
{
diff --git a/streampipes-client-python/docs/getting-started/first-steps.md b/streampipes-client-python/docs/getting-started/first-steps.md
index a416dce35..8593903b9 100644
--- a/streampipes-client-python/docs/getting-started/first-steps.md
+++ b/streampipes-client-python/docs/getting-started/first-steps.md
@@ -25,6 +25,7 @@ You can install the latest development version from GitHub, as so:
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
+# the corresponding documentation can be found here: https://streampipes.apache.org/docs/docs/python/dev/
```
## ⬆️ Setting up StreamPipes
diff --git a/streampipes-client-python/mkdocs.yml b/streampipes-client-python/mkdocs.yml
index b000a47ba..640a5a2d9 100644
--- a/streampipes-client-python/mkdocs.yml
+++ b/streampipes-client-python/mkdocs.yml
@@ -28,6 +28,7 @@ theme:
custom_dir: docs/overrides
features:
- navigation.tabs
+ - navigation.tabs.sticky
- navigation.instant
- navigation.indexes
- navigation.tracking
[streampipes] 03/04: chore: update references
Posted by bo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a commit to branch chore/python-doc-improvements
in repository https://gitbox.apache.org/repos/asf/streampipes.git
commit 1de5c4708889878cc927a965a1b54f3f55df5c5e
Author: bossenti <bo...@posteo.de>
AuthorDate: Sat Mar 11 16:04:14 2023 +0100
chore: update references
Signed-off-by: bossenti <bo...@posteo.de>
---
streampipes-client-python/README.md | 9 ++++++++-
streampipes-client-python/setup.py | 2 +-
2 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/streampipes-client-python/README.md b/streampipes-client-python/README.md
index 15d2c976c..615693da4 100644
--- a/streampipes-client-python/README.md
+++ b/streampipes-client-python/README.md
@@ -41,6 +41,13 @@ and the amazing universe of data analytics libraries in Python. </p>
**This means that it is still under development, which may result in frequent and extensive API changes, unstable behavior, etc.**
<br>
+
+## 📚 Documentation
+Please visit our documentation: https://streampipes.apache.org/docs/docs/python/latest/
+There you can find information about how to [get started](https://streampipes.apache.org/docs/docs/python/latest/getting-started/first-steps/),
+follow some [examples](https://streampipes.apache.org/docs/docs/python/latest/examples/1-introduction-to-streampipes-python-client/),
+or discover the library via our [references](https://streampipes.apache.org/docs/docs/python/latest/reference/client/client/).
+
## ⚡️ Quickstart
As a quick example, we demonstrate how to set up and configure a StreamPipes client.
@@ -81,4 +88,4 @@ The following StreamPipes resources are available with this client:
1x DataLakeMeasures
```
-For more information about how to use the StreamPipes client visit our [introduction example](https://github.com/apache/streampipes/blob/dev/streampipes-client-python/docs/examples/1-introduction-to-streampipes-python-client.ipynb).
+For more information about how to use the StreamPipes client visit our [introduction example](https://streampipes.apache.org/docs/docs/python/latest/examples/1-introduction-to-streampipes-python-client/).
diff --git a/streampipes-client-python/setup.py b/streampipes-client-python/setup.py
index 19fb23785..cecb3ef42 100644
--- a/streampipes-client-python/setup.py
+++ b/streampipes-client-python/setup.py
@@ -103,7 +103,7 @@ setuptools.setup(
classifiers=[
# Trove classifiers
# Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
- "Development Status :: 3 - Alpha",
+ "Development Status :: 4 - Beta",
"Environment :: Console",
"Intended Audience :: Developers",
"Intended Audience :: Information Technology",
[streampipes] 01/04: fix: provide proper GitHub address
Posted by bo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a commit to branch chore/python-doc-improvements
in repository https://gitbox.apache.org/repos/asf/streampipes.git
commit c2b2cb42996464a99ae2ff5c0d655a7dc6b9ab3f
Author: bossenti <bo...@posteo.de>
AuthorDate: Sat Mar 11 16:02:09 2023 +0100
fix: provide proper GitHub address
Signed-off-by: bossenti <bo...@posteo.de>
---
streampipes-client-python/streampipes/client/credential_provider.py | 3 +--
.../streampipes/endpoint/api/data_lake_measure.py | 4 ++--
streampipes-client-python/streampipes/endpoint/endpoint.py | 2 +-
.../streampipes/model/container/resource_container.py | 4 ++--
4 files changed, 6 insertions(+), 7 deletions(-)
diff --git a/streampipes-client-python/streampipes/client/credential_provider.py b/streampipes-client-python/streampipes/client/credential_provider.py
index c94acc02f..015e192f8 100644
--- a/streampipes-client-python/streampipes/client/credential_provider.py
+++ b/streampipes-client-python/streampipes/client/credential_provider.py
@@ -89,8 +89,7 @@ class StreamPipesApiKeyCredentials(CredentialProvider):
References
----------
- [^1]: [StreamPipes Python Client README]
- (https://github.com/apache/streampipes/blob/dev/streampipes-client-python/README.md#%EF%B8%8F-quickstart)
+ [^1]: [StreamPipes Python Client README](https://streampipes.apache.org/docs/docs/python/latest/)
"""
@classmethod
diff --git a/streampipes-client-python/streampipes/endpoint/api/data_lake_measure.py b/streampipes-client-python/streampipes/endpoint/api/data_lake_measure.py
index a5975b277..5f8929314 100644
--- a/streampipes-client-python/streampipes/endpoint/api/data_lake_measure.py
+++ b/streampipes-client-python/streampipes/endpoint/api/data_lake_measure.py
@@ -127,7 +127,7 @@ class MeasurementGetQueryConfig(BaseModel):
"Your datetime object is off, it could not be parsed"
"This should not occur, but unfortunately did.\n"
"Therefore, it would be great if you could report this problem as an issue at "
- "github.com/apache/streampipes.\n"
+ "https://github.com/apache/streampipes.\n"
) from ve
def build_query_string(self) -> str:
@@ -250,7 +250,7 @@ class DataLakeMeasureEndpoint(APIEndpoint):
f"Some of them are not provided as expected. Please see the detailed output below:\n\n"
f"Validation error log: {ve.json()}\n\n"
f"In case you assess your query configuration to be correct feel free to file us an issue via "
- f"github.com/apache/streampipes.\n"
+ f"https://github.com/apache/streampipes.\n"
f"Please don't forget to include the following validation log from above."
)
diff --git a/streampipes-client-python/streampipes/endpoint/endpoint.py b/streampipes-client-python/streampipes/endpoint/endpoint.py
index cfc6b7381..780a68f42 100644
--- a/streampipes-client-python/streampipes/endpoint/endpoint.py
+++ b/streampipes-client-python/streampipes/endpoint/endpoint.py
@@ -54,7 +54,7 @@ _error_code_to_message = {
"\nOops, there seems to be an issue with the Python Client calling the API inappropriately.\n"
"This should not happen, but unfortunately did.\n"
"If you don't mind, it would be awesome to let us know by creating an issue"
- " at github.com/apache/streampipes.\n"
+ " at https://github.com/apache/streampipes.\n"
"Please paste the following information to the issue description:\n\n",
),
}
diff --git a/streampipes-client-python/streampipes/model/container/resource_container.py b/streampipes-client-python/streampipes/model/container/resource_container.py
index 3bfcddcb8..331caeda9 100644
--- a/streampipes-client-python/streampipes/model/container/resource_container.py
+++ b/streampipes-client-python/streampipes/model/container/resource_container.py
@@ -67,7 +67,7 @@ class StreamPipesDataModelError(Exception):
f"\nOops, there seems to be a problem with our internal StreamPipes data model.\n"
f"This should not occur, but unfortunately did.\n"
f"Therefore, it would be great if you could report this problem as an issue at "
- f"github.com/apache/streampipes.\n"
+ f"https://github.com/apache/streampipes.\n"
f"Please don't forget to include the following information:\n\n"
f"Affected Model class: {str(self.validation_error.model)}\n"
f"Validation error log: {self.validation_error.json()}"
@@ -107,7 +107,7 @@ class StreamPipesResourceContainerJSONError(Exception):
f"\nOops, there seems to be a problem when parsing the response of the StreamPipes API."
f"This should not occur, but unfortunately did.\n"
f"Therefore, it would be great if you could report this problem as an issue at "
- f"github.com/apache/streampipes.\n"
+ f"https://github.com/apache/streampipes.\n"
f"Please don't forget to include the following information:\n\n"
f"Affected container class: {str(self.container_name)}\n"
f"JSON string: {self.json_string}"
[streampipes] 02/04: chore: update references
Posted by bo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a commit to branch chore/python-doc-improvements
in repository https://gitbox.apache.org/repos/asf/streampipes.git
commit 83049074e61251529ec31ec0e42bfed97157b34f
Author: bossenti <bo...@posteo.de>
AuthorDate: Sat Mar 11 16:02:48 2023 +0100
chore: update references
Signed-off-by: bossenti <bo...@posteo.de>
---
streampipes-client-python/mkdocs.yml | 4 ++--
streampipes-client-python/setup.py | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/streampipes-client-python/mkdocs.yml b/streampipes-client-python/mkdocs.yml
index 68fec6b1f..b000a47ba 100644
--- a/streampipes-client-python/mkdocs.yml
+++ b/streampipes-client-python/mkdocs.yml
@@ -17,7 +17,7 @@
site_name: Apache StreamPipes for Python
repo_url: https://github.com/apache/streampipes
-edit_uri: "https://github.com/apache/streampipes"
+edit_uri: streampipes-client-python/docs
copyright: "Apache License 2.0"
@@ -39,7 +39,7 @@ extra:
link: https://github.com/apache/streampipes
analytics:
provider: matomo
-
+ homepage: https://streampipes.apache.org/
version:
provider: mike
diff --git a/streampipes-client-python/setup.py b/streampipes-client-python/setup.py
index 2675520d0..19fb23785 100644
--- a/streampipes-client-python/setup.py
+++ b/streampipes-client-python/setup.py
@@ -24,7 +24,7 @@ import setuptools
NAME = "streampipes"
DESCRIPTION = "Python library for Apache StreamPipes"
LONG_DESCRIPTION_CONTENT_TYPE = "text/markdown"
-URL = "https://github.com/apache/streampipes/tree/dev/streampipes-client-python"
+URL = "https://streampipes.apache.org/docs/docs/python/latest/"
EMAIL = "dev@streampipes.apache.org"
AUTHOR = "Apache Software Foundation"
REQUIRES_PYTHON = ">=3.8.0"