Skip to content

Commit 44486f5

Browse files
oliver-zehentleitneroliver-zehentleitner
committed
docs
1 parent 4a45f58 commit 44486f5

File tree

15 files changed

+23
-20
lines changed

15 files changed

+23
-20
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ ubwa = BinanceWebSocketApiManager(exchange="binance.com")
5656
ubwa.create_stream(channels=['trade', 'kline_1m'], markets=['btcusdt', 'bnbbtc', 'ethbtc'])
5757
```
5858

59-
### And 4 more lines to print out the data
59+
#### And 4 more lines to print out the data
6060

6161
```
6262
while True:

‎dev/sphinx/source/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ ubwa = BinanceWebSocketApiManager(exchange="binance.com")
5656
ubwa.create_stream(channels=['trade', 'kline_1m'], markets=['btcusdt', 'bnbbtc', 'ethbtc'])
5757
```
5858

59-
### And 4 more lines to print out the data
59+
#### And 4 more lines to print out the data
6060

6161
```
6262
while True:

‎docs/_modules/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ <h3>Navigation</h3>
254254
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
255255
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
256256
See <a href="/license.html">License</a> for more information.<br />
257-
Last updated on May 10 2024 at 18:59 (CET).
257+
Last updated on May 10 2024 at 19:01 (CET).
258258
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
259259
<br />
260260
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/_sources/readme.md.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ ubwa = BinanceWebSocketApiManager(exchange="binance.com")
5656
ubwa.create_stream(channels=['trade', 'kline_1m'], markets=['btcusdt', 'bnbbtc', 'ethbtc'])
5757
```
5858

59-
### And 4 more lines to print out the data
59+
#### And 4 more lines to print out the data
6060

6161
```
6262
while True:

