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 1a3a7a22 chore(python-docs): update python doc assets to recent
development state (#86)
1a3a7a22 is described below
commit 1a3a7a2257e43f4a60e531d7b2945bb00854cc7d
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Sat Jun 3 07:27:24 2023 +0200
chore(python-docs): update python doc assets to recent development state
(#86)
---
.../dev/getting-started/quickstart/index.html | 5 +-
docs-python/dev/index.html | 3 +-
.../client/credential_provider/index.html | 29 +++++--
.../reference/functions/broker/broker/index.html | 2 +-
.../functions/broker/publisher/index.html | 2 +-
.../functions/utils/async_iter_handler/index.html | 4 +-
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 -> 705 bytes
.../index.html | 28 ++----
.../index.html | 12 +--
.../index.html | 12 +--
.../index.html | 12 +--
14 files changed, 113 insertions(+), 106 deletions(-)
diff --git a/docs-python/dev/getting-started/quickstart/index.html
b/docs-python/dev/getting-started/quickstart/index.html
index eff4ebed..a0dd70b0 100644
--- a/docs-python/dev/getting-started/quickstart/index.html
+++ b/docs-python/dev/getting-started/quickstart/index.html
@@ -1799,10 +1799,11 @@ measures.to_pandas()
<br>
Alternatively, you can provide your credentials via environment variables.
Simply define your credential provider as follows:</p>
-<p><div class="language-python highlight"><pre><span></span><code><span
class="o">>>></span> <span class="kn">from</span> <span
class="nn">streampipes.client.credential_provider</span> <span
class="kn">import</span> <span class="n">StreamPipesApiKeyCredentials</span>
+<p><div class="language-python highlight"><pre><span></span><code><span
class="kn">from</span> <span
class="nn">streampipes.client.credential_provider</span> <span
class="kn">import</span> <span class="n">StreamPipesApiKeyCredentials</span>
-<span class="n">StreamPipesApiKeyCredentials</span><span
class="o">.</span><span class="n">from_env</span><span class="p">(</span><span
class="n">username_env</span><span class="o">=</span><span
class="s2">"USER"</span><span class="p">,</span> <span
class="n">api_key_env</span><span class="o">=</span><span
class="s2">"API-KEY"</span><span class="p">)</span>
+<span class="n">StreamPipesApiKeyCredentials</span><span class="p">()</span>
</code></pre></div>
+This requires to set the following environment variables:
<code>SP_API_KEY</code> and <code>SP_USERNAME</code>
<br></p>
<p><code>username</code> is always the username that is used to log in into
StreamPipes. <br>
The <code>api_key</code> can be generated within the UI as demonstrated
below:</p>
diff --git a/docs-python/dev/index.html b/docs-python/dev/index.html
index 09ed391b..7ccf5a92 100644
--- a/docs-python/dev/index.html
+++ b/docs-python/dev/index.html
@@ -1856,8 +1856,9 @@ Alternatively, you can provide your credentials via
environment variables.
Simply define your credential provider as follows:</p>
<p><div class="language-python highlight"><pre><span></span><code><span
class="kn">from</span> <span
class="nn">streampipes.client.credential_provider</span> <span
class="kn">import</span> <span class="n">StreamPipesApiKeyCredentials</span>
-<span class="n">StreamPipesApiKeyCredentials</span><span
class="o">.</span><span class="n">from_env</span><span class="p">(</span><span
class="n">username_env</span><span class="o">=</span><span
class="s2">"USER"</span><span class="p">,</span> <span
class="n">api_key_env</span><span class="o">=</span><span
class="s2">"API-KEY"</span><span class="p">)</span>
+<span class="n">StreamPipesApiKeyCredentials</span><span class="p">()</span>
</code></pre></div>
+This requires to set the following environment variables:
<code>SP_API_KEY</code> and <code>SP_USERNAME</code>
<br></p>
<p><code>username</code> is always the username that is used to log in into
StreamPipes. <br>
The <code>api_key</code> can be generated within the UI as demonstrated
below:</p>
diff --git a/docs-python/dev/reference/client/credential_provider/index.html
b/docs-python/dev/reference/client/credential_provider/index.html
index fa21929e..cda117d9 100644
--- a/docs-python/dev/reference/client/credential_provider/index.html
+++ b/docs-python/dev/reference/client/credential_provider/index.html
@@ -2005,7 +2005,7 @@ determined by the credential provider.</p>
<h2 id="streampipes.client.credential_provider.StreamPipesApiKeyCredentials"
class="doc doc-heading">
-<code class="highlight language-python"><span
class="n">StreamPipesApiKeyCredentials</span><span class="p">(</span><span
class="n">username</span><span class="p">,</span> <span
class="n">api_key</span><span class="p">)</span></code>
+<code class="highlight language-python"><span
class="n">StreamPipesApiKeyCredentials</span><span class="p">(</span><span
class="n">username</span><span class="o">=</span><span
class="kc">None</span><span class="p">,</span> <span
class="n">api_key</span><span class="o">=</span><span
class="kc">None</span><span class="p">)</span></code>
<a href="#streampipes.client.credential_provider.StreamPipesApiKeyCredentials"
class="headerlink" title="Permanent link">¶</a></h2>
@@ -2017,6 +2017,12 @@ determined by the credential provider.</p>
<p>A credential provider that allows authentication via a StreamPipes
API Token.</p>
<p>The required token can be generated via the StreamPipes UI (see the
description on our <a href="../../../">start-page</a>.</p>
+<p>Both parameters can either be passed as arguments or remain unset.
+If they are not passed, they are retrieved from environment variables:</p>
+<ul>
+<li><code>SP_USERNAME</code> is expected to contain the username</li>
+<li><code>SP_API_KEY</code> is expected to contain the API key</li>
+</ul>
<table>
<thead>
@@ -2029,11 +2035,16 @@ determined by the credential provider.</p>
<tr>
<td><code>username</code></td>
<td class="doc-param-details">
- <p>The username to which the API token is granted, e.g.,
<code>[email protected]</code>.</p>
+ <p>The username to which the API token is granted, e.g.,
<code>[email protected]</code>.<br>
+If not passed, the username is retrieved from environment variable
<code>SP_USERNAME</code>.</p>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
- <code>str</code>
+ <code><span
title="typing.Optional">Optional</span>[str]</code>
+ </span>
+ <span class="doc-param-default">
+ <b>DEFAULT:</b>
+ <code>None</code>
</span>
</p>
</td>
@@ -2041,11 +2052,16 @@ determined by the credential provider.</p>
<tr>
<td><code>api_key</code></td>
<td class="doc-param-details">
- <p>The StreamPipes API key as it is displayed in the UI.</p>
+ <p>The StreamPipes API key as it is displayed in the UI.<br>
+If not passed, the api key is retrieved from environment variable
<code>SP_API_KEY</code></p>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
- <code>str</code>
+ <code><span
title="typing.Optional">Optional</span>[str]</code>
+ </span>
+ <span class="doc-param-default">
+ <b>DEFAULT:</b>
+ <code>None</code>
</span>
</p>
</td>
@@ -2086,7 +2102,8 @@ determined by the credential provider.</p>
<div class="doc doc-contents ">
- <p>Returns an api key provider parameterized via environment
variables.</p>
+ <p>DEPRECATED - use the class constructor instead</p>
+<p>Returns an api key provider parameterized via environment variables.</p>
<table>
<thead>
diff --git a/docs-python/dev/reference/functions/broker/broker/index.html
b/docs-python/dev/reference/functions/broker/broker/index.html
index bfe17e48..81903508 100644
--- a/docs-python/dev/reference/functions/broker/broker/index.html
+++ b/docs-python/dev/reference/functions/broker/broker/index.html
@@ -1965,8 +1965,8 @@
<code class="highlight language-python"><span class="n">disconnect</span><span
class="p">()</span></code>
<span class="doc doc-labels">
- <small class="doc doc-label
doc-label-abstractmethod"><code>abstractmethod</code></small>
<small class="doc doc-label doc-label-async"><code>async</code></small>
+ <small class="doc doc-label
doc-label-abstractmethod"><code>abstractmethod</code></small>
</span>
<a href="#streampipes.functions.broker.broker.Broker.disconnect"
class="headerlink" title="Permanent link">¶</a></h3>
diff --git a/docs-python/dev/reference/functions/broker/publisher/index.html
b/docs-python/dev/reference/functions/broker/publisher/index.html
index 5f1ca3ca..e16bec2f 100644
--- a/docs-python/dev/reference/functions/broker/publisher/index.html
+++ b/docs-python/dev/reference/functions/broker/publisher/index.html
@@ -1885,8 +1885,8 @@
<code class="highlight language-python"><span
class="n">publish_event</span><span class="p">(</span><span
class="n">event</span><span class="p">)</span></code>
<span class="doc doc-labels">
- <small class="doc doc-label
doc-label-abstractmethod"><code>abstractmethod</code></small>
<small class="doc doc-label doc-label-async"><code>async</code></small>
+ <small class="doc doc-label
doc-label-abstractmethod"><code>abstractmethod</code></small>
</span>
<a href="#streampipes.functions.broker.publisher.Publisher.publish_event"
class="headerlink" title="Permanent link">¶</a></h3>
diff --git
a/docs-python/dev/reference/functions/utils/async_iter_handler/index.html
b/docs-python/dev/reference/functions/utils/async_iter_handler/index.html
index e0923f57..0aa0db0f 100644
--- a/docs-python/dev/reference/functions/utils/async_iter_handler/index.html
+++ b/docs-python/dev/reference/functions/utils/async_iter_handler/index.html
@@ -1896,8 +1896,8 @@
<code class="highlight language-python"><span class="n">anext</span><span
class="p">(</span><span class="n">stream_id</span><span class="p">,</span>
<span class="n">message</span><span class="p">)</span></code>
<span class="doc doc-labels">
- <small class="doc doc-label
doc-label-staticmethod"><code>staticmethod</code></small>
<small class="doc doc-label doc-label-async"><code>async</code></small>
+ <small class="doc doc-label
doc-label-staticmethod"><code>staticmethod</code></small>
</span>
<a
href="#streampipes.functions.utils.async_iter_handler.AsyncIterHandler.anext"
class="headerlink" title="Permanent link">¶</a></h3>
@@ -1979,8 +1979,8 @@
<code class="highlight language-python"><span
class="n">combine_async_messages</span><span class="p">(</span><span
class="n">messages</span><span class="p">)</span></code>
<span class="doc doc-labels">
- <small class="doc doc-label
doc-label-staticmethod"><code>staticmethod</code></small>
<small class="doc doc-label doc-label-async"><code>async</code></small>
+ <small class="doc doc-label
doc-label-staticmethod"><code>staticmethod</code></small>
</span>
<a
href="#streampipes.functions.utils.async_iter_handler.AsyncIterHandler.combine_async_messages"
class="headerlink" title="Permanent link">¶</a></h3>
diff --git a/docs-python/dev/scripts/gen_ref_pages/index.html
b/docs-python/dev/scripts/gen_ref_pages/index.html
index 5ddc561e..c7b54d00 100644
--- a/docs-python/dev/scripts/gen_ref_pages/index.html
+++ b/docs-python/dev/scripts/gen_ref_pages/index.html
@@ -2749,7 +2749,7 @@ Licensed under the Apache License, Version 2.0.
init_mathjax();
</script>
<!-- End of mathjax configuration --><div class="jupyter-wrapper">
-<div id="cell-id=9ff8b63a" class="jp-Cell jp-MarkdownCell jp-Notebook-cell">
+<div id="cell-id=88f58321" class="jp-Cell jp-MarkdownCell jp-Notebook-cell">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
@@ -2772,7 +2772,7 @@ limitations under the License.</p>
</div>
</div>
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
-<div id="cell-id=cb754896" class="jp-Cell jp-CodeCell jp-Notebook-cell
jp-mod-noOutputs ">
+<div id="cell-id=8af5bf9c" class="jp-Cell jp-CodeCell jp-Notebook-cell
jp-mod-noOutputs ">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
@@ -2804,7 +2804,7 @@ limitations under the License.</p>
</div>
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
-<div id="cell-id=850bbd10" class="jp-Cell jp-CodeCell jp-Notebook-cell
jp-mod-noOutputs ">
+<div id="cell-id=738f35d7" class="jp-Cell jp-CodeCell jp-Notebook-cell
jp-mod-noOutputs ">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
@@ -2836,7 +2836,7 @@ limitations under the License.</p>
</div>
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
-<div id="cell-id=c2deaa5a" class="jp-Cell jp-CodeCell jp-Notebook-cell
jp-mod-noOutputs ">
+<div id="cell-id=3a9fee5b" class="jp-Cell jp-CodeCell jp-Notebook-cell
jp-mod-noOutputs ">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
@@ -2868,7 +2868,7 @@ limitations under the License.</p>
</div>
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs ">
-<div id="cell-id=4eda5ab0" class="jp-Cell jp-CodeCell jp-Notebook-cell
jp-mod-noOutputs ">
+<div id="cell-id=e542ffd4" class="jp-Cell jp-CodeCell jp-Notebook-cell
jp-mod-noOutputs ">
<div class="jp-Cell-inputWrapper">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
@@ -2946,7 +2946,7 @@ limitations under the License.</p>
</div>
</div>
-<div id="cell-id=370ecce7" class="jp-Cell jp-MarkdownCell jp-Notebook-cell">
+<div id="cell-id=e1e7dfa9" class="jp-Cell jp-MarkdownCell jp-Notebook-cell">
<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 43d72c72..72342111 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. Apache
StreamPipes for Python \ud83d\udc0d <p> 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 StreamP [...]
\ 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. Apache
StreamPipes for Python \ud83d\udc0d <p> 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 StreamP [...]
\ No newline at end of file
diff --git a/docs-python/dev/sitemap.xml b/docs-python/dev/sitemap.xml
index 60296db8..e6646af6 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-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/getting-started/developing/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/getting-started/first-steps/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/getting-started/quickstart/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/client/client/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/client/config/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/client/credential_provider/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/endpoint/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/exceptions/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</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-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/api/data_stream/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/api/version/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/function_zoo/river_function/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/function_handler/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/registration/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/streampipes_function/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/broker/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/broker_handler/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/consumer/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/output_collector/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/publisher/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</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-05-27</lastmod>
+ <lastmod>2023-06-03</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-05-27</lastmod>
+ <lastmod>2023-06-03</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-05-27</lastmod>
+ <lastmod>2023-06-03</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-05-27</lastmod>
+ <lastmod>2023-06-03</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-05-27</lastmod>
+ <lastmod>2023-06-03</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-05-27</lastmod>
+ <lastmod>2023-06-03</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-05-27</lastmod>
+ <lastmod>2023-06-03</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-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/function_context/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/common/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</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-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/data_streams/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/resource_container/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/versions/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</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-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/data_series/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/data_stream/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/exceptions/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/function_definition/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/query_result/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/resource/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/version/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/scripts/gen_ref_pages/</loc>
- <lastmod>2023-05-27</lastmod>
+ <lastmod>2023-06-03</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-05-27</lastmod>
+ <lastmod>2023-06-03</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-05-27</lastmod>
+ <lastmod>2023-06-03</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-05-27</lastmod>
+ <lastmod>2023-06-03</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-05-27</lastmod>
+ <lastmod>2023-06-03</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 1724f5f8..c2fc3e69 100644
Binary files a/docs-python/dev/sitemap.xml.gz and
b/docs-python/dev/sitemap.xml.gz differ
diff --git
a/docs-python/dev/tutorials/1-introduction-to-streampipes-python-client/index.html
b/docs-python/dev/tutorials/1-introduction-to-streampipes-python-client/index.html
index 55efe6a0..4c23936c 100644
---
a/docs-python/dev/tutorials/1-introduction-to-streampipes-python-client/index.html
+++
b/docs-python/dev/tutorials/1-introduction-to-streampipes-python-client/index.html
@@ -3122,9 +3122,9 @@ To do so, you must initialize the credential provider
like the following:</p>
</div>
</clipboard-copy>
</div>
- <div class="highlight-ipynb hl-python "><pre><span></span><span
class="n">StreamPipesApiKeyCredentials</span><span class="o">.</span><span
class="n">from_env</span><span class="p">(</span><span
class="n">username_env</span><span class="o">=</span><span
class="s2">"USER"</span><span class="p">,</span> <span
class="n">api_key_env</span><span class="o">=</span><span
class="s2">"API-KEY"</span><span class="p">)</span>
+ <div class="highlight-ipynb hl-python "><pre><span></span><span
class="n">StreamPipesApiKeyCredentials</span><span class="p">()</span>
</pre></div>
-<div id="cell-5"
class="clipboard-copy-txt">StreamPipesApiKeyCredentials.from_env(username_env="USER",
api_key_env="API-KEY")</div>
+<div id="cell-5"
class="clipboard-copy-txt">StreamPipesApiKeyCredentials()</div>
</div>
</div>
@@ -3140,9 +3140,8 @@ To do so, you must initialize the credential provider
like the following:</p>
</div>
<div class="jp-InputArea jp-Cell-inputArea"><div class="jp-InputPrompt
jp-InputArea-prompt">
</div><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput
" data-mime-type="text/markdown">
-<p>Please note that you pass the names of the environment variables.
-To ensure that the above code works, you must set the environment variables
with the same name you specified in <code>from_env</code>.
-In this scenario this would look like the following:</p>
+<p>To ensure that the above code works, you must set the environment variables
as expected.
+This can be done like following:</p>
</div>
</div>
@@ -3168,11 +3167,11 @@ In this scenario this would look like the following:</p>
</div>
</clipboard-copy>
</div>
- <div class="highlight-ipynb hl-python "><pre><span></span><span
class="o">%</span><span class="n">export</span> <span
class="n">USER</span><span class="o">=</span><span
class="s2">"<USERNAME>"</span>
-<span class="o">%</span><span class="n">export</span> <span
class="n">API_KEY</span><span class="o">=</span><span
class="s2">"<API-KEY>"</span>
+ <div class="highlight-ipynb hl-python "><pre><span></span><span
class="o">%</span><span class="n">export</span> <span
class="n">SP_USERNAME</span><span class="o">=</span><span
class="s2">"<USERNAME>"</span>
+<span class="o">%</span><span class="n">export</span> <span
class="n">SP_API_KEY</span><span class="o">=</span><span
class="s2">"<API-KEY>"</span>
</pre></div>
-<div id="cell-6" class="clipboard-copy-txt">%export USER="<USERNAME>"
-%export API_KEY="<API-KEY>"</div>
+<div id="cell-6" class="clipboard-copy-txt">%export SP_USERNAME="<USERNAME>"
+%export SP_API_KEY="<API-KEY>"</div>
</div>
</div>
@@ -3316,17 +3315,6 @@ We hope you like it and would love to receive some
feedback from you.
Just go to our <a
href="https://github.com/apache/streampipes/discussions";>GitHub discussion
page</a> and let us know your impression.
We'll read and react to them all, we promise!</p>
-</div>
-</div>
-</div>
-</div>
-<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell">
-<div class="jp-Cell-inputWrapper">
-<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
-</div>
-<div class="jp-InputArea jp-Cell-inputArea"><div class="jp-InputPrompt
jp-InputArea-prompt">
-</div><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput
" data-mime-type="text/markdown">
-
</div>
</div>
</div>
diff --git
a/docs-python/dev/tutorials/2-extracting-data-from-the-streampipes-data-lake/index.html
b/docs-python/dev/tutorials/2-extracting-data-from-the-streampipes-data-lake/index.html
index c66db92c..421701af 100644
---
a/docs-python/dev/tutorials/2-extracting-data-from-the-streampipes-data-lake/index.html
+++
b/docs-python/dev/tutorials/2-extracting-data-from-the-streampipes-data-lake/index.html
@@ -2880,12 +2880,12 @@ from streampipes.client.credential_provider import
StreamPipesApiKeyCredentials<
</clipboard-copy>
</div>
<div class="highlight-ipynb hl-python "><pre><span></span><span
class="kn">import</span> <span class="nn">os</span>
-<span class="n">os</span><span class="o">.</span><span
class="n">environ</span><span class="p">[</span><span
class="s2">"USER"</span><span class="p">]</span> <span
class="o">=</span> <span
class="s2">"[email protected]"</span>
-<span class="n">os</span><span class="o">.</span><span
class="n">environ</span><span class="p">[</span><span
class="s2">"API-KEY"</span><span class="p">]</span> <span
class="o">=</span> <span class="s2">"XXX"</span>
+<span class="n">os</span><span class="o">.</span><span
class="n">environ</span><span class="p">[</span><span
class="s2">"SP_USERNAME"</span><span class="p">]</span> <span
class="o">=</span> <span
class="s2">"[email protected]"</span>
+<span class="n">os</span><span class="o">.</span><span
class="n">environ</span><span class="p">[</span><span
class="s2">"SP_API_KEY"</span><span class="p">]</span> <span
class="o">=</span> <span class="s2">"XXX"</span>
</pre></div>
<div id="cell-3" class="clipboard-copy-txt">import os
-os.environ["USER"] = "[email protected]"
-os.environ["API-KEY"] = "XXX"
+os.environ["SP_USERNAME"] = "[email protected]"
+os.environ["SP_API_KEY"] = "XXX"
</div>
</div>
@@ -2917,14 +2917,14 @@ os.environ["API-KEY"] = "XXX"
</clipboard-copy>
</div>
<div class="highlight-ipynb hl-python "><pre><span></span><span
class="n">config</span> <span class="o">=</span> <span
class="n">StreamPipesClientConfig</span><span class="p">(</span>
- <span class="n">credential_provider</span><span class="o">=</span><span
class="n">StreamPipesApiKeyCredentials</span><span class="o">.</span><span
class="n">from_env</span><span class="p">(</span><span
class="n">username_env</span><span class="o">=</span><span
class="s2">"USER"</span><span class="p">,</span> <span
class="n">api_key_env</span><span class="o">=</span><span
class="s2">"API-KEY"</span><span class="p">),</span>
+ <span class="n">credential_provider</span><span class="o">=</span><span
class="n">StreamPipesApiKeyCredentials</span><span class="p">(),</span>
<span class="n">host_address</span><span class="o">=</span><span
class="s2">"localhost"</span><span class="p">,</span>
<span class="n">https_disabled</span><span class="o">=</span><span
class="kc">True</span><span class="p">,</span>
<span class="n">port</span><span class="o">=</span><span
class="mi">80</span>
<span class="p">)</span>
</pre></div>
<div id="cell-4" class="clipboard-copy-txt">config = StreamPipesClientConfig(
-
credential_provider=StreamPipesApiKeyCredentials.from_env(username_env="USER",
api_key_env="API-KEY"),
+ credential_provider=StreamPipesApiKeyCredentials(),
host_address="localhost",
https_disabled=True,
port=80
diff --git
a/docs-python/dev/tutorials/3-getting-live-data-from-the-streampipes-data-stream/index.html
b/docs-python/dev/tutorials/3-getting-live-data-from-the-streampipes-data-stream/index.html
index d68d0628..81cae5cc 100644
---
a/docs-python/dev/tutorials/3-getting-live-data-from-the-streampipes-data-stream/index.html
+++
b/docs-python/dev/tutorials/3-getting-live-data-from-the-streampipes-data-stream/index.html
@@ -2891,8 +2891,8 @@ from streampipes.client.credential_provider import
StreamPipesApiKeyCredentials<
</div>
<div class="highlight-ipynb hl-python "><pre><span></span><span
class="kn">import</span> <span class="nn">os</span>
-<span class="n">os</span><span class="o">.</span><span
class="n">environ</span><span class="p">[</span><span
class="s2">"USER"</span><span class="p">]</span> <span
class="o">=</span> <span
class="s2">"[email protected]"</span>
-<span class="n">os</span><span class="o">.</span><span
class="n">environ</span><span class="p">[</span><span
class="s2">"API-KEY"</span><span class="p">]</span> <span
class="o">=</span> <span class="s2">"XXX"</span>
+<span class="n">os</span><span class="o">.</span><span
class="n">environ</span><span class="p">[</span><span
class="s2">"SP_USERNAME"</span><span class="p">]</span> <span
class="o">=</span> <span
class="s2">"[email protected]"</span>
+<span class="n">os</span><span class="o">.</span><span
class="n">environ</span><span class="p">[</span><span
class="s2">"SP_API_KEY"</span><span class="p">]</span> <span
class="o">=</span> <span class="s2">"XXX"</span>
<span class="c1"># Use this if you work locally:</span>
<span class="n">os</span><span class="o">.</span><span
class="n">environ</span><span class="p">[</span><span
class="s2">"BROKER-HOST"</span><span class="p">]</span> <span
class="o">=</span> <span class="s2">"localhost"</span>
@@ -2900,8 +2900,8 @@ from streampipes.client.credential_provider import
StreamPipesApiKeyCredentials<
</pre></div>
<div id="cell-3" class="clipboard-copy-txt">import os
-os.environ["USER"] = "[email protected]"
-os.environ["API-KEY"] = "XXX"
+os.environ["SP_USERNAME"] = "[email protected]"
+os.environ["SP_API_KEY"] = "XXX"
# Use this if you work locally:
os.environ["BROKER-HOST"] = "localhost"
@@ -2936,7 +2936,7 @@ os.environ["KAFKA-PORT"] = "9094" # When using Kafka as
message broker</div>
</clipboard-copy>
</div>
<div class="highlight-ipynb hl-python "><pre><span></span><span
class="n">client_config</span> <span class="o">=</span> <span
class="n">StreamPipesClientConfig</span><span class="p">(</span>
- <span class="n">credential_provider</span><span class="o">=</span><span
class="n">StreamPipesApiKeyCredentials</span><span class="o">.</span><span
class="n">from_env</span><span class="p">(</span><span
class="n">username_env</span><span class="o">=</span><span
class="s2">"USER"</span><span class="p">,</span> <span
class="n">api_key_env</span><span class="o">=</span><span
class="s2">"API-KEY"</span><span class="p">),</span>
+ <span class="n">credential_provider</span><span class="o">=</span><span
class="n">StreamPipesApiKeyCredentials</span><span class="p">(),</span>
<span class="n">host_address</span><span class="o">=</span><span
class="s2">"localhost"</span><span class="p">,</span>
<span class="n">port</span><span class="o">=</span><span
class="mi">80</span><span class="p">,</span>
<span class="n">https_disabled</span><span class="o">=</span><span
class="kc">True</span><span class="p">,</span>
@@ -2944,7 +2944,7 @@ os.environ["KAFKA-PORT"] = "9094" # When using Kafka as
message broker</div>
<span class="n">client</span> <span class="o">=</span> <span
class="n">StreamPipesClient</span><span class="p">(</span><span
class="n">client_config</span><span class="o">=</span><span
class="n">client_config</span><span class="p">)</span>
</pre></div>
<div id="cell-4" class="clipboard-copy-txt">client_config =
StreamPipesClientConfig(
-
credential_provider=StreamPipesApiKeyCredentials.from_env(username_env="USER",
api_key_env="API-KEY"),
+ credential_provider=StreamPipesApiKeyCredentials(),
host_address="localhost",
port=80,
https_disabled=True,
diff --git
a/docs-python/dev/tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/index.html
b/docs-python/dev/tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/index.html
index 868ff3da..5281b731 100644
---
a/docs-python/dev/tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/index.html
+++
b/docs-python/dev/tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/index.html
@@ -2964,8 +2964,8 @@ from streampipes.client.credential_provider import
StreamPipesApiKeyCredentials<
</div>
<div class="highlight-ipynb hl-python "><pre><span></span><span
class="kn">import</span> <span class="nn">os</span>
-<span class="n">os</span><span class="o">.</span><span
class="n">environ</span><span class="p">[</span><span
class="s2">"USER"</span><span class="p">]</span> <span
class="o">=</span> <span
class="s2">"[email protected]"</span>
-<span class="n">os</span><span class="o">.</span><span
class="n">environ</span><span class="p">[</span><span
class="s2">"API-KEY"</span><span class="p">]</span> <span
class="o">=</span> <span class="s2">"XXX"</span>
+<span class="n">os</span><span class="o">.</span><span
class="n">environ</span><span class="p">[</span><span
class="s2">"SP_USERNAME"</span><span class="p">]</span> <span
class="o">=</span> <span
class="s2">"[email protected]"</span>
+<span class="n">os</span><span class="o">.</span><span
class="n">environ</span><span class="p">[</span><span
class="s2">"SP_API_KEY"</span><span class="p">]</span> <span
class="o">=</span> <span class="s2">"XXX"</span>
<span class="c1"># Use this if you work locally:</span>
<span class="n">os</span><span class="o">.</span><span
class="n">environ</span><span class="p">[</span><span
class="s2">"BROKER-HOST"</span><span class="p">]</span> <span
class="o">=</span> <span class="s2">"localhost"</span>
@@ -2973,8 +2973,8 @@ from streampipes.client.credential_provider import
StreamPipesApiKeyCredentials<
</pre></div>
<div id="cell-3" class="clipboard-copy-txt">import os
-os.environ["USER"] = "[email protected]"
-os.environ["API-KEY"] = "XXX"
+os.environ["SP_USERNAME"] = "[email protected]"
+os.environ["SP_API_KEY"] = "XXX"
# Use this if you work locally:
os.environ["BROKER-HOST"] = "localhost"
@@ -3009,7 +3009,7 @@ os.environ["KAFKA-PORT"] = "9094" # When using Kafka as
message broker</div>
</clipboard-copy>
</div>
<div class="highlight-ipynb hl-python "><pre><span></span><span
class="n">client_config</span> <span class="o">=</span> <span
class="n">StreamPipesClientConfig</span><span class="p">(</span>
- <span class="n">credential_provider</span><span class="o">=</span><span
class="n">StreamPipesApiKeyCredentials</span><span class="o">.</span><span
class="n">from_env</span><span class="p">(</span><span
class="n">username_env</span><span class="o">=</span><span
class="s2">"USER"</span><span class="p">,</span> <span
class="n">api_key_env</span><span class="o">=</span><span
class="s2">"API-KEY"</span><span class="p">),</span>
+ <span class="n">credential_provider</span><span class="o">=</span><span
class="n">StreamPipesApiKeyCredentials</span><span class="p">(),</span>
<span class="n">host_address</span><span class="o">=</span><span
class="s2">"localhost"</span><span class="p">,</span>
<span class="n">port</span><span class="o">=</span><span
class="mi">80</span><span class="p">,</span>
<span class="n">https_disabled</span><span class="o">=</span><span
class="kc">True</span><span class="p">,</span>
@@ -3017,7 +3017,7 @@ os.environ["KAFKA-PORT"] = "9094" # When using Kafka as
message broker</div>
<span class="n">client</span> <span class="o">=</span> <span
class="n">StreamPipesClient</span><span class="p">(</span><span
class="n">client_config</span><span class="o">=</span><span
class="n">client_config</span><span class="p">)</span>
</pre></div>
<div id="cell-4" class="clipboard-copy-txt">client_config =
StreamPipesClientConfig(
-
credential_provider=StreamPipesApiKeyCredentials.from_env(username_env="USER",
api_key_env="API-KEY"),
+ credential_provider=StreamPipesApiKeyCredentials(),
host_address="localhost",
port=80,
https_disabled=True,
