docs

Author: oliver-zehentleitner

dev/sphinx/source/changelog.md

@@ -10,21 +10,27 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 [How to upgrade to the latest version!](https://unicorn-binance-websocket-api.docs.lucit.tech/readme.html#installation-and-upgrade)
 
 ## 2.7.0.dev (development stage/unreleased/unstable)
+### Changed
+- Improved text of `MaximumSubscriptionsExceeded` exception.
+- Updated description text in all files.
+### Fixed
+- Import in `licensing_manager.py`.
+- Type of global `logger` and `connect` variable.
 
 ## 2.7.0
 ### Added
-- Exception `MaximumSubscriptionsExceeded` thrown by `subscribe_to_stream()`
+- Exception `MaximumSubscriptionsExceeded` thrown by `subscribe_to_stream()`.
 - `print_summary()` and `print_stream_info()` now display `binance_api_status_code` in color! Green at 200 otherwise red.
 ### Changed
 - `subscribe_to_stream()` now throws the exception `MaximumSubscriptionsExceeded` instand of returning `False` if  
   the number of allowed subscriptions per stream is exceeded.
 ### Fixed
-- Typing of `create_stream()` parameters
-- Type of parameter `stream_label` in `get_stream_id_by_label()`
-- Type of first return variable in `restclient.get_listen_key()`
-- Typo in `is_update_availabe_unicorn_fy()` to `is_update_available_unicorn_fy()` 
-- Typo in `is_update_availabe_check_command()` to `is_update_available_check_command()`
-- A couple of small text typos
+- Typing of `create_stream()` parameters.
+- Type of parameter `stream_label` in `get_stream_id_by_label()`.
+- Type of first return variable in `restclient.get_listen_key()`.
+- Typo in `is_update_availabe_unicorn_fy()` to `is_update_available_unicorn_fy()`.
+- Typo in `is_update_availabe_check_command()` to `is_update_available_check_command()`.
+- A couple of small text typos.
 
 ## 2.6.0
 ### Added

dev/sphinx/source/readme.md

@@ -33,7 +33,7 @@
 
 A Python SDK by [LUCIT](https://www.lucit.tech) to use the Binance Websocket API`s (com+testnet, com-margin+testnet, 
 com-isolated_margin+testnet, com-futures+testnet, com-coin_futures, us, tr, dex/chain+testnet) 
-in a easy, fast, flexible, robust and fully-featured way. 
+in a simple, fast, flexible, robust and fully-featured way. 
 
 Part of '[UNICORN Binance Suite](https://www.lucit.tech/unicorn-binance-suite.html)'.
 
@@ -123,8 +123,8 @@ with BinanceWebSocketApiManager(exchange='binance.com') as ubwa:
         asyncio.run(main())
     except KeyboardInterrupt:
         print("\r\nGracefully stopping ...")
-    except Exception as error_msg:
-        print(f"\r\nERROR: {error_msg}\r\nGracefully stopping ...")
+    except Exception as e:
+        print(f"\r\nERROR: {e}\r\nGracefully stopping ...")
 ```
 
 Basically that's it, but there are more options.

docs/_modules/index.html

@@ -254,7 +254,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on May 11 2024 at 23:32 (CET).
+    Last updated on May 12 2024 at 11:04 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

docs/_modules/unicorn_binance_websocket_api/api.html

@@ -175,7 +175,8 @@ <h1>Source code for unicorn_binance_websocket_api.api</h1><div class="highlight"
 <span class="kn">import</span> <span class="nn">threading</span>
 
 
-<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;unicorn_binance_websocket_api&quot;</span><span class="p">)</span>
+<span class="n">__logger__</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;unicorn_binance_websocket_api&quot;</span><span class="p">)</span>
+<span class="n">logger</span> <span class="o">=</span> <span class="n">__logger__</span>
 
 
 <div class="viewcode-block" id="BinanceWebSocketApiApi">
@@ -2237,7 +2238,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on May 11 2024 at 23:32 (CET).
+    Last updated on May 12 2024 at 11:04 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

docs/_modules/unicorn_binance_websocket_api/connection.html

@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>unicorn_binance_websocket_api.connection &#8212; unicorn-binance-websocket-api 2.6.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>unicorn_binance_websocket_api.connection &#8212; unicorn-binance-websocket-api 2.7.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=92fd9be5" />
     <link rel="stylesheet" type="text/css" href="../../_static/pydoctheme.css?v=fdf8e9ae" />
@@ -173,8 +173,9 @@ <h1>Source code for unicorn_binance_websocket_api.connection</h1><div class="hig
 <span class="kn">import</span> <span class="nn">sys</span>
 <span class="kn">import</span> <span class="nn">websockets</span>
 
-<span class="n">connect</span> <span class="o">=</span> <span class="n">websockets</span><span class="o">.</span><span class="n">connect</span>
-<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;unicorn_binance_websocket_api&quot;</span><span class="p">)</span>
+<span class="n">__logger__</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;unicorn_binance_websocket_api&quot;</span><span class="p">)</span>
+<span class="n">logger</span> <span class="o">=</span> <span class="n">__logger__</span>
+<span class="n">connect</span><span class="p">:</span>  <span class="n">websockets</span><span class="o">.</span><span class="n">connect</span> <span class="o">=</span> <span class="n">websockets</span><span class="o">.</span><span class="n">connect</span>
 
 
 <div class="viewcode-block" id="BinanceWebSocketApiConnection">
@@ -464,7 +465,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on May 08 2024 at 14:54 (CET).
+    Last updated on May 12 2024 at 11:04 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

docs/_modules/unicorn_binance_websocket_api/exceptions.html

@@ -168,10 +168,13 @@ <h1>Source code for unicorn_binance_websocket_api.exceptions</h1><div class="hig
 <a class="viewcode-back" href="../../unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.exceptions.MaximumSubscriptionsExceeded">[docs]</a>
 <span class="k">class</span> <span class="nc">MaximumSubscriptionsExceeded</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">    Exception if the maximum number of subscriptions has been exceeded!</span>
+<span class="sd">    Exception if the maximum number of subscriptions per stream has been exceeded!</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">max_subscriptions</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;The maximum number of </span><span class="si">{</span><span class="n">max_subscriptions</span><span class="si">}</span><span class="s2"> subscriptions per stream has been exceeded!&quot;</span>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exchange</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">max_subscriptions_per_stream</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="p">(</span><span class="sa">f</span><span class="s2">&quot;The maximum number of </span><span class="si">{</span><span class="n">max_subscriptions_per_stream</span><span class="si">}</span><span class="s2"> subscriptions per stream for exchange &quot;</span>
+                        <span class="sa">f</span><span class="s2">&quot;&#39;</span><span class="si">{</span><span class="n">exchange</span><span class="si">}</span><span class="s2">&#39; has been exceeded! For detailed information please have a look at our wiki: &quot;</span>
+                        <span class="sa">f</span><span class="s2">&quot;https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/Binance-&quot;</span>
+                        <span class="sa">f</span><span class="s2">&quot;websocket-endpoint-configuration-overview&quot;</span><span class="p">)</span>
         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">message</span><span class="p">)</span></div>
 
 
@@ -337,7 +340,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on May 11 2024 at 22:02 (CET).
+    Last updated on May 12 2024 at 11:04 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

docs/_modules/unicorn_binance_websocket_api/manager.html

@@ -207,18 +207,18 @@ <h1>Source code for unicorn_binance_websocket_api.manager</h1><div class="highli
     <span class="kn">from</span> <span class="nn">typing_extensions</span> <span class="kn">import</span> <span class="n">Literal</span>
 
 <span class="n">__app_name__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;unicorn-binance-websocket-api&quot;</span>
-<span class="n">__version__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;2.7.0&quot;</span>
-
-<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;unicorn_binance_websocket_api&quot;</span><span class="p">)</span>
+<span class="n">__version__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;2.7.0.dev&quot;</span>
+<span class="n">__logger__</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;unicorn_binance_websocket_api&quot;</span><span class="p">)</span>
+<span class="n">logger</span> <span class="o">=</span> <span class="n">__logger__</span>
 
 
 <div class="viewcode-block" id="BinanceWebSocketApiManager">
 <a class="viewcode-back" href="../../unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager">[docs]</a>
 <span class="k">class</span> <span class="nc">BinanceWebSocketApiManager</span><span class="p">(</span><span class="n">threading</span><span class="o">.</span><span class="n">Thread</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">    An unofficial Python API to use the Binance Websocket API`s (com+testnet, com-margin+testnet,</span>
-<span class="sd">    com-isolated_margin+testnet, com-futures+testnet, us, dex/chain+testnet) in an easy, fast, flexible,</span>
-<span class="sd">    robust and fully-featured way.</span>
+<span class="sd">    A Python SDK by LUCIT to use the Binance Websocket API`s (com+testnet, com-margin+testnet,</span>
+<span class="sd">    com-isolated_margin+testnet, com-futures+testnet, com-coin_futures, us, tr, dex/chain+testnet) in a simple, fast,</span>
+<span class="sd">    flexible, robust and fully-featured way.</span>
 
 <span class="sd">    This library supports two different kind of websocket endpoints:</span>
 
@@ -5127,12 +5127,13 @@ <h1>Source code for unicorn_binance_websocket_api.manager</h1><div class="highli
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">stream_list</span><span class="p">[</span><span class="n">stream_id</span><span class="p">][</span><span class="s1">&#39;subscriptions&#39;</span><span class="p">]</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_subscriptions_per_stream</span><span class="p">:</span>
             <span class="n">error_msg</span> <span class="o">=</span> <span class="p">(</span><span class="sa">f</span><span class="s2">&quot;The limit of </span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">max_subscriptions_per_stream</span><span class="p">)</span><span class="si">}</span><span class="s2"> subscriptions per stream has been &quot;</span>
                          <span class="sa">f</span><span class="s2">&quot;exceeded!&quot;</span><span class="p">)</span>
-            <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;BinanceWebSocketApiManager.subscribe_to_stream(</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">stream_id</span><span class="p">)</span><span class="si">}</span><span class="s2">) - error_msg: </span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">error_msg</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
-            <span class="c1"># self._crash_stream(stream_id, error_msg=error_msg)</span>
-            <span class="c1">#return False</span>
-            <span class="k">raise</span> <span class="n">MaximumSubscriptionsExceeded</span><span class="p">(</span><span class="n">max_subscriptions</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">max_subscriptions_per_stream</span><span class="p">))</span>
+            <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;BinanceWebSocketApiManager.subscribe_to_stream(</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">stream_id</span><span class="p">)</span><span class="si">}</span><span class="s2">) - error_msg: &quot;</span>
+                         <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">error_msg</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
+            <span class="k">raise</span> <span class="n">MaximumSubscriptionsExceeded</span><span class="p">(</span><span class="n">exchange</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">get_exchange</span><span class="p">(),</span>
+                                               <span class="n">max_subscriptions_per_stream</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">max_subscriptions_per_stream</span><span class="p">)</span>
         <span class="k">if</span> <span class="n">payload</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
-            <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;BinanceWebSocketApiManager.subscribe_to_stream(</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">stream_id</span><span class="p">)</span><span class="si">}</span><span class="s2">) - error_msg: Payload is None!&quot;</span><span class="p">)</span>
+            <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;BinanceWebSocketApiManager.subscribe_to_stream(</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">stream_id</span><span class="p">)</span><span class="si">}</span><span class="s2">) - error_msg: Payload is &quot;</span>
+                         <span class="sa">f</span><span class="s2">&quot;None!&quot;</span><span class="p">)</span>
             <span class="k">return</span> <span class="kc">False</span>
         <span class="k">try</span><span class="p">:</span>
             <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">payload</span><span class="p">:</span>
@@ -5409,7 +5410,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on May 11 2024 at 23:32 (CET).
+    Last updated on May 12 2024 at 11:04 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.