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 2024/03/04 07:49:25 UTC
(streampipes-website) branch dev updated: chore(python-docs): update python doc assets to recent development state (#151)
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-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 85f777e63 chore(python-docs): update python doc assets to recent development state (#151)
85f777e63 is described below
commit 85f777e6362ac4e2aed88bf6f322f38c15eb66cf
Author: github-actions[bot] <41...@users.noreply.github.com>
AuthorDate: Mon Mar 4 08:49:21 2024 +0100
chore(python-docs): update python doc assets to recent development state (#151)
Co-authored-by: bossenti <bo...@users.noreply.github.com>
---
docs-python/dev/objects.inv | Bin 3021 -> 3039 bytes
.../reference/model/resource/version/index.html | 35 ++++++++
docs-python/dev/scripts/gen_ref_pages/index.html | 12 +--
docs-python/dev/search/search_index.json | 2 +-
docs-python/dev/sitemap.xml | 96 ++++++++++-----------
docs-python/dev/sitemap.xml.gz | Bin 705 -> 704 bytes
6 files changed, 90 insertions(+), 55 deletions(-)
diff --git a/docs-python/dev/objects.inv b/docs-python/dev/objects.inv
index d8ee06e79..fbaa9aa28 100644
Binary files a/docs-python/dev/objects.inv and b/docs-python/dev/objects.inv differ
diff --git a/docs-python/dev/reference/model/resource/version/index.html b/docs-python/dev/reference/model/resource/version/index.html
index d1e0e7cfc..10bb9903f 100644
--- a/docs-python/dev/reference/model/resource/version/index.html
+++ b/docs-python/dev/reference/model/resource/version/index.html
@@ -2152,6 +2152,13 @@
convert_to_pandas_representation()
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.version.Version.validate_backend_version" class="md-nav__link">
+ validate_backend_version()
+ </a>
+
</li>
</ul>
@@ -2235,6 +2242,13 @@
convert_to_pandas_representation()
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.version.Version.validate_backend_version" class="md-nav__link">
+ validate_backend_version()
+ </a>
+
</li>
</ul>
@@ -2358,6 +2372,27 @@ to be used when creating a pandas Dataframe.</p>
</div>
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.model.resource.version.Version.validate_backend_version" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">validate_backend_version</span><span class="p">(</span><span class="n">backend_version</span><span class="p">)</span></code>
+
+<a href="#streampipes.model.resource.version.Version.validate_backend_version" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Validates the backend version of the StreamPipes.
+Sets 'development' if none is returned since this the behavior of StreamPipes backend running
+in development mode.</p>
+
+ </div>
+
+</div>
+
+
</div>
diff --git a/docs-python/dev/scripts/gen_ref_pages/index.html b/docs-python/dev/scripts/gen_ref_pages/index.html
index 4da93c73c..c09beb576 100644
--- a/docs-python/dev/scripts/gen_ref_pages/index.html
+++ b/docs-python/dev/scripts/gen_ref_pages/index.html
@@ -3168,7 +3168,7 @@ Licensed under the Apache License, Version 2.0.
init_mathjax();
</script>
<!-- End of mathjax configuration --><div class="jupyter-wrapper">
-<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=d9fc35f3">
+<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=783ad478">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
@@ -3190,7 +3190,7 @@ limitations under the License.</p>
</div>
</div>
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=f11ffeb9">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=8252c334">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
@@ -3217,7 +3217,7 @@ limitations under the License.</p>
</div>
</div>
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=f2c0651c">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=9fb8bee0">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
@@ -3244,7 +3244,7 @@ limitations under the License.</p>
</div>
</div>
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=282d4303">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=7c01cd19">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
@@ -3271,7 +3271,7 @@ limitations under the License.</p>
</div>
</div>
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
-<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=38df1437">
+<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=171f5292">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
@@ -3344,7 +3344,7 @@ limitations under the License.</p>
</div>
</div>
</div>
-<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=b49f6bf3">
+<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=da9d7c29">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
diff --git a/docs-python/dev/search/search_index.json b/docs-python/dev/search/search_index.json
index 889284e5b..034d1b542 100644
--- a/docs-python/dev/search/search_index.json
+++ b/docs-python/dev/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"\ud83c\udfe1 Home","text":"StreamPipes is a self-service (Industrial) IoT toolbox to enable non-technical users to connect, analyze and explore IoT data streams. <p>Dependency issue with StreamPipes Python 0.92.0</p> <p>In StreamPipes Python <code>0.92.0</code> there is a problem with the required dependencies. Pydantic has recently released the new version <code>2.0</code> wit [...]
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"\ud83c\udfe1 Home","text":"StreamPipes is a self-service (Industrial) IoT toolbox to enable non-technical users to connect, analyze and explore IoT data streams. <p>Dependency issue with StreamPipes Python 0.92.0</p> <p>In StreamPipes Python <code>0.92.0</code> there is a problem with the required dependencies. Pydantic has recently released the new version <code>2.0</code> wit [...]
\ No newline at end of file
diff --git a/docs-python/dev/sitemap.xml b/docs-python/dev/sitemap.xml
index 531271bbf..2afe9401a 100644
--- a/docs-python/dev/sitemap.xml
+++ b/docs-python/dev/sitemap.xml
@@ -2,242 +2,242 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/getting-started/developing/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/getting-started/first-steps/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/getting-started/quickstart/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/client/client/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/client/config/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/client/credential_provider/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/endpoint/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/exceptions/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/api/data_lake_measure/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/api/data_stream/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/api/version/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/function_zoo/river_function/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/function_handler/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/registration/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/streampipes_function/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/broker/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/broker_handler/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/consumer/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/output_collector/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/publisher/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/kafka/kafka_consumer/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/kafka/kafka_message_fetcher/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/kafka/kafka_publisher/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/nats/nats_consumer/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/nats/nats_publisher/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/async_iter_handler/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/data_stream_context/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/data_stream_generator/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/function_context/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/common/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/data_lake_measures/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/data_streams/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/resource_container/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/versions/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/data_lake_measure/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/data_series/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/data_stream/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/exceptions/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/function_definition/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/query_result/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/resource/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/version/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/scripts/gen_ref_pages/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/tutorials/1-introduction-to-streampipes-python-client/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/tutorials/2-extracting-data-from-the-streampipes-data-lake/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/tutorials/3-getting-live-data-from-the-streampipes-data-stream/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/</loc>
- <lastmod>2023-12-16</lastmod>
+ <lastmod>2024-03-02</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
\ No newline at end of file
diff --git a/docs-python/dev/sitemap.xml.gz b/docs-python/dev/sitemap.xml.gz
index a8fd3df23..ea29b77b0 100644
Binary files a/docs-python/dev/sitemap.xml.gz and b/docs-python/dev/sitemap.xml.gz differ