‎docs/changelog.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4013,7 +4013,7 @@ <h3>Navigation</h3>
40134013
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
40144014
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
40154015
See <a href="/license.html">License</a> for more information.<br />
4016-
Last updated on May 10 2024 at 18:59 (CET).
4016+
Last updated on May 10 2024 at 19:01 (CET).
40174017
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
40184018
<br />
40194019
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/code_of_conduct.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ <h3>Navigation</h3>
399399
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
400400
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
401401
See <a href="/license.html">License</a> for more information.<br />
402-
Last updated on May 10 2024 at 18:59 (CET).
402+
Last updated on May 10 2024 at 19:01 (CET).
403403
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
404404
<br />
405405
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/contributing.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ <h3>Navigation</h3>
338338
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
339339
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
340340
See <a href="/license.html">License</a> for more information.<br />
341-
Last updated on May 10 2024 at 18:59 (CET).
341+
Last updated on May 10 2024 at 19:01 (CET).
342342
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
343343
<br />
344344
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/genindex.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -781,7 +781,7 @@ <h3>Navigation</h3>
781781
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
782782
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
783783
See <a href="/license.html">License</a> for more information.<br />
784-
Last updated on May 10 2024 at 18:59 (CET).
784+
Last updated on May 10 2024 at 19:01 (CET).
785785
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
786786
<br />
787787
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/index.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,6 @@ <h1>Welcome to unicorn-binance-websocket-api’s documentation!<a class="headerl
176176
<li class="toctree-l2"><a class="reference internal" href="readme.html#get-a-unicorn-binance-suite-license">Get a UNICORN Binance Suite License</a></li>
177177
<li class="toctree-l2"><a class="reference internal" href="readme.html#receive-data-from-binance-websockets">Receive Data from Binance WebSockets</a><ul>
178178
<li class="toctree-l3"><a class="reference internal" href="readme.html#create-a-multiplex-websocket-connection-to-binance-with-a-stream-buffer-with-just-3-lines-of-code">Create a multiplex websocket connection to Binance with a <code class="docutils literal notranslate"><span class="pre">stream_buffer</span></code> with just 3 lines of code</a></li>
179-
<li class="toctree-l3"><a class="reference internal" href="readme.html#and-4-more-lines-to-print-out-the-data">And 4 more lines to print out the data</a></li>
180179
<li class="toctree-l3"><a class="reference internal" href="readme.html#or-with-a-callback-function-just-do">Or with a callback function just do</a></li>
181180
<li class="toctree-l3"><a class="reference internal" href="readme.html#or-with-a-async-callback-function-just-do">Or with a async callback function just do</a></li>
182181
<li class="toctree-l3"><a class="reference internal" href="readme.html#or-await-the-stream-data-in-an-asyncio-coroutine">Or await the stream data in an asyncio coroutine</a></li>
@@ -1076,7 +1075,7 @@ <h3>Navigation</h3>
10761075
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
10771076
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
10781077
See <a href="/license.html">License</a> for more information.<br />
1079-
Last updated on May 10 2024 at 18:59 (CET).
1078+
Last updated on May 10 2024 at 19:01 (CET).
10801079
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
10811080
<br />
10821081
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/license.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ <h3>Navigation</h3>
389389
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
390390
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
391391
See <a href="/license.html">License</a> for more information.<br />
392-
Last updated on May 10 2024 at 18:59 (CET).
392+
Last updated on May 10 2024 at 19:01 (CET).
393393
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
394394
<br />
395395
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/py-modindex.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ <h3>Navigation</h3>
302302
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
303303
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
304304
See <a href="/license.html">License</a> for more information.<br />
305-
Last updated on May 10 2024 at 18:59 (CET).
305+
Last updated on May 10 2024 at 19:01 (CET).
306306
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
307307
<br />
308308
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/readme.html

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,10 @@ <h3><a href="index.html">Table of Contents</a></h3>
6767
<li><a class="reference internal" href="#">UNICORN Binance WebSocket API</a><ul>
6868
<li><a class="reference internal" href="#get-a-unicorn-binance-suite-license">Get a UNICORN Binance Suite License</a></li>
6969
<li><a class="reference internal" href="#receive-data-from-binance-websockets">Receive Data from Binance WebSockets</a><ul>
70-
<li><a class="reference internal" href="#create-a-multiplex-websocket-connection-to-binance-with-a-stream-buffer-with-just-3-lines-of-code">Create a multiplex websocket connection to Binance with a <code class="docutils literal notranslate"><span class="pre">stream_buffer</span></code> with just 3 lines of code</a></li>
70+
<li><a class="reference internal" href="#create-a-multiplex-websocket-connection-to-binance-with-a-stream-buffer-with-just-3-lines-of-code">Create a multiplex websocket connection to Binance with a <code class="docutils literal notranslate"><span class="pre">stream_buffer</span></code> with just 3 lines of code</a><ul>
7171
<li><a class="reference internal" href="#and-4-more-lines-to-print-out-the-data">And 4 more lines to print out the data</a></li>
72+
</ul>
73+
</li>
7274
<li><a class="reference internal" href="#or-with-a-callback-function-just-do">Or with a callback function just do</a></li>
7375
<li><a class="reference internal" href="#or-with-a-async-callback-function-just-do">Or with a async callback function just do</a></li>
7476
<li><a class="reference internal" href="#or-await-the-stream-data-in-an-asyncio-coroutine">Or await the stream data in an asyncio coroutine</a></li>
@@ -290,16 +292,16 @@ <h3><a class="reference external" href="https://unicorn-binance-websocket-api.do
290292
<span class="n">ubwa</span><span class="o">.</span><span class="n">create_stream</span><span class="p">(</span><span class="n">channels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;trade&#39;</span><span class="p">,</span> <span class="s1">&#39;kline_1m&#39;</span><span class="p">],</span> <span class="n">markets</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;btcusdt&#39;</span><span class="p">,</span> <span class="s1">&#39;bnbbtc&#39;</span><span class="p">,</span> <span class="s1">&#39;ethbtc&#39;</span><span class="p">])</span>
291293
</pre></div>
292294
</div>
293-
</section>
294295
<section id="and-4-more-lines-to-print-out-the-data">
295-
<h3>And 4 more lines to print out the data<a class="headerlink" href="#and-4-more-lines-to-print-out-the-data" title="Link to this heading"></a></h3>
296+
<h4>And 4 more lines to print out the data<a class="headerlink" href="#and-4-more-lines-to-print-out-the-data" title="Link to this heading"></a></h4>
296297
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
297298
<span class="n">oldest_data_from_stream_buffer</span> <span class="o">=</span> <span class="n">ubwa</span><span class="o">.</span><span class="n">pop_stream_data_from_stream_buffer</span><span class="p">()</span>
298299
<span class="k">if</span> <span class="n">oldest_data_from_stream_buffer</span><span class="p">:</span>
299300
<span class="nb">print</span><span class="p">(</span><span class="n">oldest_data_from_stream_buffer</span><span class="p">)</span>
300301
</pre></div>
301302
</div>
302303
</section>
304+
</section>
303305
<section id="or-with-a-callback-function-just-do">
304306
<h3>Or with a <a class="reference external" href="https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html?highlight=process_stream_data#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.create_stream">callback function</a> just do<a class="headerlink" href="#or-with-a-callback-function-just-do" title="Link to this heading"></a></h3>
305307
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">unicorn_binance_websocket_api</span> <span class="kn">import</span> <span class="n">BinanceWebSocketApiManager</span>
@@ -934,8 +936,10 @@ <h3><a href="index.html">Table of Contents</a></h3>
934936
<li><a class="reference internal" href="#">UNICORN Binance WebSocket API</a><ul>
935937
<li><a class="reference internal" href="#get-a-unicorn-binance-suite-license">Get a UNICORN Binance Suite License</a></li>
936938
<li><a class="reference internal" href="#receive-data-from-binance-websockets">Receive Data from Binance WebSockets</a><ul>
937-
<li><a class="reference internal" href="#create-a-multiplex-websocket-connection-to-binance-with-a-stream-buffer-with-just-3-lines-of-code">Create a multiplex websocket connection to Binance with a <code class="docutils literal notranslate"><span class="pre">stream_buffer</span></code> with just 3 lines of code</a></li>
939+
<li><a class="reference internal" href="#create-a-multiplex-websocket-connection-to-binance-with-a-stream-buffer-with-just-3-lines-of-code">Create a multiplex websocket connection to Binance with a <code class="docutils literal notranslate"><span class="pre">stream_buffer</span></code> with just 3 lines of code</a><ul>
938940
<li><a class="reference internal" href="#and-4-more-lines-to-print-out-the-data">And 4 more lines to print out the data</a></li>
941+
</ul>
942+
</li>
939943
<li><a class="reference internal" href="#or-with-a-callback-function-just-do">Or with a callback function just do</a></li>
940944
<li><a class="reference internal" href="#or-with-a-async-callback-function-just-do">Or with a async callback function just do</a></li>
941945
<li><a class="reference internal" href="#or-await-the-stream-data-in-an-asyncio-coroutine">Or await the stream data in an asyncio coroutine</a></li>
@@ -1105,7 +1109,7 @@ <h3>Navigation</h3>
11051109
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
11061110
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
11071111
See <a href="/license.html">License</a> for more information.<br />
1108-
Last updated on May 10 2024 at 18:59 (CET).
1112+
Last updated on May 10 2024 at 19:01 (CET).
11091113
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
11101114
<br />
11111115
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/search.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ <h3>Navigation</h3>
227227
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
228228
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
229229
See <a href="/license.html">License</a> for more information.<br />
230-
Last updated on May 10 2024 at 18:59 (CET).
230+
Last updated on May 10 2024 at 19:01 (CET).
231231
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
232232
<br />
233233
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/security.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ <h3>Navigation</h3>
344344
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
345345
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
346346
See <a href="/license.html">License</a> for more information.<br />
347-
Last updated on May 10 2024 at 18:59 (CET).
347+
Last updated on May 10 2024 at 19:01 (CET).
348348
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
349349
<br />
350350
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

0 commit comments

Comments
 (0)