Merge remote-tracking branch 'origin/dev'

apache · Mar 25, 2024 · 9502c96 · 9502c96
2 parents 9127d83 + fda714d
commit 9502c96
Show file tree

Hide file tree

Showing 54 changed files with 814 additions and 472 deletions.
diff --git a/docs-python/dev/assets/_mkdocstrings.css b/docs-python/dev/assets/_mkdocstrings.css
@@ -26,39 +26,84 @@
   float: right;
 }
 
-/* Keep headings consistent. */
-h1.doc-heading,
-h2.doc-heading,
-h3.doc-heading,
-h4.doc-heading,
-h5.doc-heading,
-h6.doc-heading {
-  font-weight: 400;
-  line-height: 1.5;
-  color: inherit;
-  text-transform: none;
+/* Symbols in Navigation and ToC. */
+:root,
+[data-md-color-scheme="default"] {
+  --doc-symbol-attribute-fg-color: #953800;
+  --doc-symbol-function-fg-color: #8250df;
+  --doc-symbol-method-fg-color: #8250df;
+  --doc-symbol-class-fg-color: #0550ae;
+  --doc-symbol-module-fg-color: #5cad0f;
+
+  --doc-symbol-attribute-bg-color: #9538001a;
+  --doc-symbol-function-bg-color: #8250df1a;
+  --doc-symbol-method-bg-color: #8250df1a;
+  --doc-symbol-class-bg-color: #0550ae1a;
+  --doc-symbol-module-bg-color: #5cad0f1a;
+}
+
+[data-md-color-scheme="slate"] {
+  --doc-symbol-attribute-fg-color: #ffa657;
+  --doc-symbol-function-fg-color: #d2a8ff;
+  --doc-symbol-method-fg-color: #d2a8ff;
+  --doc-symbol-class-fg-color: #79c0ff;
+  --doc-symbol-module-fg-color: #baff79;
+
+  --doc-symbol-attribute-bg-color: #ffa6571a;
+  --doc-symbol-function-bg-color: #d2a8ff1a;
+  --doc-symbol-method-bg-color: #d2a8ff1a;
+  --doc-symbol-class-bg-color: #79c0ff1a;
+  --doc-symbol-module-bg-color: #baff791a;
+}
+
+code.doc-symbol {
+  border-radius: .1rem;
+  font-size: .85em;
+  padding: 0 .3em;
+  font-weight: bold;
+}
+
+code.doc-symbol-attribute {
+  color: var(--doc-symbol-attribute-fg-color);
+  background-color: var(--doc-symbol-attribute-bg-color);
+}
+
+code.doc-symbol-attribute::after {
+  content: "attr";
+}
+
+code.doc-symbol-function {
+  color: var(--doc-symbol-function-fg-color);
+  background-color: var(--doc-symbol-function-bg-color);
+}
+
+code.doc-symbol-function::after {
+  content: "func";
 }
 
-h1.doc-heading {
-  font-size: 1.6rem;
+code.doc-symbol-method {
+  color: var(--doc-symbol-method-fg-color);
+  background-color: var(--doc-symbol-method-bg-color);
 }
 
-h2.doc-heading {
-  font-size: 1.2rem;
+code.doc-symbol-method::after {
+  content: "meth";
 }
 
-h3.doc-heading {
-  font-size: 1.15rem;
+code.doc-symbol-class {
+  color: var(--doc-symbol-class-fg-color);
+  background-color: var(--doc-symbol-class-bg-color);
 }
 
-h4.doc-heading {
-  font-size: 1.10rem;
+code.doc-symbol-class::after {
+  content: "class";
 }
 
-h5.doc-heading {
-  font-size: 1.05rem;
+code.doc-symbol-module {
+  color: var(--doc-symbol-module-fg-color);
+  background-color: var(--doc-symbol-module-bg-color);
 }
 
-h6.doc-heading {
-  font-size: 1rem;
+code.doc-symbol-module::after {
+  content: "mod";
 }
diff --git a/docs-python/dev/index.html b/docs-python/dev/index.html
@@ -2235,17 +2235,7 @@ <h1>🏡 Home</h1>
 <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>
-<div class="admonition danger">
-<p class="admonition-title">Dependency issue with StreamPipes Python 0.92.0</p>
-<p>In StreamPipes Python <code>0.92.0</code> there is a problem with the required dependencies.<br>
-Pydantic has recently released the new version <code>2.0</code> with many exciting improvements, but also some breaking changes. 
-Unfortunately, we didn't limit our requirements strictly enough, so yydantic <code>2.0</code> is installed together with streampipes, which is not (yet) compatible.<br>
-To fix this bug, simply run the following command after installing streampipes, or adjust your dependencies accordingly:</p>
-<div class="language-python highlight"><pre><span></span><code><span class="n">pip</span> <span class="n">install</span> <span class="s2">&quot;pydantic&lt;2.0&quot;</span> <span class="s2">&quot;pydantic_core&lt;2.0&quot;</span>
-</code></pre></div>
-</div>
-<p><br></p>
+
 <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.

diff --git a/docs-python/dev/objects.inv b/docs-python/dev/objects.inv
diff --git a/docs-python/dev/reference/client/client/index.html b/docs-python/dev/reference/client/client/index.html
@@ -812,7 +812,7 @@
 
         <li class="md-nav__item">
   <a href="#streampipes.client.client" class="md-nav__link">
-    streampipes.client.client
+    client
   </a>
 
 </li>
@@ -841,14 +841,14 @@
 
           <li class="md-nav__item">
   <a href="#streampipes.client.client.StreamPipesClient.create" class="md-nav__link">
-    create()
+    create
   </a>
 
 </li>
 
           <li class="md-nav__item">
   <a href="#streampipes.client.client.StreamPipesClient.describe" class="md-nav__link">
-    describe()
+    describe
   </a>
 
 </li>
@@ -2238,7 +2238,7 @@
 
         <li class="md-nav__item">
   <a href="#streampipes.client.client" class="md-nav__link">
-    streampipes.client.client
+    client
   </a>
 
 </li>
@@ -2267,14 +2267,14 @@
 
           <li class="md-nav__item">
   <a href="#streampipes.client.client.StreamPipesClient.create" class="md-nav__link">
-    create()
+    create
   </a>
 
 </li>
 
           <li class="md-nav__item">
   <a href="#streampipes.client.client.StreamPipesClient.describe" class="md-nav__link">
-    describe()
+    describe
   </a>
 
 </li>
@@ -2307,6 +2307,7 @@ <h1>Client</h1>
 <div class="doc doc-object doc-module">
 
 
+
 <a id="streampipes.client.client"></a>
   <div class="doc doc-contents first">
 
@@ -2330,7 +2331,7 @@ <h1>Client</h1>
 
 
 <h2 id="streampipes.client.client.StreamPipesClient" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">StreamPipesClient</span><span class="p">(</span><span class="n">client_config</span><span class="p">,</span> <span class="n">logging_level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span></code>
+            <code class="highlight language-python"><span class="n">StreamPipesClient</span><span class="p">(</span><span class="n">client_config</span><span class="p">,</span> <span class="n">logging_level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span></code>
 
 <a href="#streampipes.client.client.StreamPipesClient" class="headerlink" title="Permanent link">&para;</a></h2>
 
@@ -2383,7 +2384,7 @@ <h2 id="streampipes.client.client.StreamPipesClient" class="doc doc-heading">
                 </span>
                 <span class="doc-param-default">
                   <b>DEFAULT:</b> 
-                    <code>logging.<span title="logging.INFO">INFO</span></code>
+                    <code><span title="logging.INFO">INFO</span></code>
                 </span>
             </p>
           </td>
@@ -2402,7 +2403,7 @@ <h2 id="streampipes.client.client.StreamPipesClient" class="doc doc-heading">
     </thead>
     <tbody>
         <tr>
-          <td><code>dataLakeMeasureApi</code></td>
+          <td><code><span title="streampipes.client.client.StreamPipesClient.dataLakeMeasureApi">dataLakeMeasureApi</span></code></td>
           <td class="doc-attribute-details">
             <div class="doc-md-description">
               <p>Instance of the data lake measure endpoint</p>
@@ -2416,7 +2417,7 @@ <h2 id="streampipes.client.client.StreamPipesClient" class="doc doc-heading">
           </td>
         </tr>
         <tr>
-          <td><code>dataStreamApi</code></td>
+          <td><code><span title="streampipes.client.client.StreamPipesClient.dataStreamApi">dataStreamApi</span></code></td>
           <td class="doc-attribute-details">
             <div class="doc-md-description">
               <p>Instance of the data stream endpoint</p>
@@ -2507,7 +2508,7 @@ <h2 id="streampipes.client.client.StreamPipesClient" class="doc doc-heading">
 
 
 <h3 id="streampipes.client.client.StreamPipesClient.base_api_path" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">base_api_path</span><span class="p">:</span> <span class="nb">str</span></code>
+          <code class="highlight language-python"><span class="n">base_api_path</span><span class="p">:</span> <span class="nb">str</span></code>
 
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-property"><code>property</code></small>
@@ -2557,7 +2558,7 @@ <h3 id="streampipes.client.client.StreamPipesClient.base_api_path" class="doc do
 
 
 <h3 id="streampipes.client.client.StreamPipesClient.http_headers" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">http_headers</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span></code>
+          <code class="highlight language-python"><span class="n">http_headers</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span></code>
 
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-property"><code>property</code></small>
@@ -2612,7 +2613,7 @@ <h3 id="streampipes.client.client.StreamPipesClient.http_headers" class="doc doc
 
 
 <h3 id="streampipes.client.client.StreamPipesClient.create" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">create</span><span class="p">(</span><span class="n">client_config</span><span class="p">,</span> <span class="n">logging_level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span></code>
+          <code class="highlight language-python"><span class="n">create</span><span class="p">(</span><span class="n">client_config</span><span class="p">,</span> <span class="n">logging_level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span></code>
 
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
@@ -2663,7 +2664,7 @@ <h3 id="streampipes.client.client.StreamPipesClient.create" class="doc doc-headi
                 </span>
                 <span class="doc-param-default">
                   <b>DEFAULT:</b> 
-                    <code>logging.<span title="logging.INFO">INFO</span></code>
+                    <code><span title="logging.INFO">INFO</span></code>
                 </span>
             </p>
           </td>
@@ -2706,7 +2707,7 @@ <h3 id="streampipes.client.client.StreamPipesClient.create" class="doc doc-headi
 
 
 <h3 id="streampipes.client.client.StreamPipesClient.describe" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">describe</span><span class="p">()</span></code>
+          <code class="highlight language-python"><span class="n">describe</span><span class="p">()</span></code>
 
 <a href="#streampipes.client.client.StreamPipesClient.describe" class="headerlink" title="Permanent link">&para;</a></h3>
 
@@ -2763,6 +2764,7 @@ <h3 id="streampipes.client.client.StreamPipesClient.describe" class="doc doc-hea
 
   </div>
 
+
 </div>
 
 

diff --git a/docs-python/dev/reference/client/config/index.html b/docs-python/dev/reference/client/config/index.html
@@ -832,7 +832,7 @@
 
         <li class="md-nav__item">
   <a href="#streampipes.client.config" class="md-nav__link">
-    streampipes.client.config
+    config
   </a>
 
 </li>
@@ -2204,7 +2204,7 @@
 
         <li class="md-nav__item">
   <a href="#streampipes.client.config" class="md-nav__link">
-    streampipes.client.config
+    config
   </a>
 
 </li>
@@ -2239,6 +2239,7 @@ <h1>Config</h1>
 <div class="doc doc-object doc-module">
 
 
+
 <a id="streampipes.client.config"></a>
   <div class="doc doc-contents first">
 
@@ -2260,8 +2261,7 @@ <h1>Config</h1>
 
 
 <h2 id="streampipes.client.config.StreamPipesClientConfig" class="doc doc-heading">
-          <code>StreamPipesClientConfig</code>
-
+            <code class="highlight language-python"><span class="n">StreamPipesClientConfig</span><span class="p">(</span><span class="n">credential_provider</span><span class="p">,</span> <span class="n">host_address</span><span class="p">,</span> <span class="n">https_disabled</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">80</span><span class="p">)</span></code>
 
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-dataclass"><code>dataclass</code></small>
@@ -2379,6 +2379,7 @@ <h2 id="streampipes.client.config.StreamPipesClientConfig" class="doc doc-headin
 
   </div>
 
+
 </div>