You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by gi...@apache.org on 2023/04/02 19:44:36 UTC
[streampipes-website] branch asf-site updated: Automated deployment: Sun Apr 2 19:44:31 UTC 2023 77a7e9cbef9c00c49ef61fbdf57a198a75aa3e00
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/streampipes-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 4be325aa Automated deployment: Sun Apr 2 19:44:31 UTC 2023 77a7e9cbef9c00c49ef61fbdf57a198a75aa3e00
4be325aa is described below
commit 4be325aa8586cf651f478a0f670295544539a4e7
Author: bossenti <bo...@users.noreply.github.com>
AuthorDate: Sun Apr 2 19:44:31 2023 +0000
Automated deployment: Sun Apr 2 19:44:31 UTC 2023 77a7e9cbef9c00c49ef61fbdf57a198a75aa3e00
---
docs/docs/python/dev/404.html | 162 ++-
.../dev/getting-started/developing/index.html | 94 +-
.../dev/getting-started/first-steps/index.html | 103 +-
.../dev/getting-started/quickstart/index.html | 136 +-
.../python/dev/img/streampipes-python-dark.png | Bin 0 -> 116009 bytes
docs/docs/python/dev/index.html | 107 +-
docs/docs/python/dev/objects.inv | Bin 1729 -> 1728 bytes
.../python/dev/reference/client/client/index.html | 224 ++-
.../python/dev/reference/client/config/index.html | 87 +-
.../client/credential_provider/index.html | 109 +-
.../endpoint/api/data_lake_measure/index.html | 198 +--
.../reference/endpoint/api/data_stream/index.html | 129 +-
.../dev/reference/endpoint/endpoint/index.html | 245 ++--
.../dev/reference/endpoint/exceptions/index.html | 76 +-
.../function_zoo/river_function/index.html | 211 ++-
.../reference/functions/broker/broker/index.html | 148 +-
.../functions/broker/broker_handler/index.html | 133 +-
.../functions/broker/kafka_broker/index.html | 113 +-
.../broker/kafka_message_fetcher/index.html | 124 +-
.../functions/broker/nats_broker/index.html | 111 +-
.../functions/broker/output_collector/index.html | 168 ++-
.../functions/function_handler/index.html | 125 +-
.../reference/functions/registration/index.html | 124 +-
.../functions/streampipes_function/index.html | 138 +-
.../functions/utils/async_iter_handler/index.html | 126 +-
.../functions/utils/data_stream_context/index.html | 80 +-
.../utils/data_stream_generator/index.html | 162 ++-
.../functions/utils/function_context/index.html | 78 +-
.../python/dev/reference/model/common/index.html | 103 +-
.../model/container/data_lake_measures/index.html | 99 +-
.../model/container/data_streams/index.html | 99 +-
.../model/container/resource_container/index.html | 102 +-
.../model/resource/data_lake_measure/index.html | 112 +-
.../model/resource/data_lake_series/index.html | 105 +-
.../model/resource/data_stream/index.html | 93 +-
.../model/resource/function_definition/index.html | 316 +++--
.../reference/model/resource/resource/index.html | 106 +-
.../python/dev/scripts/gen_ref_pages/index.html | 194 +--
docs/docs/python/dev/search/search_index.json | 2 +-
docs/docs/python/dev/sitemap.xml | 156 +--
docs/docs/python/dev/sitemap.xml.gz | Bin 220 -> 650 bytes
.../index.html | 694 +++++++--
.../index.html | 1475 ++++++++++++++++++--
.../index.html | 1081 ++++++++++++--
.../index.html | 1142 +++++++++++++--
docs/docs/python/latest/404.html | 162 ++-
.../latest/getting-started/developing/index.html | 94 +-
.../latest/getting-started/first-steps/index.html | 103 +-
.../latest/getting-started/quickstart/index.html | 136 +-
.../python/latest/img/streampipes-python-dark.png | Bin 0 -> 116009 bytes
docs/docs/python/latest/index.html | 107 +-
docs/docs/python/latest/objects.inv | Bin 1729 -> 1728 bytes
.../latest/reference/client/client/index.html | 224 ++-
.../latest/reference/client/config/index.html | 87 +-
.../client/credential_provider/index.html | 109 +-
.../endpoint/api/data_lake_measure/index.html | 198 +--
.../reference/endpoint/api/data_stream/index.html | 129 +-
.../latest/reference/endpoint/endpoint/index.html | 245 ++--
.../reference/endpoint/exceptions/index.html | 76 +-
.../function_zoo/river_function/index.html | 211 ++-
.../reference/functions/broker/broker/index.html | 148 +-
.../functions/broker/broker_handler/index.html | 133 +-
.../functions/broker/kafka_broker/index.html | 113 +-
.../broker/kafka_message_fetcher/index.html | 124 +-
.../functions/broker/nats_broker/index.html | 111 +-
.../functions/broker/output_collector/index.html | 168 ++-
.../functions/function_handler/index.html | 125 +-
.../reference/functions/registration/index.html | 124 +-
.../functions/streampipes_function/index.html | 138 +-
.../functions/utils/async_iter_handler/index.html | 126 +-
.../functions/utils/data_stream_context/index.html | 80 +-
.../utils/data_stream_generator/index.html | 162 ++-
.../functions/utils/function_context/index.html | 78 +-
.../latest/reference/model/common/index.html | 103 +-
.../model/container/data_lake_measures/index.html | 99 +-
.../model/container/data_streams/index.html | 99 +-
.../model/container/resource_container/index.html | 102 +-
.../model/resource/data_lake_measure/index.html | 112 +-
.../model/resource/data_lake_series/index.html | 105 +-
.../model/resource/data_stream/index.html | 93 +-
.../model/resource/function_definition/index.html | 316 +++--
.../reference/model/resource/resource/index.html | 106 +-
.../python/latest/scripts/gen_ref_pages/index.html | 194 +--
docs/docs/python/latest/search/search_index.json | 2 +-
docs/docs/python/latest/sitemap.xml | 156 +--
docs/docs/python/latest/sitemap.xml.gz | Bin 220 -> 650 bytes
.../index.html | 694 +++++++--
.../index.html | 1475 ++++++++++++++++++--
.../index.html | 1081 ++++++++++++--
.../index.html | 1142 +++++++++++++--
90 files changed, 14426 insertions(+), 4354 deletions(-)
diff --git a/docs/docs/python/dev/404.html b/docs/docs/python/dev/404.html
index 59b098c8..8656b1e1 100644
--- a/docs/docs/python/dev/404.html
+++ b/docs/docs/python/dev/404.html
@@ -25,6 +25,10 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+
+
+ <meta name="author" content="Apache Software Foundation (ASF)">
@@ -34,14 +38,14 @@
- <title>Apache StreamPipes for Python</title>
+ <title>Apache StreamPipes Python</title>
- <link rel="stylesheet" href="/assets/stylesheets/main.c4a75a56.min.css">
+ <link rel="stylesheet" href="/docs/docs/python/latest/latest/assets/stylesheets/main.c4a75a56.min.css">
- <link rel="stylesheet" href="/assets/stylesheets/palette.a0c5b2b5.min.css">
+ <link rel="stylesheet" href="/docs/docs/python/latest/latest/assets/stylesheets/palette.a0c5b2b5.min.css">
@@ -51,11 +55,11 @@
- <link rel="stylesheet" href="/assets/_mkdocstrings.css">
+ <link rel="stylesheet" href="/docs/docs/python/latest/latest/assets/_mkdocstrings.css">
- <link rel="stylesheet" href="/stylesheets/extra.css">
+ <link rel="stylesheet" href="/docs/docs/python/latest/latest/stylesheets/extra.css">
- <script>__md_scope=new URL("/",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+ <script>__md_scope=new URL("/docs/docs/python/latest/latest",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -109,6 +113,8 @@
+
+
@@ -116,6 +122,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -137,7 +145,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -149,7 +157,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -162,6 +170,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -205,7 +233,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -224,8 +252,8 @@
<li class="md-tabs__item">
- <a href="/." class="md-tabs__link">
- Home
+ <a href="/docs/docs/python/latest/latest/." class="md-tabs__link">
+ 🏡 Home
</a>
</li>
@@ -239,8 +267,8 @@
<li class="md-tabs__item">
- <a href="/getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ <a href="/docs/docs/python/latest/latest/getting-started/first-steps/" class="md-tabs__link">
+ 🚀 Getting Started
</a>
</li>
@@ -255,8 +283,8 @@
<li class="md-tabs__item">
- <a href="/examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="/docs/docs/python/latest/latest/tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -276,8 +304,8 @@
<li class="md-tabs__item">
- <a href="/reference/client/client/" class="md-tabs__link">
- Reference
+ <a href="/docs/docs/python/latest/latest/reference/client/client/" class="md-tabs__link">
+ 📚 Reference
</a>
</li>
@@ -312,12 +340,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -327,7 +355,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -342,8 +370,8 @@
<li class="md-nav__item">
- <a href="/." class="md-nav__link">
- Home
+ <a href="/docs/docs/python/latest/latest/." class="md-nav__link">
+ 🏡 Home
</a>
</li>
@@ -375,14 +403,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -392,7 +420,7 @@
<li class="md-nav__item">
- <a href="/getting-started/first-steps/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/getting-started/first-steps/" class="md-nav__link">
First Steps
</a>
</li>
@@ -406,7 +434,7 @@
<li class="md-nav__item">
- <a href="/getting-started/developing/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/getting-started/developing/" class="md-nav__link">
Developing & Contributing
</a>
</li>
@@ -420,7 +448,7 @@
<li class="md-nav__item">
- <a href="/getting-started/quickstart/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/getting-started/quickstart/" class="md-nav__link">
Quickstart
</a>
</li>
@@ -462,14 +490,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -479,7 +507,7 @@
<li class="md-nav__item">
- <a href="/examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -493,7 +521,7 @@
<li class="md-nav__item">
- <a href="/examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -507,7 +535,7 @@
<li class="md-nav__item">
- <a href="/examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -521,7 +549,7 @@
<li class="md-nav__item">
- <a href="/examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -565,14 +593,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -617,7 +645,7 @@
<li class="md-nav__item">
- <a href="/reference/client/client/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/client/client/" class="md-nav__link">
Client
</a>
</li>
@@ -631,7 +659,7 @@
<li class="md-nav__item">
- <a href="/reference/client/config/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/client/config/" class="md-nav__link">
Config
</a>
</li>
@@ -645,7 +673,7 @@
<li class="md-nav__item">
- <a href="/reference/client/credential_provider/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/client/credential_provider/" class="md-nav__link">
Credential provider
</a>
</li>
@@ -701,7 +729,7 @@
<li class="md-nav__item">
- <a href="/reference/endpoint/endpoint/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/endpoint/endpoint/" class="md-nav__link">
Endpoint
</a>
</li>
@@ -715,7 +743,7 @@
<li class="md-nav__item">
- <a href="/reference/endpoint/exceptions/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/endpoint/exceptions/" class="md-nav__link">
Exceptions
</a>
</li>
@@ -762,7 +790,7 @@
<li class="md-nav__item">
- <a href="/reference/endpoint/api/data_lake_measure/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/endpoint/api/data_lake_measure/" class="md-nav__link">
Data lake measure
</a>
</li>
@@ -776,7 +804,7 @@
<li class="md-nav__item">
- <a href="/reference/endpoint/api/data_stream/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/endpoint/api/data_stream/" class="md-nav__link">
Data stream
</a>
</li>
@@ -835,7 +863,7 @@
<li class="md-nav__item">
- <a href="/reference/function_zoo/river_function/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/function_zoo/river_function/" class="md-nav__link">
River function
</a>
</li>
@@ -895,7 +923,7 @@
<li class="md-nav__item">
- <a href="/reference/functions/function_handler/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/functions/function_handler/" class="md-nav__link">
Function handler
</a>
</li>
@@ -909,7 +937,7 @@
<li class="md-nav__item">
- <a href="/reference/functions/registration/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/functions/registration/" class="md-nav__link">
Registration
</a>
</li>
@@ -923,7 +951,7 @@
<li class="md-nav__item">
- <a href="/reference/functions/streampipes_function/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/functions/streampipes_function/" class="md-nav__link">
Streampipes function
</a>
</li>
@@ -978,7 +1006,7 @@
<li class="md-nav__item">
- <a href="/reference/functions/broker/broker/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/functions/broker/broker/" class="md-nav__link">
Broker
</a>
</li>
@@ -992,7 +1020,7 @@
<li class="md-nav__item">
- <a href="/reference/functions/broker/broker_handler/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/functions/broker/broker_handler/" class="md-nav__link">
Broker handler
</a>
</li>
@@ -1006,7 +1034,7 @@
<li class="md-nav__item">
- <a href="/reference/functions/broker/kafka_broker/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/functions/broker/kafka_broker/" class="md-nav__link">
Kafka broker
</a>
</li>
@@ -1020,7 +1048,7 @@
<li class="md-nav__item">
- <a href="/reference/functions/broker/kafka_message_fetcher/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/functions/broker/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1034,7 +1062,7 @@
<li class="md-nav__item">
- <a href="/reference/functions/broker/nats_broker/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/functions/broker/nats_broker/" class="md-nav__link">
Nats broker
</a>
</li>
@@ -1048,7 +1076,7 @@
<li class="md-nav__item">
- <a href="/reference/functions/broker/output_collector/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/functions/broker/output_collector/" class="md-nav__link">
Output collector
</a>
</li>
@@ -1106,7 +1134,7 @@
<li class="md-nav__item">
- <a href="/reference/functions/utils/async_iter_handler/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/functions/utils/async_iter_handler/" class="md-nav__link">
Async iter handler
</a>
</li>
@@ -1120,7 +1148,7 @@
<li class="md-nav__item">
- <a href="/reference/functions/utils/data_stream_context/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/functions/utils/data_stream_context/" class="md-nav__link">
Data stream context
</a>
</li>
@@ -1134,7 +1162,7 @@
<li class="md-nav__item">
- <a href="/reference/functions/utils/data_stream_generator/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/functions/utils/data_stream_generator/" class="md-nav__link">
Data stream generator
</a>
</li>
@@ -1148,7 +1176,7 @@
<li class="md-nav__item">
- <a href="/reference/functions/utils/function_context/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/functions/utils/function_context/" class="md-nav__link">
Function context
</a>
</li>
@@ -1211,7 +1239,7 @@
<li class="md-nav__item">
- <a href="/reference/model/common/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/model/common/" class="md-nav__link">
Common
</a>
</li>
@@ -1260,7 +1288,7 @@
<li class="md-nav__item">
- <a href="/reference/model/container/data_lake_measures/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/model/container/data_lake_measures/" class="md-nav__link">
Data lake measures
</a>
</li>
@@ -1274,7 +1302,7 @@
<li class="md-nav__item">
- <a href="/reference/model/container/data_streams/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/model/container/data_streams/" class="md-nav__link">
Data streams
</a>
</li>
@@ -1288,7 +1316,7 @@
<li class="md-nav__item">
- <a href="/reference/model/container/resource_container/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/model/container/resource_container/" class="md-nav__link">
Resource container
</a>
</li>
@@ -1348,7 +1376,7 @@
<li class="md-nav__item">
- <a href="/reference/model/resource/data_lake_measure/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/model/resource/data_lake_measure/" class="md-nav__link">
Data lake measure
</a>
</li>
@@ -1362,7 +1390,7 @@
<li class="md-nav__item">
- <a href="/reference/model/resource/data_lake_series/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/model/resource/data_lake_series/" class="md-nav__link">
Data lake series
</a>
</li>
@@ -1376,7 +1404,7 @@
<li class="md-nav__item">
- <a href="/reference/model/resource/data_stream/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/model/resource/data_stream/" class="md-nav__link">
Data stream
</a>
</li>
@@ -1390,7 +1418,7 @@
<li class="md-nav__item">
- <a href="/reference/model/resource/function_definition/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/model/resource/function_definition/" class="md-nav__link">
Function definition
</a>
</li>
@@ -1404,7 +1432,7 @@
<li class="md-nav__item">
- <a href="/reference/model/resource/resource/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/model/resource/resource/" class="md-nav__link">
Resource
</a>
</li>
@@ -1512,10 +1540,10 @@
<div class="md-dialog__inner md-typeset"></div>
</div>
- <script id="__config" type="application/json">{"base": "/", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.instant", "navigation.indexes", "navigation.tracking"], "search": "/assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching docu [...]
+ <script id="__config" type="application/json">{"base": "/docs/docs/python/latest/latest", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.instant", "navigation.indexes", "navigation.tracking"], "search": "/docs/docs/python/latest/latest/assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": " [...]
- <script src="/assets/javascripts/bundle.efa0ade1.min.js"></script>
+ <script src="/docs/docs/python/latest/latest/assets/javascripts/bundle.efa0ade1.min.js"></script>
</body>
diff --git a/docs/docs/python/dev/getting-started/developing/index.html b/docs/docs/python/dev/getting-started/developing/index.html
index 5c2eb9e8..8030668c 100644
--- a/docs/docs/python/dev/getting-started/developing/index.html
+++ b/docs/docs/python/dev/getting-started/developing/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/getting-started/developing/">
+
<link rel="prev" href="../first-steps/">
@@ -38,7 +44,7 @@
- <title>Developing & Contributing - Apache StreamPipes for Python</title>
+ <title>Developing & Contributing - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -251,7 +281,7 @@
<li class="md-tabs__item">
<a href="../first-steps/" class="md-tabs__link md-tabs__link--active">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -266,8 +296,8 @@
<li class="md-tabs__item">
- <a href="../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../reference/client/client/" class="md-tabs__link">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -388,14 +418,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -546,14 +576,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -563,7 +593,7 @@
<li class="md-nav__item">
- <a href="../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -577,7 +607,7 @@
<li class="md-nav__item">
- <a href="../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -591,7 +621,7 @@
<li class="md-nav__item">
- <a href="../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -605,7 +635,7 @@
<li class="md-nav__item">
- <a href="../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -649,14 +679,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1620,8 +1650,7 @@
-->
<h2 id="development-guide">📖 Development Guide<a class="headerlink" href="#development-guide" title="Permanent link">¶</a></h2>
-<p>This document describes how to easily set up your local dev environment to work on the
-StreamPipes Python client 🐍.
+<p>This document describes how to easily set up your local dev environment to work on StreamPipes Python 🐍.
<br></p>
<h3 id="first-steps">🚀 First Steps<a class="headerlink" href="#first-steps" title="Permanent link">¶</a></h3>
<p>1) <strong>Set up your Python environment</strong></p>
@@ -1637,19 +1666,20 @@ As a next step, install all required dependencies for the development, e.g., wit
<p>The pre-commit hook is run before every commit and takes care about code style,
linting, type hints, import sorting, etc. It will stop your commit in case the changes do not apply the expected format.
Always check to have the recent version of the pre-commit hook installed otherwise the CI build might fail.
-If you are interested you can have a deeper look on the underlying library: <a href="https://pre-commit.com/">pre-commit</a>.</p>
+If you are interested, you can have a deeper look on the underlying library: <a href="https://pre-commit.com/">pre-commit</a>.</p>
<p><div class="language-bash highlight"><pre><span></span><code>pre-commit<span class="w"> </span>install
</code></pre></div>
-The definition of the pre-commit hook can be found in <a href=".pre-commit-config.yaml">.pre-commit-config.yaml</a>.</p>
+The definition of the pre-commit hook can be found in <a href="https://github.com/apache/streampipes/blob/dev/streampipes-client-python/.pre-commit-config.yaml">.pre-commit-config.yaml</a>.</p>
<p><br></p>
<h3 id="conventions">👏 Conventions<a class="headerlink" href="#conventions" title="Permanent link">¶</a></h3>
-<p>Below we list some conventions that we have agreed on for creating the StreamPipes Python client.
+<p>Below we list some conventions that we have agreed on for creating StreamPipes Python.
Please comply to them when you plan to contribute to this project.
-If you have any other suggestions or would like to discuss them, we would be happy to hear from you on our mailing list <a href="mailto:dev@streampipes.apache.org">dev@streampipes.apache.org</a>.</p>
+If you have any other suggestions or would like to discuss them, we would be happy to hear from you on our mailing list <a href="mailto:dev@streampipes.apache.org">dev@streampipes.apache.org</a>
+or in our <a href="https://github.com/apache/streampipes/discussions">discussions</a> on GitHub.</p>
<p>1) <strong>Use <code>numpy</code> style for Python docstrings</strong> 📄 <br>
-Please stick to the <code>numpy</code> style when writing docstrings, as we require this for generating our documentation.</p>
+Please stick to the <code>numpy</code> <a href="https://numpydoc.readthedocs.io/en/latest/format.html">style</a> when writing docstrings, as we require this for generating our documentation.</p>
<p>2) <strong>Provide tests</strong> ✅ <br>
-We are aiming for broad test coverage for the Python client and
+We are aiming for broad test coverage for the Python package and
have therefore set a requirement of at least 90% unit test coverage.
Therefore, please remember to write (unit) tests already during development.
If you have problems with writing tests, don't hesitate to ask us for help directly in the PR or
@@ -1658,7 +1688,7 @@ even before that via our mailing list (see above).</p>
TODO: replace link to java file by link to documentation
--->
<p>3) <strong>Build a similar API as the Java client provides</strong> 🔄 <br>
-Whenever possible, please try to develop the API of the Python library the same as the <a href="../streampipes-client/src/main/java/org/apache/streampipes/client/StreamPipesClient.java">Java client</a> or Java SDK.
+Whenever possible, please try to develop the API of the Python library the same as the <a href="https://github.com/apache/streampipes/blob/dev/streampipes-client/src/main/java/org/apache/streampipes/client/StreamPipesClient.java">Java client</a> or Java SDK.
By doing so, we would like to provide a consistent developer experience and the basis for automated testing in the future.</p>
<hr />
<h2 id="roadmap">🚀 Roadmap<a class="headerlink" href="#roadmap" title="Permanent link">¶</a></h2>
diff --git a/docs/docs/python/dev/getting-started/first-steps/index.html b/docs/docs/python/dev/getting-started/first-steps/index.html
index f195eda8..f2902bf4 100644
--- a/docs/docs/python/dev/getting-started/first-steps/index.html
+++ b/docs/docs/python/dev/getting-started/first-steps/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/getting-started/first-steps/">
+
<link rel="prev" href="../..">
@@ -38,7 +44,7 @@
- <title>First Steps - Apache StreamPipes for Python</title>
+ <title>First Steps - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -251,7 +281,7 @@
<li class="md-tabs__item">
<a href="./" class="md-tabs__link md-tabs__link--active">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -266,8 +296,8 @@
<li class="md-tabs__item">
- <a href="../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../reference/client/client/" class="md-tabs__link">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -388,14 +418,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -532,14 +562,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -549,7 +579,7 @@
<li class="md-nav__item">
- <a href="../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -563,7 +593,7 @@
<li class="md-nav__item">
- <a href="../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -577,7 +607,7 @@
<li class="md-nav__item">
- <a href="../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -591,7 +621,7 @@
<li class="md-nav__item">
- <a href="../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -635,14 +665,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1595,6 +1625,7 @@
<p>The StreamPipes Python library is meant to work with Python 3.8 and above. Installation can be done via <code>pip</code>:
You can install the latest development version from GitHub, as so:</p>
<div class="language-bash highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>streampipes
+
<span class="c1"># if you want to have the current development state you can also execute</span>
pip<span class="w"> </span>install<span class="w"> </span>git+https://github.com/apache/streampipes.git#subdirectory<span class="o">=</span>streampipes-client-python
<span class="c1"># the corresponding documentation can be found here: https://streampipes.apache.org/docs/docs/python/dev/</span>
@@ -1603,12 +1634,8 @@ pip<span class="w"> </span>install<span class="w"> </span>git+https://github.com
<p>When working with the StreamPipes Python library it is inevitable to have a running StreamPipes instance to connect and interact with.
In case you don't have a running instance at hand, you can easily set up one on your local machine.
Hereby you need to consider that StreamPipes supports different message broker (e.g., Kafka, NATS).
-Although the Python library aims to support all of them equally, we encourage you to run StreamPipes with the NATS protocol as the messaging layer.
-If you are using a different messaging broker and experience a problem, please do not hesitate to contact us.
-In case you are unsure if it is indeed a bug, please feel free to start a <a href="https://github.com/apache/streampipes/discussions">discussion</a> on GitHub.
-Alternatively, file us a bug in form of a GitHub <a href="https://github.com/apache/streampipes/issues/new/choose">issue</a>.
-<br>
-The following shows how you can set up a StreamPipes instance that uses <a href="https://docs.nats.io/">NATS</a> as messaging layer.</p>
+We will demonstrate below how you can easily set up StreamPipes for both supported message brokers.
+<br></p>
<h3 id="start-streampipes-via-docker-compose">🐳 Start StreamPipes via Docker Compose<a class="headerlink" href="#start-streampipes-via-docker-compose" title="Permanent link">¶</a></h3>
<p>The easiest and therefore recommend way to get StreamPipes started is by using <a href="https://docs.docker.com/compose/">docker compose</a>.
Therefore, you need Docker running. You can check if Docker is ready on your machine by executing.
@@ -1618,16 +1645,26 @@ If this results in an output similar to the following, Docker is ready to contin
<div class="language-text highlight"><pre><span></span><code>CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
... ... ... ... ... ... ...
</code></pre></div>
-Otherwise, you need to start docker first.</p>
-<p>Please read the full guide on how to start StreamPipes with <code>docker compose</code> <a href="https://github.com/apache/streampipes/blob/dev/installer/compose/README.md">here</a>.
-So in our scenario, we will go with <code>docker-compose.nats.yml</code> to use NATS as messaging backend.
+Otherwise, you need to start docker first.
+Please read the full guide on how to start StreamPipes with <code>docker compose</code> <a href="https://streampipes.apache.org/docs/docs/deploy-docker.html">here</a>.</p>
+<h4 id="setup-streampipes-with-nats-as-message-broker">Setup StreamPipes with NATS as message broker<a class="headerlink" href="#setup-streampipes-with-nats-as-message-broker" title="Permanent link">¶</a></h4>
+<p>The following shows how you can set up a StreamPipes instance that uses <a href="https://docs.nats.io/">NATS</a> as messaging layer.
+So in this scenario, we will go with <code>docker-compose.nats.yml</code>.
Thereby, when running locally, we need to add the following port mapping entry to <code>services.nats.ports</code>:
<div class="language-yaml highlight"><pre><span></span><code><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4222:4222</span>
</code></pre></div></p>
<p>After this modification is applied, StreamPipes can simply be started with this command:
<div class="language-bash highlight"><pre><span></span><code>docker-compose<span class="w"> </span>-f<span class="w"> </span>docker-compose.nats.yml<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div></p>
-<p>Once all services are started, you can access StreamPipes via <code>http://localhost</code>.</p>
+<p>Once all services are started, you can access StreamPipes via <code>http://localhost</code>.</p>
+<h4 id="setup-streampipes-with-kafka-as-message-broker">Setup StreamPipes with Kafka as message broker<a class="headerlink" href="#setup-streampipes-with-kafka-as-message-broker" title="Permanent link">¶</a></h4>
+<p>Alternatively, you can use <code>docker-compose.yml</code> to start StreamPipes with Kafka as messaging layer.
+Therefore, you onyl need to execute the following command:
+<div class="language-bash highlight"><pre><span></span><code>docker-compose<span class="w"> </span>-f<span class="w"> </span>docker-compose.yml<span class="w"> </span>up<span class="w"> </span>-d
+</code></pre></div></p>
+<p>Once all services are started, you can access StreamPipes via <code>http://localhost</code>.</p>
+<p>In case you want to have more control over your StreamPipes setup,
+you might take a look at our <a href="https://streampipes.apache.org/docs/docs/extend-cli.html">deployment CLI</a>.</p>
<p>Have fun discovering StreamPipes and our Python library 🚀</p>
diff --git a/docs/docs/python/dev/getting-started/quickstart/index.html b/docs/docs/python/dev/getting-started/quickstart/index.html
index 8aa432c4..0f0ab6ab 100644
--- a/docs/docs/python/dev/getting-started/quickstart/index.html
+++ b/docs/docs/python/dev/getting-started/quickstart/index.html
@@ -25,20 +25,26 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/getting-started/quickstart/">
+
<link rel="prev" href="../developing/">
- <link rel="next" href="../../examples/1-introduction-to-streampipes-python-client/">
+ <link rel="next" href="../../tutorials/1-introduction-to-streampipes-python-client/">
<link rel="icon" href="https://streampipes.apache.org/img/favicon/favicon.png">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.3">
- <title>Quickstart - Apache StreamPipes for Python</title>
+ <title>Quickstart - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -251,7 +281,7 @@
<li class="md-tabs__item">
<a href="../first-steps/" class="md-tabs__link md-tabs__link--active">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -266,8 +296,8 @@
<li class="md-tabs__item">
- <a href="../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../reference/client/client/" class="md-tabs__link">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -388,14 +418,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -485,14 +515,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -502,7 +532,7 @@
<li class="md-nav__item">
- <a href="../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -516,7 +546,7 @@
<li class="md-nav__item">
- <a href="../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -530,7 +560,7 @@
<li class="md-nav__item">
- <a href="../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -544,7 +574,7 @@
<li class="md-nav__item">
- <a href="../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -588,14 +618,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1510,29 +1540,41 @@
-->
<h1 id="quickstart">⚡️ Quickstart<a class="headerlink" href="#quickstart" title="Permanent link">¶</a></h1>
-<p>As a quick example, we demonstrate how to set up and configure a StreamPipes client.</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</span> <span class="kn">import</span> <span class="n">StreamPipesClient</span>
-<span class="o">>>></span> <span class="kn">from</span> <span class="nn">streampipes.client.config</span> <span class="kn">import</span> <span class="n">StreamPipesClientConfig</span>
-<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>
-
-<span class="o">>>></span> <span class="n">config</span> <span class="o">=</span> <span class="n">StreamPipesClientConfig</span><span class="p">(</span>
-<span class="o">...</span> <span class="n">credential_provider</span> <span class="o">=</span> <span class="n">StreamPipesApiKeyCredentials</span><span class="p">(</span>
-<span class="o">...</span> <span class="n">username</span> <span class="o">=</span> <span class="s2">"test@streampipes.apache.org"</span><span class="p">,</span>
-<span class="o">...</span> <span class="n">api_key</span> <span class="o">=</span> <span class="s2">"DEMO-KEY"</span><span class="p">,</span>
-<span class="o">...</span> <span class="p">),</span>
-<span class="o">...</span> <span class="n">host_address</span> <span class="o">=</span> <span class="s2">"localhost"</span><span class="p">,</span>
-<span class="o">...</span> <span class="n">http_disabled</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
-<span class="o">...</span> <span class="n">port</span> <span class="o">=</span> <span class="mi">80</span>
-<span class="o">...</span><span class="p">)</span>
-
-<span class="o">>>></span> <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">config</span><span class="p">)</span>
-<span class="o">>>></span> <span class="n">client</span><span class="o">.</span><span class="n">describe</span><span class="p">()</span>
-
-<span class="n">Hi</span> <span class="n">there</span><span class="err">!</span>
-<span class="n">You</span> <span class="n">are</span> <span class="n">connected</span> <span class="n">to</span> <span class="n">a</span> <span class="n">StreamPipes</span> <span class="n">instance</span> <span class="n">running</span> <span class="n">at</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">localhost</span><span class="p">:</span> <span class="mf">80.</span>
-<span class="n">The</span> <span class="n">following</span> <span class="n">StreamPipes</span> <span class="n">resources</span> <span class="n">are</span> <span class="n">available</span> <span class="k">with</span> <span class="n">this</span> <span class="n">client</span><span class="p">:</span>
-<span class="mi">6</span><span class="n">x</span> <span class="n">DataStreams</span>
-<span class="mi">1</span><span class="n">x</span> <span class="n">DataLakeMeasures</span>
+<p>As a quick example, we demonstrate how to set up and configure a StreamPipes client.
+In addition, we will get the available data lake measures out of StreamPipes.</p>
+<p><div class="language-python highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">streampipes.client</span> <span class="kn">import</span> <span class="n">StreamPipesClient</span>
+<span class="kn">from</span> <span class="nn">streampipes.client.config</span> <span class="kn">import</span> <span class="n">StreamPipesClientConfig</span>
+<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">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="p">(</span>
+ <span class="n">username</span> <span class="o">=</span> <span class="s2">"test@streampipes.apache.org"</span><span class="p">,</span>
+ <span class="n">api_key</span> <span class="o">=</span> <span class="s2">"DEMO-KEY"</span><span class="p">,</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>
+
+<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">config</span><span class="p">)</span>
+
+<span class="c1"># get all available datat lake measures</span>
+<span class="n">measures</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">dataLakeMeasureApi</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
+
+<span class="c1"># get amount of retrieved measures</span>
+<span class="nb">len</span><span class="p">(</span><span class="n">measures</span><span class="p">)</span>
+</code></pre></div>
+Output:
+<div class="language-text highlight"><pre><span></span><code>1
+</code></pre></div>
+<br></p>
+<div class="language-text highlight"><pre><span></span><code># inspect the data lake measures as pandas dataframe
+measures.to_pandas()
+</code></pre></div>
+<p>Output:
+<div class="language-text highlight"><pre><span></span><code>measure_name timestamp_field ... pipeline_is_running num_event_properties
+0 test s0::timestamp ... False 2
+[1 rows x 6 columns]
</code></pre></div>
<br>
Alternatively, you can provide your credentials via environment variables.
diff --git a/docs/docs/python/dev/img/streampipes-python-dark.png b/docs/docs/python/dev/img/streampipes-python-dark.png
new file mode 100644
index 00000000..72725724
Binary files /dev/null and b/docs/docs/python/dev/img/streampipes-python-dark.png differ
diff --git a/docs/docs/python/dev/index.html b/docs/docs/python/dev/index.html
index 7145ceeb..c72e7974 100644
--- a/docs/docs/python/dev/index.html
+++ b/docs/docs/python/dev/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/">
+
<link rel="next" href="getting-started/first-steps/">
@@ -36,7 +42,7 @@
- <title>Apache StreamPipes for Python</title>
+ <title>Apache StreamPipes Python</title>
@@ -111,6 +117,8 @@
+
+
@@ -118,6 +126,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -144,7 +154,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -156,19 +166,39 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
- Home
+ 🏡 Home
</span>
</div>
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -212,7 +242,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="." class="md-tabs__link md-tabs__link--active">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -286,7 +316,7 @@
<li class="md-tabs__item">
<a href="reference/client/client/" class="md-tabs__link">
- Reference
+ 📚 Reference
</a>
</li>
@@ -321,12 +351,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -336,7 +366,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -359,12 +389,12 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
- Home
+ 🏡 Home
<span class="md-nav__icon md-icon"></span>
</label>
<a href="." class="md-nav__link md-nav__link--active">
- Home
+ 🏡 Home
</a>
@@ -421,14 +451,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -508,14 +538,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -525,7 +555,7 @@
<li class="md-nav__item">
- <a href="examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -539,7 +569,7 @@
<li class="md-nav__item">
- <a href="examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -553,7 +583,7 @@
<li class="md-nav__item">
- <a href="examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -567,7 +597,7 @@
<li class="md-nav__item">
- <a href="examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -611,14 +641,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1527,6 +1557,8 @@
+ <h1>🏡 Home</h1>
+
<!--
~ Licensed to the Apache Software Foundation (ASF) under one or more
~ contributor license agreements. See the NOTICE file distributed with
@@ -1545,19 +1577,15 @@
~
-->
-<h1 align="center">
- <br>
- <img src="https://raw.githubusercontent.com/apache/streampipes/dev/streampipes-client-python/docs/img/streampipes-python.png"
- alt="StreamPipes Logo with Python" title="Apache StreamPipes Logo with Python" width="75%"/>
- <br>
-</h1>
-<h4 align="center"><a href="[StreamPipes](https://github.com/apache/streampipes)">StreamPipes</a> is a self-service (Industrial) IoT toolbox to enable non-technical users to connect , analyze and explore IoT data streams.</h4>
+<p><img alt="StreamPipes Logo with Python" src="img/streampipes-python.png#only-light" />
+<img alt="StreamPipes Logo with Python" src="img/streampipes-python-dark.png#only-dark" /></p>
+<h4 align="center"><a href="https://github.com/apache/streampipes">StreamPipes</a> is a self-service (Industrial) IoT toolbox to enable non-technical users to connect, analyze and explore IoT data streams.</h4>
<p><br></p>
-<h3 align="center">Apache StreamPipes for Python</h3>
+<h3 align="center">Apache StreamPipes for Python 🐍</h3>
<p align="center"> Apache StreamPipes meets Python! We are working highly motivated on a Python library to interact with StreamPipes.
-In this way, we would like to unite the power of StreamPipes to easily connect to and read different data sources, especially in the IoT domain,
+In this way, we would like to unite the power of StreamPipes to easily connect to and read from different data sources, especially in the IoT domain,
and the amazing universe of data analytics libraries in Python. </p>
<hr />
@@ -1566,11 +1594,6 @@ and the amazing universe of data analytics libraries in Python. </p>
This means that it is still heavily under development, which may result in frequent and extensive API changes, unstable behavior, etc.</b>
</p>
<hr />
-<p><strong>🚧 Currently, we do not already version our Python documentation.
-Therefore, the provided docs always represent the development state.
-Please read our <a href="getting-started/first-steps/">getting started guide</a> to find out how to install the development version of StreamPipes python.
-We will provide a versioned documentation as soon as possible. Stay tuned!</strong></p>
-<hr />
<h2 id="quickstart">⚡️ Quickstart<a class="headerlink" href="#quickstart" title="Permanent link">¶</a></h2>
<p>As a quick example, we demonstrate how to set up and configure a StreamPipes client.
In addition, we will get the available data lake measures out of StreamPipes.</p>
@@ -1584,7 +1607,7 @@ In addition, we will get the available data lake measures out of StreamPipes.</p
<span class="n">api_key</span> <span class="o">=</span> <span class="s2">"DEMO-KEY"</span><span class="p">,</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">http_disabled</span> <span class="o">=</span> <span class="kc">True</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>
@@ -1611,14 +1634,14 @@ 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>
</code></pre></div>
<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>
-<p><img alt="Howto API Key" src="https://raw.githubusercontent.com/apache/streampipes/dev/streampipes-client-python/docs/img/how-to-get-api-key.gif" /></p>
+<p><img alt="Howto API Key" src="/img/how-to-get-api-key.gif" /></p>
diff --git a/docs/docs/python/dev/objects.inv b/docs/docs/python/dev/objects.inv
index 2be7e3c0..b3c97391 100644
Binary files a/docs/docs/python/dev/objects.inv and b/docs/docs/python/dev/objects.inv differ
diff --git a/docs/docs/python/dev/reference/client/client/index.html b/docs/docs/python/dev/reference/client/client/index.html
index afc01b7a..a3ec1ddc 100644
--- a/docs/docs/python/dev/reference/client/client/index.html
+++ b/docs/docs/python/dev/reference/client/client/index.html
@@ -25,10 +25,16 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
- <link rel="prev" href="../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/">
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/client/client/">
+
+
+ <link rel="prev" href="../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/">
<link rel="next" href="../config/">
@@ -38,7 +44,7 @@
- <title>Client - Apache StreamPipes for Python</title>
+ <title>Client - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="./" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1651,13 +1681,13 @@ provides all functionalities to communicate with the API.</p>
<div class="doc doc-contents ">
- <p>The client to connect to StreamPipes.
-This is the central point of contact with StreamPipes and
+ <p>The client to connect to StreamPipes.</p>
+<p>This is the central point of contact with StreamPipes and
provides all the functionalities to interact with it.</p>
<p>The client provides so-called "endpoints" each of which refers to
an endpoint of the StreamPipes API, e.g. <code>.dataLakeMeasureApi</code>.
-An endpoint provides the actual methods to interact with StreamPipes
-API (see endpoint.endpoint.APIEndpoint).</p>
+An <a class="autorefs autorefs-internal" href="../../endpoint/endpoint/#streampipes.endpoint.endpoint">endpoint</a> provides the actual methods to interact with StreamPipes
+API.</p>
<table>
<thead>
@@ -1682,7 +1712,7 @@ API (see endpoint.endpoint.APIEndpoint).</p>
<tr>
<td><code>logging_level</code></td>
<td class="doc-param-details">
- <p>Influences the log messages emitted by the <code>StreamPipesClient</code>.</p>
+ <p>Influences the log messages emitted by the <code>StreamPipesClient</code></p>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1698,37 +1728,72 @@ API (see endpoint.endpoint.APIEndpoint).</p>
</tbody>
</table>
+ <table>
+ <thead>
+ <tr>
+ <th><b>ATTRIBUTE</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>dataLakeMeasureApi</code></td>
+ <td class="doc-attribute-details">
+ <p>Instance of the data lake measure endpoint</p>
+ <p>
+ <span class="doc-attribute-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.endpoint.api.DataLakeMeasureEndpoint" href="../../endpoint/api/data_lake_measure/#streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint">DataLakeMeasureEndpoint</a></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>dataStreamApi</code></td>
+ <td class="doc-attribute-details">
+ <p>Instance of the data stream endpoint</p>
+ <p>
+ <span class="doc-attribute-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.endpoint.api.DataStreamEndpoint" href="../../endpoint/api/data_stream/#streampipes.endpoint.api.data_stream.DataStreamEndpoint">DataStreamEndpoint</a></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
<p><strong>Examples:</strong></p>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">streampipes.client</span> <span class="kn">import</span> <span class="n">StreamPipesClient</span>
-<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">streampipes.client.config</span> <span class="kn">import</span> <span class="n">StreamPipesClientConfig</span>
-<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">streampipes.client.credential_provider</span> <span class="kn">import</span> <span class="n">StreamPipesApiKeyCredentials</span>
-</code></pre></div>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">client_config</span> <span class="o">=</span> <span class="n">StreamPipesClientConfig</span><span class="p">(</span>
-<span class="gp">... </span> <span class="n">credential_provider</span><span class="o">=</span><span class="n">StreamPipesApiKeyCredentials</span><span class="p">(</span>
-<span class="gp">... </span> <span class="n">username</span><span class="o">=</span><span class="s2">"test-user"</span><span class="p">,</span>
-<span class="gp">... </span> <span class="n">api_key</span><span class="o">=</span><span class="s2">"api-key"</span>
-<span class="gp">... </span> <span class="p">),</span>
-<span class="gp">... </span> <span class="n">host_address</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span>
-<span class="gp">... </span> <span class="n">https_disabled</span><span class="o">=</span><span class="kc">True</span>
-<span class="gp">... </span><span class="p">)</span>
-</code></pre></div>
- <p>The following way of instantiating a client instance is
-intended to be consistent with the StreamPipes Java client.</p>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">client</span> <span class="o">=</span> <span class="n">StreamPipesClient</span><span class="o">.</span><span class="n">create</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>
-</code></pre></div>
- <p>If you prefer a more pythonic way, you can simply write:</p>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><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>
+ <div class="language-python highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">streampipes.client</span> <span class="kn">import</span> <span class="n">StreamPipesClient</span>
+<span class="kn">from</span> <span class="nn">streampipes.client.config</span> <span class="kn">import</span> <span class="n">StreamPipesClientConfig</span>
+<span class="kn">from</span> <span class="nn">streampipes.client.credential_provider</span> <span class="kn">import</span> <span class="n">StreamPipesApiKeyCredentials</span>
</code></pre></div>
- <p>To interact with an endpoint:</p>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">data_lake_measures</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">dataLakeMeasureApi</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
-</code></pre></div>
- <p>To inspect returned data as a pandas dataframe:</p>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">data_lake_measures</span><span class="o">.</span><span class="n">to_pandas</span><span class="p">()</span>
-<span class="go">#</span>
-<span class="go"># measure_name timestamp_field ... pipeline_is_running num_event_properties</span>
-<span class="go"># 0 test s0::timestamp ... False 2</span>
-<span class="go"># [1 rows x 6 columns]</span>
+<div class="language-python highlight"><pre><span></span><code><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="p">(</span>
+ <span class="n">username</span><span class="o">=</span><span class="s2">"test-user"</span><span class="p">,</span>
+ <span class="n">api_key</span><span class="o">=</span><span class="s2">"api-key"</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>
</code></pre></div>
+<p>The following way of instantiating a client instance is
+intended to be consistent with the StreamPipes Java client.
+<div class="language-python highlight"><pre><span></span><code><span class="n">client</span> <span class="o">=</span> <span class="n">StreamPipesClient</span><span class="o">.</span><span class="n">create</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>
+</code></pre></div></p>
+<p>If you prefer a more pythonic way, you can simply write:
+<div class="language-python highlight"><pre><span></span><code><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>
+</code></pre></div></p>
+<p>To interact with an endpoint:
+<div class="language-python highlight"><pre><span></span><code><span class="n">data_lake_measures</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">dataLakeMeasureApi</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
+</code></pre></div></p>
+<p>To inspect returned data as a pandas dataframe:
+<div class="language-python highlight"><pre><span></span><code><span class="n">data_lake_measures</span><span class="o">.</span><span class="n">to_pandas</span><span class="p">()</span>
+<span class="c1">#</span>
+<span class="c1"># measure_name timestamp_field ... pipeline_is_running num_event_properties</span>
+<span class="c1"># 0 test s0::timestamp ... False 2</span>
+<span class="c1"># [1 rows x 6 columns]</span>
+</code></pre></div></p>
@@ -1770,12 +1835,16 @@ intended to be consistent with the StreamPipes Java client.</p>
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>str of the basic API URL</code>
- </span>
+ <code>base_api_path</code>
</td>
<td class="doc-returns-details">
-
+ <p>basic API path of the connected StreamPipes instance</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code>str</code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
@@ -1800,8 +1869,8 @@ intended to be consistent with the StreamPipes Java client.</p>
<div class="doc doc-contents ">
- <p>Returns the HTTP headers required for all requests.
-The HTTP headers are composed of the authentication headers supplied by the credential
+ <p>Returns the HTTP headers used for all requests.</p>
+<p>The HTTP headers are composed of the authentication headers supplied by the credential
provider and additional required headers (currently this is only the application header).</p>
<table>
@@ -1814,12 +1883,16 @@ provider and additional required headers (currently this is only the application
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>Dictionary with header information as string key-value pairs.</code>
- </span>
+ <code>http_headers</code>
</td>
<td class="doc-returns-details">
-
+ <p>header information for HTTP requests as string key-value pairs.</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Dict">Dict</span>[str, str]</code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
@@ -1846,8 +1919,8 @@ provider and additional required headers (currently this is only the application
<div class="doc doc-contents ">
- <p>Returns an instance of the <code>StreamPipesPythonClient</code>.
-Provides consistency to the Java client.</p>
+ <p>Returns an instance of the <code>StreamPipesPythonClient</code>.</p>
+<p>Provides consistency to the StreamPipes Java client.</p>
<table>
<thead>
@@ -1925,7 +1998,7 @@ Provides consistency to the Java client.</p>
<div class="doc doc-contents ">
- <p>Prints short description of the connected StreamPipes instance and the available resources to the console.</p>
+ <p>Prints a short description of the connected StreamPipes instance and the available resources to the console.</p>
<table>
<thead>
@@ -1948,6 +2021,17 @@ Provides consistency to the Java client.</p>
</tbody>
</table>
+<p><strong>Examples:</strong></p>
+ <p><div class="language-python highlight"><pre><span></span><code><span class="n">client</span><span class="o">.</span><span class="n">describe</span><span class="p">()</span>
+</code></pre></div>
+Output:
+<div class="language-text highlight"><pre><span></span><code>Hi there!
+You are connected to a StreamPipes instance running at http://localhost:80.
+The following StreamPipes resources are available with this client:
+6x DataStreams
+1x DataLakeMeasures
+</code></pre></div></p>
+
</div>
</div>
diff --git a/docs/docs/python/dev/reference/client/config/index.html b/docs/docs/python/dev/reference/client/config/index.html
index 54daf714..a33effdd 100644
--- a/docs/docs/python/dev/reference/client/config/index.html
+++ b/docs/docs/python/dev/reference/client/config/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/client/config/">
+
<link rel="prev" href="../client/">
@@ -38,7 +44,7 @@
- <title>Config - Apache StreamPipes for Python</title>
+ <title>Config - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1555,7 +1585,7 @@
<a id="streampipes.client.config"></a>
<div class="doc doc-contents first">
- <p>Implementation of a config class for the StreamPipes client.</p>
+ <p>Configuration class for the StreamPipes client.</p>
@@ -1586,8 +1616,8 @@
<div class="doc doc-contents ">
- <p>Configure the StreamPipes client in accordance to the actual StreamPipes instance to connect to.
-An instance is provided to the <code>StreamPipesClient</code> to configure it properly.</p>
+ <p>Configure the StreamPipes client in accordance to the actual StreamPipes instance to connect to.</p>
+<p>An instance is provided to the <code>StreamPipesClient</code> to configure it properly.</p>
<table>
<thead>
@@ -1641,7 +1671,8 @@ Should be provided without the protocol/scheme, e.g. as <code>localhost</code> o
<tr>
<td><code>port</code></td>
<td class="doc-param-details">
- <p>Specifies the port under which the StreamPipes API is available, e.g., <code>80</code> (with http) or <code>443</code> (with https)</p>
+ <p>Specifies the port under which the StreamPipes API is available,
+e.g., <code>80</code> (with http) or <code>443</code> (with https)</p>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1658,7 +1689,7 @@ Should be provided without the protocol/scheme, e.g. as <code>localhost</code> o
</table>
<p><strong>Examples:</strong></p>
- <p>see <code>StreamPipesClient</code></p>
+ <p>see <a class="autorefs autorefs-internal" href="../client/#streampipes.client.client.StreamPipesClient">StreamPipesClient</a></p>
diff --git a/docs/docs/python/dev/reference/client/credential_provider/index.html b/docs/docs/python/dev/reference/client/credential_provider/index.html
index 8ee1a4c4..e85437d7 100644
--- a/docs/docs/python/dev/reference/client/credential_provider/index.html
+++ b/docs/docs/python/dev/reference/client/credential_provider/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/client/credential_provider/">
+
<link rel="prev" href="../config/">
@@ -38,7 +44,7 @@
- <title>Credential provider - Apache StreamPipes for Python</title>
+ <title>Credential provider - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1681,8 +1711,8 @@ Must be inherited by all credential providers.</p>
<div class="doc doc-contents ">
- <p>Creates the HTTP headers for the specific credential provider.
-Concrete authentication headers must be defined in the implementation of a credential provider.</p>
+ <p>Creates the HTTP headers for the specific credential provider.</p>
+<p>Concrete authentication headers must be defined in the implementation of a credential provider.</p>
<table>
<thead>
@@ -1721,12 +1751,18 @@ Concrete authentication headers must be defined in the implementation of a crede
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>Dictionary with header information as string key-value pairs.</code>
- </span>
+ <code>https_headers</code>
</td>
<td class="doc-returns-details">
-
+ <p>Dictionary with header information as string key-value pairs. <br>
+Contains all pairs given as parameter plus the header pairs for authentication
+determined by the credential provider.</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Dict">Dict</span>[str, str]</code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
@@ -1759,8 +1795,8 @@ Concrete authentication headers must be defined in the implementation of a crede
Bases: <code><a class="autorefs autorefs-internal" title="streampipes.client.credential_provider.CredentialProvider" href="#streampipes.client.credential_provider.CredentialProvider">CredentialProvider</a></code></p>
- <p>A Credential provider that allows authentication via a StreamPipes API Token.
-This token can be generated via the StreamPipes UI (see how in the project's README).</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>
<table>
<thead>
@@ -1798,16 +1834,7 @@ This token can be generated via the StreamPipes UI (see how in the project's REA
</table>
<p><strong>Examples:</strong></p>
- <p>see <code>StreamPipesClient</code></p>
- <h4 id="streampipes.client.credential_provider.StreamPipesApiKeyCredentials--references">References<a class="headerlink" href="#streampipes.client.credential_provider.StreamPipesApiKeyCredentials--references" title="Permanent link">¶</a></h4>
-<div class="footnote">
-<hr />
-<ol>
-<li id="streampipes.client.credential_provider.StreamPipesApiKeyCredentials--fn:1">
-<p><a href="https://streampipes.apache.org/docs/docs/python/latest/">StreamPipes Python Client README</a> <a class="footnote-backref" href="#streampipes.client.credential_provider.StreamPipesApiKeyCredentials--fnref:1" title="Jump back to footnote 1 in the text">↩</a></p>
-</li>
-</ol>
-</div>
+ <p>see <a class="autorefs autorefs-internal" href="../client/#streampipes.client.client.StreamPipesClient">StreamPipesClient</a></p>
diff --git a/docs/docs/python/dev/reference/endpoint/api/data_lake_measure/index.html b/docs/docs/python/dev/reference/endpoint/api/data_lake_measure/index.html
index 7c0fb449..c940b541 100644
--- a/docs/docs/python/dev/reference/endpoint/api/data_lake_measure/index.html
+++ b/docs/docs/python/dev/reference/endpoint/api/data_lake_measure/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/api/data_lake_measure/">
+
<link rel="prev" href="../../exceptions/">
@@ -38,7 +44,7 @@
- <title>Data lake measure - Apache StreamPipes for Python</title>
+ <title>Data lake measure - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1652,7 +1682,7 @@
<div class="doc doc-contents first">
<p>Specific implementation of the StreamPipes API's data lake measure endpoints.
-This endpoint allows to consume data stored in StreamPipes' data lake</p>
+This endpoint allows to consume data stored in StreamPipes' data lake.</p>
@@ -1684,79 +1714,66 @@ This endpoint allows to consume data stored in StreamPipes' data lake</p>
<p>Implementation of the DataLakeMeasure endpoint.</p>
<p>This endpoint provides an interfact to all data stored in the StreamPipes data lake.</p>
<p>Consequently, it allows uerying metadata about available data sets (see <code>all()</code> method).
-The metadata is returned as an instance of <code>model.container.DataLakeMeasures</code>.</p>
+The metadata is returned as an instance of <a class="autorefs autorefs-internal" href="../../../model/container/data_lake_measures/#streampipes.model.container.data_lake_measures.DataLakeMeasures"><code>DataLakeMeasures</code></a>.</p>
<p>In addition, the endpoint provides direct access to the data stored in the data laka by querying a
specific data lake measure using the <code>get()</code> method.</p>
- <table>
- <thead>
- <tr>
- <th><b>PARAMETER</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>parent_client</code></td>
- <td class="doc-param-details">
- <p>The instance of <code>client.StreamPipesClient</code> the endpoint is attached to.</p>
- <p>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
-
<p><strong>Examples:</strong></p>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">streampipes.client</span> <span class="kn">import</span> <span class="n">StreamPipesClient</span>
-<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">streampipes.client.config</span> <span class="kn">import</span> <span class="n">StreamPipesClientConfig</span>
-<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">streampipes.client.credential_provider</span> <span class="kn">import</span> <span class="n">StreamPipesApiKeyCredentials</span>
-</code></pre></div>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">client_config</span> <span class="o">=</span> <span class="n">StreamPipesClientConfig</span><span class="p">(</span>
-<span class="gp">... </span> <span class="n">credential_provider</span><span class="o">=</span><span class="n">StreamPipesApiKeyCredentials</span><span class="p">(</span><span class="n">username</span><span class="o">=</span><span class="s2">"test-user"</span><span class="p">,</span> <span class="n">api_key</span><span class="o">=</span><span class="s2">"api-key"</span><span class="p">),</span>
-<span class="gp">... </span> <span class="n">host_address</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span>
-<span class="gp">... </span> <span class="n">port</span><span class="o">=</span><span class="mi">8082</span><span class="p">,</span>
-<span class="gp">... </span> <span class="n">https_disabled</span><span class="o">=</span><span class="kc">True</span>
-<span class="gp">... </span><span class="p">)</span>
+ <div class="language-python highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">streampipes.client</span> <span class="kn">import</span> <span class="n">StreamPipesClient</span>
+<span class="kn">from</span> <span class="nn">streampipes.client.config</span> <span class="kn">import</span> <span class="n">StreamPipesClientConfig</span>
+<span class="kn">from</span> <span class="nn">streampipes.client.credential_provider</span> <span class="kn">import</span> <span class="n">StreamPipesApiKeyCredentials</span>
</code></pre></div>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">client</span> <span class="o">=</span> <span class="n">StreamPipesClient</span><span class="o">.</span><span class="n">create</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>
+<div class="language-python highlight"><pre><span></span><code><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="p">(</span><span class="n">username</span><span class="o">=</span><span class="s2">"test-user"</span><span class="p">,</span> <span class="n">api_key</span><span class="o">=</span><span class="s2">"api-key"</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">8082</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">client</span> <span class="o">=</span> <span class="n">StreamPipesClient</span><span class="o">.</span><span class="n">create</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>
</code></pre></div>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">data_lake_measures</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">dataLakeMeasureApi</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
-</code></pre></div>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">data_lake_measures</span><span class="p">)</span>
-<span class="go">5</span>
+<p><div class="language-text highlight"><pre><span></span><code># get all existing data lake measures from StreamPipes
+data_lake_measures = client.dataLakeMeasureApi.all()
+
+# let's take a look how many we got
+len(data_lake_measures)
</code></pre></div>
- <p>Retrieve a specific data lake measure as a pandas DataFrame</p>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">flow_rate_pd</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">dataLakeMeasureApi</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">identifier</span><span class="o">=</span><span class="s2">"flow-rate"</span><span class="p">)</span><span class="o">.</span><span class="n">to_pandas [...]
-<span class="gp">>>> </span><span class="n">flow_rate_pd</span>
-<span class="go"> time density mass_flow sensorId sensor_fault_flags temperature volume_flow</span>
-<span class="go">0 2023-02-24T16:19:41.472Z 50.872730 3.309556 flowrate02 False 44.448483 5.793138</span>
-<span class="go">1 2023-02-24T16:19:41.482Z 47.186588 5.608580 flowrate02 False 40.322033 0.058015</span>
-<span class="go">2 2023-02-24T16:19:41.493Z 46.735321 7.692881 flowrate02 False 49.239639 10.283526</span>
-<span class="go">3 2023-02-24T16:19:41.503Z 40.169796 3.632898 flowrate02 False 49.933754 6.893441</span>
-<span class="go">4 2023-02-24T16:19:41.513Z 49.635124 0.711260 flowrate02 False 50.106617 2.999871</span>
-<span class="go">.. ... ... ... ... ... ... ...</span>
-<span class="go">995 2023-02-24T16:19:52.927Z 50.057495 1.740114 flowrate02 False 46.558231 1.818237</span>
-<span class="go">996 2023-02-24T16:19:52.94Z 41.038895 7.211723 flowrate02 False 48.048622 2.127493</span>
-<span class="go">997 2023-02-24T16:19:52.952Z 45.837013 7.770180 flowrate02 False 48.188026 7.892062</span>
-<span class="go">998 2023-02-24T16:19:52.965Z 43.389065 4.458602 flowrate02 False 48.280899 5.733892</span>
-<span class="go">999 2023-02-24T16:19:52.977Z 44.056030 2.592060 flowrate02 False 47.505951 4.260697</span>
+<div class="language-text highlight"><pre><span></span><code>5
+</code></pre></div></p>
+<p><div class="language-python highlight"><pre><span></span><code><span class="c1"># Retrieve a specific data lake measure as a pandas DataFrame</span>
+<span class="n">flow_rate_pd</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">dataLakeMeasureApi</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">identifier</span><span class="o">=</span><span class="s2">"flow-rate"</span><span class="p">)</span><span class="o">.</span><span class="n">to_pandas</span><span class="p">()</span>
+<span class="n">flow_rate_pd</span>
</code></pre></div>
- <p>As you can see, the returned amount of rows per default is <code>1000</code>.
-We can modify this behavior by passing the <code>limit</code> paramter.</p>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">flow_rate_pd</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">dataLakeMeasureApi</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">identifier</span><span class="o">=</span><span class="s2">"flow-rate"</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</s [...]
-<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">flow_rate_pd</span><span class="p">)</span>
+<div class="language-text highlight"><pre><span></span><code> time density mass_flow sensorId sensor_fault_flags temperature volume_flow
+0 2023-02-24T16:19:41.472Z 50.872730 3.309556 flowrate02 False 44.448483 5.793138
+1 2023-02-24T16:19:41.482Z 47.186588 5.608580 flowrate02 False 40.322033 0.058015
+2 2023-02-24T16:19:41.493Z 46.735321 7.692881 flowrate02 False 49.239639 10.283526
+3 2023-02-24T16:19:41.503Z 40.169796 3.632898 flowrate02 False 49.933754 6.893441
+4 2023-02-24T16:19:41.513Z 49.635124 0.711260 flowrate02 False 50.106617 2.999871
+.. ... ... ... ... ... ... ...
+995 2023-02-24T16:19:52.927Z 50.057495 1.740114 flowrate02 False 46.558231 1.818237
+996 2023-02-24T16:19:52.94Z 41.038895 7.211723 flowrate02 False 48.048622 2.127493
+997 2023-02-24T16:19:52.952Z 45.837013 7.770180 flowrate02 False 48.188026 7.892062
+998 2023-02-24T16:19:52.965Z 43.389065 4.458602 flowrate02 False 48.280899 5.733892
+999 2023-02-24T16:19:52.977Z 44.056030 2.592060 flowrate02 False 47.505951 4.260697
+</code></pre></div></p>
+<p>As you can see, the returned amount of rows per default is <code>1000</code>.
+We can modify this behavior by passing the <code>limit</code> paramter.
+<div class="language-python highlight"><pre><span></span><code><span class="n">flow_rate_pd</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">dataLakeMeasureApi</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">identifier</span><span class="o">=</span><span class="s2">"flow-rate"</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="mi">10</ [...]
+<span class="nb">len</span><span class="p">(</span><span class="n">flow_rate_pd</span><span class="p">)</span>
</code></pre></div>
- <p>If we are only interested in the values for <code>density</code>,
-<code>columns</code> allows us to select the columns to be returned:</p>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">flow_rate_pd</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">dataLakeMeasureApi</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">identifier</span><span class="o">=</span><span class="s2">"flow-rate"</span><span class="p">,</span> <span class="n">columns</span><span class="o">=< [...]
-<span class="gp">>>> </span><span class="n">flow_rate_pd</span>
-<span class="go"> time density</span>
-<span class="go">0 2023-02-24T16:19:41.472Z 50.872730</span>
-<span class="go">1 2023-02-24T16:19:41.482Z 47.186588</span>
-<span class="go">2 2023-02-24T16:19:41.493Z 46.735321</span>
+<div class="language-text highlight"><pre><span></span><code>10
+</code></pre></div></p>
+<p>If we are only interested in the values for <code>density</code>,
+<code>columns</code> allows us to select the columns to be returned:
+<div class="language-python highlight"><pre><span></span><code><span class="n">flow_rate_pd</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">dataLakeMeasureApi</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">identifier</span><span class="o">=</span><span class="s2">"flow-rate"</span><span class="p">,</span> <span class="n">columns</span><span class="o">=</span><span class="s1">&# [...]
+<span class="n">flow_rate_pd</span>
</code></pre></div>
- <p>This is only a subset of the available query parameters,
+<div class="language-text highlight"><pre><span></span><code> time density
+0 2023-02-24T16:19:41.472Z 50.872730
+1 2023-02-24T16:19:41.482Z 47.186588
+2 2023-02-24T16:19:41.493Z 46.735321
+</code></pre></div></p>
+<p>This is only a subset of the available query parameters,
find them at <a class="autorefs autorefs-internal" href="#streampipes.endpoint.api.data_lake_measure.MeasurementGetQueryConfig">MeasurementGetQueryConfig</a>.</p>
@@ -1787,7 +1804,7 @@ find them at <a class="autorefs autorefs-internal" href="#streampipes.endpoint.a
<p>Queries the specified data lake measure from the API.</p>
<p>By default, the maximum number of returned records is 1000.
-This behaviour can be influences by passing the parameter <code>limit</code> with a different value
+This behaviour can be influenced by passing the parameter <code>limit</code> with a different value
(see <a class="autorefs autorefs-internal" href="#streampipes.endpoint.api.data_lake_measure.MeasurementGetQueryConfig">MeasurementGetQueryConfig</a>).</p>
<table>
@@ -1887,10 +1904,11 @@ The available query parameters are defined by the
Bases: <code><span title="pydantic.BaseModel">BaseModel</span></code></p>
- <p>Config class describing the parameters of the GET endpoint for measurements.</p>
+ <p>Config class describing the parameters of the <code>get()</code> method for measurements.</p>
<p>This config class is used to validate the provided query parameters for the GET endpoint of measurements.
Additionally, it takes care of the conversion to a proper HTTP query string.
-Thereby, parameter names are adapted to the naming of the StreamPipes API, for which Pydantic aliases are used.</p>
+Thereby, parameter names are adapted to the naming of the StreamPipes API,
+for which <a href="https://docs.pydantic.dev/usage/model_config/#options">Pydantic aliases</a> are used.</p>
<table>
<thead>
diff --git a/docs/docs/python/dev/reference/endpoint/api/data_stream/index.html b/docs/docs/python/dev/reference/endpoint/api/data_stream/index.html
index 249b7683..2fffc82b 100644
--- a/docs/docs/python/dev/reference/endpoint/api/data_stream/index.html
+++ b/docs/docs/python/dev/reference/endpoint/api/data_stream/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/api/data_stream/">
+
<link rel="prev" href="../data_lake_measure/">
@@ -38,7 +44,7 @@
- <title>Data stream - Apache StreamPipes for Python</title>
+ <title>Data stream - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1588,46 +1618,27 @@
<p>Implementation of the DataStream endpoint.</p>
<p>Consequently, it allows querying metadata about available data streams (see <code>all()</code> method).
-The metadata is returned as an instance of <code>model.container.DataStreams</code>.</p>
-
- <table>
- <thead>
- <tr>
- <th><b>PARAMETER</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>parent_client</code></td>
- <td class="doc-param-details">
- <p>The instance of <code>client.StreamPipesClient</code> the endpoint is attached to.</p>
- <p>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
+The metadata is returned as an instance of <a class="autorefs autorefs-internal" href="../../../model/container/data_streams/#streampipes.model.container.data_streams.DataStreams"><code>DataStreams</code></a>.</p>
<p><strong>Examples:</strong></p>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">streampipes.client</span> <span class="kn">import</span> <span class="n">StreamPipesClient</span>
-<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">streampipes.client.config</span> <span class="kn">import</span> <span class="n">StreamPipesClientConfig</span>
-<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">streampipes.client.credential_provider</span> <span class="kn">import</span> <span class="n">StreamPipesApiKeyCredentials</span>
-</code></pre></div>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">client_config</span> <span class="o">=</span> <span class="n">StreamPipesClientConfig</span><span class="p">(</span>
-<span class="gp">... </span> <span class="n">credential_provider</span><span class="o">=</span><span class="n">StreamPipesApiKeyCredentials</span><span class="p">(</span><span class="n">username</span><span class="o">=</span><span class="s2">"test-user"</span><span class="p">,</span> <span class="n">api_key</span><span class="o">=</span><span class="s2">"api-key"</span><span class="p">),</span>
-<span class="gp">... </span> <span class="n">host_address</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span>
-<span class="gp">... </span> <span class="n">port</span><span class="o">=</span><span class="mi">8082</span><span class="p">,</span>
-<span class="gp">... </span> <span class="n">https_disabled</span><span class="o">=</span><span class="kc">True</span>
-<span class="gp">... </span><span class="p">)</span>
-</code></pre></div>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">client</span> <span class="o">=</span> <span class="n">StreamPipesClient</span><span class="o">.</span><span class="n">create</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>
-</code></pre></div>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">data_streams</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">DataStreamEndpoint</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
+ <div class="language-python highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">streampipes.client</span> <span class="kn">import</span> <span class="n">StreamPipesClient</span>
+<span class="kn">from</span> <span class="nn">streampipes.client.config</span> <span class="kn">import</span> <span class="n">StreamPipesClientConfig</span>
+<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">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="p">(</span><span class="n">username</span><span class="o">=</span><span class="s2">"test-user"</span><span class="p">,</span> <span class="n">api_key</span><span class="o">=</span><span class="s2">"api-key"</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">8082</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">client</span> <span class="o">=</span> <span class="n">StreamPipesClient</span><span class="o">.</span><span class="n">create</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>
</code></pre></div>
- <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">data_streams</span><span class="p">)</span>
-<span class="go">2</span>
+<p><div class="language-python highlight"><pre><span></span><code><span class="c1"># let's get all existing data streams in StreamPipes</span>
+<span class="n">data_streams</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">dataStreamApi</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
+<span class="nb">len</span><span class="p">(</span><span class="n">data_streams</span><span class="p">)</span>
</code></pre></div>
+<div class="language-text highlight"><pre><span></span><code>2
+</code></pre></div></p>
diff --git a/docs/docs/python/dev/reference/endpoint/endpoint/index.html b/docs/docs/python/dev/reference/endpoint/endpoint/index.html
index 3cd0e8e4..d9db13ca 100644
--- a/docs/docs/python/dev/reference/endpoint/endpoint/index.html
+++ b/docs/docs/python/dev/reference/endpoint/endpoint/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/endpoint/">
+
<link rel="prev" href="../../client/credential_provider/">
@@ -38,7 +44,7 @@
- <title>Endpoint - Apache StreamPipes for Python</title>
+ <title>Endpoint - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1693,7 +1723,7 @@
<p>General implementation for an endpoint.
Provided classes and assets are aimed to be used for developing endpoints.
-An endpoint is provides all options to communicate with a central endpoint of the StreamPipes API in a handy way.</p>
+An endpoint provides all options to communicate with ad dedicated part of StreamPipes in a handy way.</p>
@@ -1723,28 +1753,9 @@ An endpoint is provides all options to communicate with a central endpoint of th
<p>Abstract implementation of an API endpoint.</p>
-<p>Serves as template for all endpoints for the StreamPipes API.
+<p>Serves as template for all endpoints of the StreamPipes API.
By design, endpoints are only instantiated within the <code>__init__</code> method of the StreamPipesClient.</p>
- <table>
- <thead>
- <tr>
- <th><b>PARAMETER</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>parent_client</code></td>
- <td class="doc-param-details">
- <p>This parameter expects the instance of the <code>client.StreamPipesClient</code> the endpoint is attached to.</p>
- <p>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
-
@@ -1771,8 +1782,8 @@ By design, endpoints are only instantiated within the <code>__init__</code> meth
<div class="doc doc-contents ">
- <p>Get all resources of this endpoint provided by the StreamPipes API.
-Results are provided as an instance of a <code>model.container.ResourceContainer</code> that
+ <p>Get all resources of this endpoint provided by the StreamPipes API.</p>
+<p>Results are provided as an instance of a <code>ResourceContainer</code> that
allows to handle the returned resources in a comfortable and pythonic way.</p>
<table>
@@ -1785,12 +1796,16 @@ allows to handle the returned resources in a comfortable and pythonic way.</p>
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>A model container instance (</code>
- </span>
+ <code>container</code>
</td>
<td class="doc-returns-details">
-
+ <p>container element that bundles the returned resources</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.container.resource_container.ResourceContainer" href="../../model/container/resource_container/#streampipes.model.container.resource_container.ResourceContainer">ResourceContainer</a></code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
@@ -1812,7 +1827,7 @@ allows to handle the returned resources in a comfortable and pythonic way.</p>
<div class="doc doc-contents ">
- <p>Creates the URL of the API path for the endpoint.</p>
+ <p>Builds the endpoint's URL of the API path.</p>
<table>
<thead>
@@ -1824,12 +1839,16 @@ allows to handle the returned resources in a comfortable and pythonic way.</p>
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>The URL of the Endpoint</code>
- </span>
+ <code>url</code>
</td>
<td class="doc-returns-details">
-
+ <p>The URL of the endpoint</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code>str</code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
@@ -1886,12 +1905,16 @@ allows to handle the returned resources in a comfortable and pythonic way.</p>
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>The specified resource as an instance of the corresponding model class (</code>
- </span>
+ <code>resource</code>
</td>
<td class="doc-returns-details">
-
+ <p>The specified resource as an instance of the corresponding model class.</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.resource.Resource" href="../../model/resource/resource/#streampipes.model.resource.resource.Resource">Resource</a></code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
@@ -1913,7 +1936,7 @@ allows to handle the returned resources in a comfortable and pythonic way.</p>
<div class="doc doc-contents ">
- <p>Post a resource to the StreamPipes API.</p>
+ <p>Allows to post a resource to the StreamPipes API.</p>
<table>
<thead>
@@ -1986,7 +2009,7 @@ allows to handle the returned resources in a comfortable and pythonic way.</p>
Bases: <code><span title="abc.ABC">ABC</span></code></p>
- <p>Abstract implementation of an StreamPipes endpoint.</p>
+ <p>Abstract implementation of a StreamPipes endpoint.</p>
<p>Serves as template for all endpoints used for interaction with a StreamPipes instance.
By design, endpoints are only instantiated within the <code>__init__</code> method of the StreamPipesClient.</p>
@@ -2001,7 +2024,7 @@ By design, endpoints are only instantiated within the <code>__init__</code> meth
<tr>
<td><code>parent_client</code></td>
<td class="doc-param-details">
- <p>This parameter expects the instance of the <code>client.StreamPipesClient</code> the endpoint is attached to.</p>
+ <p>This parameter expects the instance of <code>StreamPipesClient</code> the endpoint is attached to.</p>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -2050,34 +2073,11 @@ By design, endpoints are only instantiated within the <code>__init__</code> meth
Bases: <code><a class="autorefs autorefs-internal" title="streampipes.endpoint.endpoint.Endpoint" href="#streampipes.endpoint.endpoint.Endpoint">Endpoint</a></code></p>
- <p>Abstract implementation of a StreamPipes messaging endpoint.
-Serves as template for all endpoints used for interacting with the StreamPipes messaging layer directly.
+ <p>Abstract implementation of a StreamPipes messaging endpoint.</p>
+<p>Serves as template for all endpoints used for interacting with the StreamPipes messaging layer directly.
Therefore, they need to provide the functionality to talk with the broker system running in StreamPipes.
By design, endpoints are only instantiated within the <code>__init__</code> method of the StreamPipesClient.</p>
- <table>
- <thead>
- <tr>
- <th><b>PARAMETER</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>parent_client</code></td>
- <td class="doc-param-details">
- <p>This parameter expects the instance of the <code>client.StreamPipesClient</code> the endpoint is attached to.</p>
- <p>
- <span class="doc-param-annotation">
- <b>TYPE:</b>
- <code>StreamPipesClient</code>
- </span>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
-
@@ -2098,8 +2098,8 @@ By design, endpoints are only instantiated within the <code>__init__</code> meth
<code class="highlight language-python"><span class="n">broker</span><span class="p">:</span> <span class="n">Broker</span></code>
<span class="doc doc-labels">
- <small class="doc doc-label doc-label-writable"><code>writable</code></small>
<small class="doc doc-label doc-label-property"><code>property</code></small>
+ <small class="doc doc-label doc-label-writable"><code>writable</code></small>
</span>
<a href="#streampipes.endpoint.endpoint.MessagingEndpoint.broker" class="headerlink" title="Permanent link">¶</a></h3>
@@ -2142,22 +2142,16 @@ to consume messages from and to write messages to the broker.</p>
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>The broker instance to be used to communicate with</code>
- </span>
+ <code>broker</code>
</td>
<td class="doc-returns-details">
-
- </td>
- </tr>
- <tr>
- <td>
- <span class="doc-returns-annotation">
- <code>StreamPipes' messaging layer.</code>
- </span>
- </td>
- <td class="doc-returns-details">
-
+ <p>The broker instance to be used to communicate with StreamPipes' messaging layer.</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.functions.broker.broker.Broker" href="../../functions/broker/broker/#streampipes.functions.broker.broker.Broker">Broker</a></code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
@@ -2183,9 +2177,50 @@ to consume messages from and to write messages to the broker.</p>
<p>Configures the message endpoint by setting the broker instance to be used.</p>
<p>This configuration step is required before the endpoint can be actually used.
The based <code>broker</code> instance is passed to an internal property</p>
-<p>Returns</p>
-<hr />
-<p>None</p>
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>broker</code></td>
+ <td class="doc-param-details">
+ <p>Broker instance that should be used for this endpoint</p>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.functions.broker.broker.Broker" href="../../functions/broker/broker/#streampipes.functions.broker.broker.Broker">Broker</a></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <span class="doc-returns-annotation">
+ <code>None</code>
+ </span>
+ </td>
+ <td class="doc-returns-details">
+
+ </td>
+ </tr>
+ </tbody>
+ </table>
</div>
diff --git a/docs/docs/python/dev/reference/endpoint/exceptions/index.html b/docs/docs/python/dev/reference/endpoint/exceptions/index.html
index c6d0153f..d4835fd2 100644
--- a/docs/docs/python/dev/reference/endpoint/exceptions/index.html
+++ b/docs/docs/python/dev/reference/endpoint/exceptions/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/exceptions/">
+
<link rel="prev" href="../endpoint/">
@@ -38,7 +44,7 @@
- <title>Exceptions - Apache StreamPipes for Python</title>
+ <title>Exceptions - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
diff --git a/docs/docs/python/dev/reference/function_zoo/river_function/index.html b/docs/docs/python/dev/reference/function_zoo/river_function/index.html
index 87c0324c..3e5d5e66 100644
--- a/docs/docs/python/dev/reference/function_zoo/river_function/index.html
+++ b/docs/docs/python/dev/reference/function_zoo/river_function/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/function_zoo/river_function/">
+
<link rel="prev" href="../../endpoint/api/data_stream/">
@@ -38,7 +44,7 @@
- <title>River function - Apache StreamPipes for Python</title>
+ <title>River function - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1717,7 +1747,7 @@
<p>Wrapper class to enable an easy usage for Online Machine Learning models of the River library.</p>
<p>It creates a StreamPipesFunction to train a model with the incoming events of a data stream and
-creates an output data stream to publishes the prediction to StreamPipes.</p>
+creates an output data stream that publishes the prediction to StreamPipes.</p>
<table>
<thead>
@@ -1949,7 +1979,7 @@ Is only needed when you continue to work with the prediction in StreamPipes.</p>
<div class="doc doc-contents ">
- <p>Stops the function and ends the training for ever.</p>
+ <p>Stops the function and ends the training forever.</p>
</div>
@@ -1979,7 +2009,7 @@ Is only needed when you continue to work with the prediction in StreamPipes.</p>
<p>Implementation of a StreamPipesFunction to enable an easy usage
-for Online Machine Learning models of the River library.</p>
+for Online Machine Learning models of the <a href="https://riverml.xyz/">River library</a>.</p>
<p>The function trains the model with the incoming events and publishes the prediction to an output data stream.</p>
<table>
@@ -2118,6 +2148,62 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
<p>Trains the model with the incoming events and sends the prediction back to StreamPipes.</p>
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>event</code></td>
+ <td class="doc-param-details">
+ <p>The incoming event that serves as input for the function</p>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>streamId</code></td>
+ <td class="doc-param-details">
+ <p>Identifier of the corresponding data stream</p>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code>str</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <span class="doc-returns-annotation">
+ <code>None</code>
+ </span>
+ </td>
+ <td class="doc-returns-details">
+
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
</div>
</div>
@@ -2134,7 +2220,51 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
<div class="doc doc-contents ">
- <p>Executes the <code>on_start</code> function.</p>
+ <p>Executes the <code>on_start</code> method of the function.</p>
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>context</code></td>
+ <td class="doc-param-details">
+ <p>The functions' context</p>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.functions.utils.function_context.FunctionContext" href="../../functions/utils/function_context/#streampipes.functions.utils.function_context.FunctionContext">FunctionContext</a></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <span class="doc-returns-annotation">
+ <code>None</code>
+ </span>
+ </td>
+ <td class="doc-returns-details">
+
+ </td>
+ </tr>
+ </tbody>
+ </table>
</div>
@@ -2170,7 +2300,32 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
<div class="doc doc-contents ">
- <p>Returns the the stream ids.</p>
+ <p>Returns the stream ids required by this function.</p>
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>stream_ids</code>
+ </td>
+ <td class="doc-returns-details">
+ <p>List of stream ids required by the function</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.List">List</span>[str]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
</div>
diff --git a/docs/docs/python/dev/reference/functions/broker/broker/index.html b/docs/docs/python/dev/reference/functions/broker/broker/index.html
index ff039f89..6d5f808a 100644
--- a/docs/docs/python/dev/reference/functions/broker/broker/index.html
+++ b/docs/docs/python/dev/reference/functions/broker/broker/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/broker/">
+
<link rel="prev" href="../../streampipes_function/">
@@ -38,7 +44,7 @@
- <title>Broker - Apache StreamPipes for Python</title>
+ <title>Broker - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1666,8 +1696,8 @@
Bases: <code><span title="abc.ABC">ABC</span></code></p>
- <p>Abstract implementation of a broker.
-A broker is used to subscribe to a data stream and to consume the published events.</p>
+ <p>Abstract implementation of a broker.</p>
+<p>A broker allows both to subscribe to a data stream and to publish events to a data stream.</p>
@@ -1699,9 +1729,30 @@ A broker is used to subscribe to a data stream and to consume the published even
<div class="doc doc-contents ">
- <p>Connects the broker to a server.</p>
- <p>host_address: str
- The host address of the server, which the broker connects to.</p>
+ <p>Connects to the broker running in StreamPipes.</p>
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>data_stream</code></td>
+ <td class="doc-param-details">
+ <p>Contains the meta information (resources) for a data stream.</p>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.data_stream.DataStream" href="../../../model/resource/data_stream/#streampipes.model.resource.data_stream.DataStream">DataStream</a></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
<table>
<thead>
@@ -1736,8 +1787,8 @@ A broker is used to subscribe to a data stream and to consume the published even
<code class="highlight language-python"><span class="n">createSubscription</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.createSubscription" class="headerlink" title="Permanent link">¶</a></h3>
@@ -1780,8 +1831,8 @@ A broker is used to subscribe to a data stream and to consume the published even
<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>
@@ -1844,12 +1895,16 @@ A broker is used to subscribe to a data stream and to consume the published even
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>An async iterator for the messages.</code>
- </span>
+ <code>iterator</code>
</td>
<td class="doc-returns-details">
-
+ <p>An async iterator for the messages.</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.AsyncIterator">AsyncIterator</span></code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
@@ -1867,8 +1922,8 @@ A broker is used to subscribe to a data stream and to consume the published even
<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.broker.Broker.publish_event" class="headerlink" title="Permanent link">¶</a></h3>
@@ -1878,6 +1933,29 @@ A broker is used to subscribe to a data stream and to consume the published even
<p>Publish an event to a connected data stream.</p>
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>event</code></td>
+ <td class="doc-param-details">
+ <p>The event to be published.</p>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
<table>
<thead>
<tr>
diff --git a/docs/docs/python/dev/reference/functions/broker/broker_handler/index.html b/docs/docs/python/dev/reference/functions/broker/broker_handler/index.html
index d2da7df8..e9d13d6e 100644
--- a/docs/docs/python/dev/reference/functions/broker/broker_handler/index.html
+++ b/docs/docs/python/dev/reference/functions/broker/broker_handler/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/broker_handler/">
+
<link rel="prev" href="../broker/">
@@ -38,7 +44,7 @@
- <title>Broker handler - Apache StreamPipes for Python</title>
+ <title>Broker handler - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1053,8 +1083,8 @@
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker_handler.UnsupportedBroker" class="md-nav__link">
- UnsupportedBroker
+ <a href="#streampipes.functions.broker.broker_handler.UnsupportedBrokerError" class="md-nav__link">
+ UnsupportedBrokerError
</a>
</li>
@@ -1546,8 +1576,8 @@
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker_handler.UnsupportedBroker" class="md-nav__link">
- UnsupportedBroker
+ <a href="#streampipes.functions.broker.broker_handler.UnsupportedBrokerError" class="md-nav__link">
+ UnsupportedBrokerError
</a>
</li>
@@ -1640,10 +1670,10 @@
-<h2 id="streampipes.functions.broker.broker_handler.UnsupportedBroker" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">UnsupportedBroker</span><span class="p">(</span><span class="n">message</span><span class="p">)</span></code>
+<h2 id="streampipes.functions.broker.broker_handler.UnsupportedBrokerError" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">UnsupportedBrokerError</span><span class="p">(</span><span class="n">message</span><span class="p">)</span></code>
-<a href="#streampipes.functions.broker.broker_handler.UnsupportedBroker" class="headerlink" title="Permanent link">¶</a></h2>
+<a href="#streampipes.functions.broker.broker_handler.UnsupportedBrokerError" class="headerlink" title="Permanent link">¶</a></h2>
<div class="doc doc-contents ">
@@ -1688,7 +1718,7 @@
<div class="doc doc-contents ">
- <p>Get a broker by a name.</p>
+ <p>Derive the broker for the given data stream.</p>
<table>
<thead>
@@ -1699,10 +1729,14 @@
</thead>
<tbody>
<tr>
- <td><code>broker_name</code></td>
+ <td><code>data_stream</code></td>
<td class="doc-param-details">
- <p>A string that represents a broker.</p>
+ <p>Data stream instance from which the broker is inferred</p>
<p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.data_stream.DataStream" href="../../../model/resource/data_stream/#streampipes.model.resource.data_stream.DataStream">DataStream</a></code>
+ </span>
</p>
</td>
</tr>
@@ -1719,12 +1753,37 @@
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>The broker which belongs to the name.</code>
- </span>
+ <code>broker</code>
</td>
<td class="doc-returns-details">
-
+ <p>The corresponding broker instance derived from data stream.</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.functions.broker.Broker" href="../broker/#streampipes.functions.broker.broker.Broker">Broker</a></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RAISES</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <span class="doc-raises-annotation">
+ <code><a class="autorefs autorefs-internal" title="streampipes.functions.broker.broker_handler.UnsupportedBrokerError" href="#streampipes.functions.broker.broker_handler.UnsupportedBrokerError">UnsupportedBrokerError</a></code>
+ </span>
+ </td>
+ <td class="doc-raises-details">
+ <p>Is raised when the given data stream belongs to a broker that is currently not supported by StreamPipes Python.</p>
</td>
</tr>
</tbody>
diff --git a/docs/docs/python/dev/reference/functions/broker/kafka_broker/index.html b/docs/docs/python/dev/reference/functions/broker/kafka_broker/index.html
index 50cf1998..956e5a45 100644
--- a/docs/docs/python/dev/reference/functions/broker/kafka_broker/index.html
+++ b/docs/docs/python/dev/reference/functions/broker/kafka_broker/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/kafka_broker/">
+
<link rel="prev" href="../broker_handler/">
@@ -38,7 +44,7 @@
- <title>Kafka broker - Apache StreamPipes for Python</title>
+ <title>Kafka broker - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1652,7 +1682,7 @@
Bases: <code><a class="autorefs autorefs-internal" title="streampipes.functions.broker.broker.Broker" href="../broker/#streampipes.functions.broker.broker.Broker">Broker</a></code></p>
- <p>Implementation of the NatsBroker</p>
+ <p>Implementation of the broker for Kafka</p>
@@ -1778,12 +1808,16 @@
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>An async iterator for the messages.</code>
- </span>
+ <code>iterator</code>
</td>
<td class="doc-returns-details">
-
+ <p>An async iterator for the messages.</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.AsyncIterator">AsyncIterator</span></code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
@@ -1811,6 +1845,29 @@
<p>Publish an event to a connected data stream.</p>
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>event</code></td>
+ <td class="doc-param-details">
+ <p>The event to be published.</p>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
<table>
<thead>
<tr>
diff --git a/docs/docs/python/dev/reference/functions/broker/kafka_message_fetcher/index.html b/docs/docs/python/dev/reference/functions/broker/kafka_message_fetcher/index.html
index 94aabf8f..58c756a6 100644
--- a/docs/docs/python/dev/reference/functions/broker/kafka_message_fetcher/index.html
+++ b/docs/docs/python/dev/reference/functions/broker/kafka_message_fetcher/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/kafka_message_fetcher/">
+
<link rel="prev" href="../kafka_broker/">
@@ -38,7 +44,7 @@
- <title>Kafka message fetcher - Apache StreamPipes for Python</title>
+ <title>Kafka message fetcher - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1074,15 +1104,15 @@
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.kafka_message_fetcher.KafkaMessageFetcher" class="md-nav__link">
- KafkaMessageFetcher
+ <a href="#streampipes.functions.broker.kafka_message_fetcher.KafkaMessage" class="md-nav__link">
+ KafkaMessage
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.kafka_message_fetcher.KafkaMsg" class="md-nav__link">
- KafkaMsg
+ <a href="#streampipes.functions.broker.kafka_message_fetcher.KafkaMessageFetcher" class="md-nav__link">
+ KafkaMessageFetcher
</a>
</li>
@@ -1532,15 +1562,15 @@
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.kafka_message_fetcher.KafkaMessageFetcher" class="md-nav__link">
- KafkaMessageFetcher
+ <a href="#streampipes.functions.broker.kafka_message_fetcher.KafkaMessage" class="md-nav__link">
+ KafkaMessage
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.kafka_message_fetcher.KafkaMsg" class="md-nav__link">
- KafkaMsg
+ <a href="#streampipes.functions.broker.kafka_message_fetcher.KafkaMessageFetcher" class="md-nav__link">
+ KafkaMessageFetcher
</a>
</li>
@@ -1586,16 +1616,16 @@
-<h2 id="streampipes.functions.broker.kafka_message_fetcher.KafkaMessageFetcher" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">KafkaMessageFetcher</span><span class="p">(</span><span class="n">consumer</span><span class="p">)</span></code>
+<h2 id="streampipes.functions.broker.kafka_message_fetcher.KafkaMessage" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">KafkaMessage</span><span class="p">(</span><span class="n">data</span><span class="p">)</span></code>
-<a href="#streampipes.functions.broker.kafka_message_fetcher.KafkaMessageFetcher" class="headerlink" title="Permanent link">¶</a></h2>
+<a href="#streampipes.functions.broker.kafka_message_fetcher.KafkaMessage" class="headerlink" title="Permanent link">¶</a></h2>
<div class="doc doc-contents ">
- <p>Fetches the next message from Kafka</p>
+ <p>An internal representation of a Kafka message</p>
<table>
<thead>
@@ -1606,14 +1636,10 @@
</thead>
<tbody>
<tr>
- <td><code>consumer</code></td>
+ <td><code>data</code></td>
<td class="doc-param-details">
- <p>The Kafka consumer</p>
+ <p>The received Kafka message as byte array</p>
<p>
- <span class="doc-param-annotation">
- <b>TYPE:</b>
- <code><span title="confluent_kafka.Consumer">Consumer</span></code>
- </span>
</p>
</td>
</tr>
@@ -1646,16 +1672,16 @@
-<h2 id="streampipes.functions.broker.kafka_message_fetcher.KafkaMsg" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">KafkaMsg</span><span class="p">(</span><span class="n">data</span><span class="p">)</span></code>
+<h2 id="streampipes.functions.broker.kafka_message_fetcher.KafkaMessageFetcher" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">KafkaMessageFetcher</span><span class="p">(</span><span class="n">consumer</span><span class="p">)</span></code>
-<a href="#streampipes.functions.broker.kafka_message_fetcher.KafkaMsg" class="headerlink" title="Permanent link">¶</a></h2>
+<a href="#streampipes.functions.broker.kafka_message_fetcher.KafkaMessageFetcher" class="headerlink" title="Permanent link">¶</a></h2>
<div class="doc doc-contents ">
- <p>An internal representation of a Kafka message</p>
+ <p>Fetches the next message from Kafka</p>
<table>
<thead>
@@ -1666,10 +1692,14 @@
</thead>
<tbody>
<tr>
- <td><code>data</code></td>
+ <td><code>consumer</code></td>
<td class="doc-param-details">
- <p>The received Kafka message as byte array</p>
+ <p>The Kafka consumer</p>
<p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><span title="confluent_kafka.Consumer">Consumer</span></code>
+ </span>
</p>
</td>
</tr>
diff --git a/docs/docs/python/dev/reference/functions/broker/nats_broker/index.html b/docs/docs/python/dev/reference/functions/broker/nats_broker/index.html
index fea7a140..510c939e 100644
--- a/docs/docs/python/dev/reference/functions/broker/nats_broker/index.html
+++ b/docs/docs/python/dev/reference/functions/broker/nats_broker/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/nats_broker/">
+
<link rel="prev" href="../kafka_message_fetcher/">
@@ -38,7 +44,7 @@
- <title>Nats broker - Apache StreamPipes for Python</title>
+ <title>Nats broker - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1778,12 +1808,16 @@
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>An async iterator for the messages.</code>
- </span>
+ <code>message_iterator</code>
</td>
<td class="doc-returns-details">
-
+ <p>An async iterator for the messages.</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.AsyncIterator">AsyncIterator</span></code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
@@ -1811,6 +1845,29 @@
<p>Publish an event to a connected data stream.</p>
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>event</code></td>
+ <td class="doc-param-details">
+ <p>The event to be published.</p>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
<table>
<thead>
<tr>
diff --git a/docs/docs/python/dev/reference/functions/broker/output_collector/index.html b/docs/docs/python/dev/reference/functions/broker/output_collector/index.html
index 16d38e65..2d440f93 100644
--- a/docs/docs/python/dev/reference/functions/broker/output_collector/index.html
+++ b/docs/docs/python/dev/reference/functions/broker/output_collector/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/output_collector/">
+
<link rel="prev" href="../nats_broker/">
@@ -38,7 +44,7 @@
- <title>Output collector - Apache StreamPipes for Python</title>
+ <title>Output collector - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1621,8 +1651,54 @@
<div class="doc doc-contents ">
- <p>Collector for output events.The events are published to an output data stream.
-Therefore the output collector establishes a connection to the broker.</p>
+ <p>Collector for output events. The events are published to an output data stream.
+Therefore, the output collector establishes a connection to the broker.</p>
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>data_stream</code></td>
+ <td class="doc-param-details">
+ <p>The output data stream that will receive the events.</p>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.data_stream.DataStream" href="../../../model/resource/data_stream/#streampipes.model.resource.data_stream.DataStream">DataStream</a></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>ATTRIBUTE</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>broker</code></td>
+ <td class="doc-attribute-details">
+ <p>The broker instance that sends the data to StreamPipes</p>
+ <p>
+ <span class="doc-attribute-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.functions.broker.broker.Broker" href="../broker/#streampipes.functions.broker.broker.Broker">Broker</a></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
@@ -1675,6 +1751,27 @@ Therefore the output collector establishes a connection to the broker.</p>
</tbody>
</table>
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <span class="doc-returns-annotation">
+ <code>None</code>
+ </span>
+ </td>
+ <td class="doc-returns-details">
+
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
</div>
</div>
@@ -1693,6 +1790,27 @@ Therefore the output collector establishes a connection to the broker.</p>
<p>Disconnects the broker of the output collector.</p>
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <span class="doc-returns-annotation">
+ <code>None</code>
+ </span>
+ </td>
+ <td class="doc-returns-details">
+
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
</div>
</div>
diff --git a/docs/docs/python/dev/reference/functions/function_handler/index.html b/docs/docs/python/dev/reference/functions/function_handler/index.html
index 7d8e9390..5b6fdc1b 100644
--- a/docs/docs/python/dev/reference/functions/function_handler/index.html
+++ b/docs/docs/python/dev/reference/functions/function_handler/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/function_handler/">
+
<link rel="prev" href="../../function_zoo/river_function/">
@@ -38,7 +44,7 @@
- <title>Function handler - Apache StreamPipes for Python</title>
+ <title>Function handler - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1633,8 +1663,8 @@
<div class="doc doc-contents ">
- <p>The function handler manages the StreamPipesFunctions.
-It controls the connection to the brokers, starts the functions, manages the broadcast of the live data
+ <p>The function handler manages the StreamPipes Functions.</p>
+<p>It controls the connection to the brokers, starts the functions, manages the broadcast of the live data
and is able to stop the connection to the brokers and functions.</p>
<table>
@@ -1672,6 +1702,41 @@ and is able to stop the connection to the brokers and functions.</p>
</tbody>
</table>
+ <table>
+ <thead>
+ <tr>
+ <th><b>ATTRIBUTE</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>stream_contexts</code></td>
+ <td class="doc-attribute-details">
+ <p>Map of all data stream contexts</p>
+ <p>
+ <span class="doc-attribute-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Dict">Dict</span>[str, <a class="autorefs autorefs-internal" title="streampipes.functions.utils.data_stream_context.DataStreamContext" href="../utils/data_stream_context/#streampipes.functions.utils.data_stream_context.DataStreamContext">DataStreamContext</a>]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>brokers</code></td>
+ <td class="doc-attribute-details">
+ <p>List of all registered brokers</p>
+ <p>
+ <span class="doc-attribute-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.List">List</span>[<a class="autorefs autorefs-internal" title="streampipes.functions.broker.Broker" href="../broker/broker/#streampipes.functions.broker.broker.Broker">Broker</a>]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
@@ -1698,7 +1763,7 @@ and is able to stop the connection to the brokers and functions.</p>
<div class="doc doc-contents ">
- <p>Disconnects from the brokers and stops the functions.</p>
+ <p>Disconnects from the brokers and stops all functions.</p>
<table>
<thead>
@@ -1763,18 +1828,18 @@ and is able to stop the connection to the brokers and functions.</p>
<table>
<thead>
<tr>
- <th><b>RAISES</b></th>
+ <th><b>WARNS</b></th>
<th><b>DESCRIPTION</b></th>
</tr>
</thead>
<tbody>
<tr>
<td>
- <span class="doc-raises-annotation">
+ <span class="doc-warns-annotation">
<code>UserWarning</code>
</span>
</td>
- <td class="doc-raises-details">
+ <td class="doc-warns-details">
<p>If there is a running event loop and the functions should be stopped by disconnecting from the broker.</p>
</td>
</tr>
@@ -1797,7 +1862,7 @@ and is able to stop the connection to the brokers and functions.</p>
<div class="doc doc-contents ">
- <p>Creates the context for every data stream and starts the event loop to manage the StreamPipesFunctions.</p>
+ <p>Creates the context for every data stream and starts the event loop to manage the StreamPipes Functions.</p>
<table>
<thead>
diff --git a/docs/docs/python/dev/reference/functions/registration/index.html b/docs/docs/python/dev/reference/functions/registration/index.html
index aadf4fc9..3625da86 100644
--- a/docs/docs/python/dev/reference/functions/registration/index.html
+++ b/docs/docs/python/dev/reference/functions/registration/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/registration/">
+
<link rel="prev" href="../function_handler/">
@@ -38,7 +44,7 @@
- <title>Registration - Apache StreamPipes for Python</title>
+ <title>Registration - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1621,6 +1651,29 @@
<p>Manages the existing StreamPipesFunctions and registers them.</p>
+ <table>
+ <thead>
+ <tr>
+ <th><b>ATTRIBUTE</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>functions</code></td>
+ <td class="doc-attribute-details">
+ <p>List of all registered StreamPipesFunction</p>
+ <p>
+ <span class="doc-attribute-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.List">List</span>[<a class="autorefs autorefs-internal" title="streampipes.functions.streampipes_function.StreamPipesFunction" href="../streampipes_function/#streampipes.functions.streampipes_function.StreamPipesFunction">StreamPipesFunction</a>]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
@@ -1648,6 +1701,7 @@
<div class="doc doc-contents ">
<p>Get all registered functions.</p>
+<p>This method exists to be consistent with the Java client.</p>
<table>
<thead>
@@ -1659,12 +1713,16 @@
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>List of the functions.</code>
- </span>
+ <code>functions</code>
</td>
<td class="doc-returns-details">
-
+ <p>List of all registered functions.</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.List">List</span>[<a class="autorefs autorefs-internal" title="streampipes.functions.streampipes_function.StreamPipesFunction" href="../streampipes_function/#streampipes.functions.streampipes_function.StreamPipesFunction">StreamPipesFunction</a>]</code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
@@ -1721,12 +1779,16 @@
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code><a class="autorefs autorefs-internal" title="streampipes.functions.registration.Registration" href="#streampipes.functions.registration.Registration">Registration</a></code>
- </span>
+ <code>self</code>
</td>
<td class="doc-returns-details">
-
+ <p>The updated Registration instance</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.functions.registration.Registration" href="#streampipes.functions.registration.Registration">Registration</a></code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
diff --git a/docs/docs/python/dev/reference/functions/streampipes_function/index.html b/docs/docs/python/dev/reference/functions/streampipes_function/index.html
index 4d7597c7..421198ff 100644
--- a/docs/docs/python/dev/reference/functions/streampipes_function/index.html
+++ b/docs/docs/python/dev/reference/functions/streampipes_function/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/streampipes_function/">
+
<link rel="prev" href="../registration/">
@@ -38,7 +44,7 @@
- <title>Streampipes function - Apache StreamPipes for Python</title>
+ <title>Streampipes function - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1723,6 +1753,29 @@ data analytics libraries there.</p>
</tbody>
</table>
+ <table>
+ <thead>
+ <tr>
+ <th><b>ATTRIBUTE</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>output_collectors</code></td>
+ <td class="doc-attribute-details">
+ <p>List of all output collectors which are created based on the provided function definitions.</p>
+ <p>
+ <span class="doc-attribute-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Dict">Dict</span>[str, <a class="autorefs autorefs-internal" title="streampipes.functions.broker.output_collector.OutputCollector" href="../broker/output_collector/#streampipes.functions.broker.output_collector.OutputCollector">OutputCollector</a>]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
@@ -1774,7 +1827,7 @@ data analytics libraries there.</p>
<tr>
<td><code>event</code></td>
<td class="doc-param-details">
- <p>The event which should be sended</p>
+ <p>The event which should be sent</p>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1786,6 +1839,27 @@ data analytics libraries there.</p>
</tbody>
</table>
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <span class="doc-returns-annotation">
+ <code>None</code>
+ </span>
+ </td>
+ <td class="doc-returns-details">
+
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
</div>
</div>
@@ -1814,14 +1888,14 @@ data analytics libraries there.</p>
<tbody>
<tr>
<td>
- <code>FunctionId</code>
+ <code>function_id</code>
</td>
<td class="doc-returns-details">
<p>Identification object of the StreamPipes function</p>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
- <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.FunctionDefinition" href="../../model/resource/function_definition/#streampipes.model.resource.function_definition.FunctionDefinition">FunctionDefinition</a>.<a class="autorefs autorefs-internal" title="streampipes.model.resource.FunctionDefinition.FunctionId" href="../../model/resource/function_definition/#streampipes.model.resource.function_definition.FunctionDefinition.FunctionId">Functio [...]
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.function_definition.FunctionId" href="../../model/resource/function_definition/#streampipes.model.resource.function_definition.FunctionId">FunctionId</a></code>
</span>
</p>
</td>
@@ -2048,12 +2122,16 @@ data analytics libraries there.</p>
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>List of the stream ids</code>
- </span>
+ <code>stream_ids</code>
</td>
<td class="doc-returns-details">
-
+ <p>List of the stream ids</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.List">List</span>[str]</code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
diff --git a/docs/docs/python/dev/reference/functions/utils/async_iter_handler/index.html b/docs/docs/python/dev/reference/functions/utils/async_iter_handler/index.html
index b1dfa2db..3537f266 100644
--- a/docs/docs/python/dev/reference/functions/utils/async_iter_handler/index.html
+++ b/docs/docs/python/dev/reference/functions/utils/async_iter_handler/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/async_iter_handler/">
+
<link rel="prev" href="../../broker/output_collector/">
@@ -38,7 +44,7 @@
- <title>Async iter handler - Apache StreamPipes for Python</title>
+ <title>Async iter handler - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1622,7 +1652,7 @@
<div class="doc doc-contents ">
- <p>Handels asyncrone iterators to get every message after an other in parallel.</p>
+ <p>Handles asynchronous iterators to get every message after another in parallel.</p>
@@ -1655,7 +1685,7 @@
<div class="doc doc-contents ">
- <p>Gets the next message from an AsncIterator.</p>
+ <p>Gets the next message from an AsyncIterator.</p>
<table>
<thead>
@@ -1677,10 +1707,20 @@
</p>
</td>
</tr>
+ <tr>
+ <td><code>message</code></td>
+ <td class="doc-param-details">
+ <p>An asynchronous iterator that contains the messages.</p>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.AsyncIterator">AsyncIterator</span></code>
+ </span>
+ </p>
+ </td>
+ </tr>
</tbody>
</table>
- <p>message: AsyncIterator
- An asyncrone iterator that contains the messages.</p>
<table>
<thead>
@@ -1692,12 +1732,16 @@
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>Tuple of the stream id und next message or ("stop", None) if no message is left.</code>
- </span>
+ <code>result</code>
</td>
<td class="doc-returns-details">
-
+ <p>Tuple of the stream id und next message or <code>("stop", None)</code> if no message is left.</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Tuple">Tuple</span>[str, Optional[<span title="typing.Any">Any</span>]]</code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
@@ -1724,7 +1768,7 @@
<div class="doc doc-contents ">
- <p>Continuously gets the next published message from multiple AsncIterators in parallel.</p>
+ <p>Continuously gets the next published message from multiple AsyncIterators in parallel.</p>
<table>
<thead>
@@ -1737,7 +1781,7 @@
<tr>
<td><code>messages</code></td>
<td class="doc-param-details">
- <p>A dictonary with an asyncrone iterator for every stream id.</p>
+ <p>A dictionary with an asynchronous iterator for every stream id.</p>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1752,19 +1796,23 @@
<table>
<thead>
<tr>
- <th><b>RETURNS</b></th>
+ <th><b>YIELDS</b></th>
<th><b>DESCRIPTION</b></th>
</tr>
</thead>
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>Generator that returns all recieved messages continuously.</code>
- </span>
+ <code>message</code>
</td>
- <td class="doc-returns-details">
-
+ <td class="doc-yields-details">
+ <p>Description of the anonymous integer return value.</p>
+ <p>
+ <span class="doc-yields-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Tuple">Tuple</span>[str, <span title="typing.Any">Any</span>]</code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
diff --git a/docs/docs/python/dev/reference/functions/utils/data_stream_context/index.html b/docs/docs/python/dev/reference/functions/utils/data_stream_context/index.html
index 0c950f83..1e28b320 100644
--- a/docs/docs/python/dev/reference/functions/utils/data_stream_context/index.html
+++ b/docs/docs/python/dev/reference/functions/utils/data_stream_context/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/data_stream_context/">
+
<link rel="prev" href="../async_iter_handler/">
@@ -38,7 +44,7 @@
- <title>Data stream context - Apache StreamPipes for Python</title>
+ <title>Data stream context - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1620,7 +1650,7 @@
<tr>
<td><code>functions</code></td>
<td class="doc-param-details">
- <p>StreamPipesFunctions which require the data of this data stream.</p>
+ <p>StreamPipes Functions which require the data of this data stream.</p>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
@@ -1682,7 +1712,7 @@
<div class="doc doc-contents ">
- <p>Adds a new StreamPipesFunction.</p>
+ <p>Adds a new StreamPipes Function.</p>
<table>
<thead>
diff --git a/docs/docs/python/dev/reference/functions/utils/data_stream_generator/index.html b/docs/docs/python/dev/reference/functions/utils/data_stream_generator/index.html
index d6263cb1..1d5a4ef7 100644
--- a/docs/docs/python/dev/reference/functions/utils/data_stream_generator/index.html
+++ b/docs/docs/python/dev/reference/functions/utils/data_stream_generator/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/data_stream_generator/">
+
<link rel="prev" href="../data_stream_context/">
@@ -38,7 +44,7 @@
- <title>Data stream generator - Apache StreamPipes for Python</title>
+ <title>Data stream generator - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1598,7 +1628,66 @@
Bases: <code><span title="enum.Enum">Enum</span></code></p>
- <p>Runtime types for the attributes of a data stream.</p>
+ <p>Runtime type names for the attributes of a data stream.</p>
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>ATTRIBUTE</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>STRING</code></td>
+ <td class="doc-attribute-details">
+
+ <p>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>BOOLEAN</code></td>
+ <td class="doc-attribute-details">
+
+ <p>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>DOUBLE</code></td>
+ <td class="doc-attribute-details">
+
+ <p>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>FLOAT</code></td>
+ <td class="doc-attribute-details">
+
+ <p>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>INTEGER</code></td>
+ <td class="doc-attribute-details">
+
+ <p>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>LONG</code></td>
+ <td class="doc-attribute-details">
+
+ <p>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
@@ -1688,6 +1777,31 @@
</tbody>
</table>
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>data_stream</code>
+ </td>
+ <td class="doc-returns-details">
+ <p>The created data stream</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.data_stream.DataStream" href="../../../model/resource/data_stream/#streampipes.model.resource.data_stream.DataStream">DataStream</a></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
</div>
</div>
diff --git a/docs/docs/python/dev/reference/functions/utils/function_context/index.html b/docs/docs/python/dev/reference/functions/utils/function_context/index.html
index f9235dae..521a090a 100644
--- a/docs/docs/python/dev/reference/functions/utils/function_context/index.html
+++ b/docs/docs/python/dev/reference/functions/utils/function_context/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/function_context/">
+
<link rel="prev" href="../data_stream_generator/">
@@ -38,7 +44,7 @@
- <title>Function context - Apache StreamPipes for Python</title>
+ <title>Function context - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1632,7 +1662,7 @@
<tr>
<td><code>schema</code></td>
<td class="doc-param-details">
- <p>A dictonary which contains the schema of a data stream for each stream id.</p>
+ <p>A dictionary which contains the schema of a data stream for each stream id.</p>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
diff --git a/docs/docs/python/dev/reference/model/common/index.html b/docs/docs/python/dev/reference/model/common/index.html
index bb9bd03d..83f4e39c 100644
--- a/docs/docs/python/dev/reference/model/common/index.html
+++ b/docs/docs/python/dev/reference/model/common/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/common/">
+
<link rel="prev" href="../../functions/utils/function_context/">
@@ -38,7 +44,7 @@
- <title>Common - Apache StreamPipes for Python</title>
+ <title>Common - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
- Examples
+ 🤓 Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -490,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../examples/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -504,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../examples/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -518,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../examples/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -532,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../examples/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -578,14 +608,14 @@
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
- Reference
+ 📚 Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- Reference
+ 📚 Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -2294,7 +2324,7 @@ Defines alias generator to convert field names from camelCase (API) to snake_cas
<div class="doc doc-contents ">
- <p>Generates n random letters.</p>
+ <p>Generates a string consisting of random letters.</p>
<table>
<thead>
@@ -2319,6 +2349,31 @@ Defines alias generator to convert field names from camelCase (API) to snake_cas
</tbody>
</table>
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>rand_str</code>
+ </td>
+ <td class="doc-returns-details">
+ <p>String consisting of <code>n</code> random letters</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code>str</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
</div>
</div>
diff --git a/docs/docs/python/dev/reference/model/container/data_lake_measures/index.html b/docs/docs/python/dev/reference/model/container/data_lake_measures/index.html
index 4e7cde1c..27d3f262 100644
--- a/docs/docs/python/dev/reference/model/container/data_lake_measures/index.html
+++ b/docs/docs/python/dev/reference/model/container/data_lake_measures/index.html
@@ -25,8 +25,14 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="description" content="Python library for Apache StreamPipes">
+ <meta name="author" content="Apache Software Foundation (ASF)">
+
+
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/data_lake_measures/">
+
<link rel="prev" href="../../common/">
@@ -38,7 +44,7 @@
- <title>Data lake measures - Apache StreamPipes for Python</title>
+ <title>Data lake measures - Apache StreamPipes Python</title>
@@ -113,6 +119,8 @@
+
+
@@ -120,6 +128,8 @@
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
@@ -146,7 +156,7 @@
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-header__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-header__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
@@ -158,7 +168,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -171,6 +181,26 @@
</div>
</div>
+ <form class="md-header__option" data-md-component="palette">
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+ </label>
+
+
+ </form>
+
<label class="md-header__button md-icon" for="__search">
@@ -214,7 +244,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -234,7 +264,7 @@
<li class="md-tabs__item">
<a href="../../../.." class="md-tabs__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -249,7 +279,7 @@
<li class="md-tabs__item">
<a href="../../../../getting-started/first-steps/" class="md-tabs__link">
- Getting Started
+ 🚀 Getting Started
</a>
</li>
@@ -264,8 +294,8 @@
<li class="md-tabs__item">
- <a href="../../../../examples/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
- Examples
+ <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ 🤓 Tutorials
</a>
</li>
@@ -288,7 +318,7 @@
<li class="md-tabs__item">
<a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
- Reference
+ 📚 Reference
</a>
</li>
@@ -323,12 +353,12 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="https://streampipes.apache.org/" title="Apache StreamPipes for Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes for Python" data-md-component="logo">
+ <a href="https://streampipes.apache.org/" title="Apache StreamPipes Python" class="md-nav__button md-logo" aria-label="Apache StreamPipes Python" data-md-component="logo">
<img src="https://streampipes.apache.org/img/sp-logo-white-right.png" alt="logo">
</a>
- Apache StreamPipes for Python
+ Apache StreamPipes Python
</label>
<div class="md-nav__source">
@@ -338,7 +368,7 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25 [...]
</div>
<div class="md-source__repository">
- GitHub
+ apache/streampipes
</div>
</a>
</div>
@@ -354,7 +384,7 @@
<li class="md-nav__item">
<a href="../../../.." class="md-nav__link">
- Home
+ 🏡 Home
</a>
</li>
@@ -386,14 +416,14 @@
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
- Getting Started
+ 🚀 Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
- Getting Started
+ 🚀 Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -473,14 +503,14 @@
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
- Examples
+ 🤓 Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
... 27894 lines suppressed ...