Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oliver-zehentleitner committed May 14, 2024
1 parent 9d493e7 commit bbc91e7
Show file tree
Hide file tree
Showing 18 changed files with 42 additions and 21 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,10 @@ Without `with`, you must explicitly execute `ubra.stop_manager()` yourself.
ubra.stop_manager()
```

## More?
[Discover even more possibilities](https://unicorn-binance-rest-api.docs.lucit.tech/unicorn_binance_rest_api.html)
or try our [examples](#examples)!

## Description
The Python module [UNICORN Binance REST API](https://www.lucit.tech/unicorn-binance-rest-api.html)
provides an API to the Binance REST API`s of
Expand Down
4 changes: 4 additions & 0 deletions dev/sphinx/source/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,10 @@ Without `with`, you must explicitly execute `ubra.stop_manager()` yourself.
ubra.stop_manager()
```

## More?
[Discover even more possibilities](https://unicorn-binance-rest-api.docs.lucit.tech/unicorn_binance_rest_api.html)
or try our [examples](#examples)!

## Description
The Python module [UNICORN Binance REST API](https://www.lucit.tech/unicorn-binance-rest-api.html)
provides an API to the Binance REST API`s of
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,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 14 2024 at 18:36 (CET).
Last updated on May 14 2024 at 22:30 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
13 changes: 7 additions & 6 deletions docs/_modules/unicorn_binance_rest_api/manager.html
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,9 @@ <h1>Source code for unicorn_binance_rest_api.manager</h1><div class="highlight">


<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-rest-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.5.1&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_rest_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.5.1.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_rest_api&quot;</span><span class="p">)</span>

<span class="n">logger</span> <span class="o">=</span> <span class="n">__logger__</span>


Expand Down Expand Up @@ -550,7 +551,7 @@ <h1>Source code for unicorn_binance_rest_api.manager</h1><div class="highlight">

<span class="bp">self</span><span class="o">.</span><span class="n">API_KEY</span> <span class="o">=</span> <span class="n">api_key</span>
<span class="bp">self</span><span class="o">.</span><span class="n">API_SECRET</span> <span class="o">=</span> <span class="n">api_secret</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_update_check_github</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;timestamp&#39;</span><span class="p">:</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> <span class="s1">&#39;status&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;tag_name&#39;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">}}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_update_check_github</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;timestamp&#39;</span><span class="p">:</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> <span class="s1">&#39;status&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;tag_name&#39;</span><span class="p">:</span> <span class="kc">None</span><span class="p">}}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_requests_params</span> <span class="o">=</span> <span class="n">requests_params</span>
<span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">session</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_init_session</span><span class="p">()</span>
Expand Down Expand Up @@ -823,13 +824,13 @@ <h1>Source code for unicorn_binance_rest_api.manager</h1><div class="highlight">

<div class="viewcode-block" id="BinanceRestApiManager.get_latest_version">
<a class="viewcode-back" href="../../unicorn_binance_rest_api.html#unicorn_binance_rest_api.manager.BinanceRestApiManager.get_latest_version">[docs]</a>
<span class="k">def</span> <span class="nf">get_latest_version</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">get_latest_version</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get the version of the latest available release (cache time 1 hour)</span>
<span class="sd"> :return: str or False</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># Do a fresh request if status is None or last timestamp is older 1 hour</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_update_check_github</span><span class="p">[</span><span class="s1">&#39;status&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;tag_name&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="s2">&quot;&quot;</span> <span class="ow">or</span> \
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_update_check_github</span><span class="p">[</span><span class="s1">&#39;status&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;tag_name&#39;</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> \
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">last_update_check_github</span><span class="p">[</span><span class="s1">&#39;timestamp&#39;</span><span class="p">]</span><span class="o">+</span><span class="p">(</span><span class="mi">60</span><span class="o">*</span><span class="mi">60</span><span class="p">)</span> <span class="o">&lt;</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_update_check_github</span><span class="p">[</span><span class="s1">&#39;status&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_latest_release_info</span><span class="p">()</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_update_check_github</span><span class="p">[</span><span class="s1">&#39;status&#39;</span><span class="p">]:</span>
Expand Down Expand Up @@ -8169,7 +8170,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 14 2024 at 18:36 (CET).
Last updated on May 14 2024 at 22:30 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
4 changes: 4 additions & 0 deletions docs/_sources/readme.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,10 @@ Without `with`, you must explicitly execute `ubra.stop_manager()` yourself.
ubra.stop_manager()
```

## More?
[Discover even more possibilities](https://unicorn-binance-rest-api.docs.lucit.tech/unicorn_binance_rest_api.html)
or try our [examples](#examples)!

## Description
The Python module [UNICORN Binance REST API](https://www.lucit.tech/unicorn-binance-rest-api.html)
provides an API to the Binance REST API`s of
Expand Down
2 changes: 1 addition & 1 deletion docs/changelog.html
Original file line number Diff line number Diff line change
Expand Up @@ -1097,7 +1097,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 14 2024 at 18:36 (CET).
Last updated on May 14 2024 at 22:30 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/code_of_conduct.html
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,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 14 2024 at 18:36 (CET).
Last updated on May 14 2024 at 22:30 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,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 14 2024 at 18:36 (CET).
Last updated on May 14 2024 at 22:30 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -1103,7 +1103,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 14 2024 at 18:36 (CET).
Last updated on May 14 2024 at 22:30 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
3 changes: 2 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ <h1>Welcome to unicorn-binance-rest-api’s documentation!<a class="headerlink"
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="readme.html#stop-ubra-after-usage-to-avoid-memory-leaks">Stop <code class="docutils literal notranslate"><span class="pre">ubra</span></code> after usage to avoid memory leaks</a></li>
<li class="toctree-l2"><a class="reference internal" href="readme.html#more">More?</a></li>
<li class="toctree-l2"><a class="reference internal" href="readme.html#description">Description</a><ul>
<li class="toctree-l3"><a class="reference internal" href="readme.html#what-are-the-benefits-of-the-unicorn-binance-rest-api">What are the benefits of the UNICORN Binance REST API?</a></li>
</ul>
Expand Down Expand Up @@ -522,7 +523,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 14 2024 at 18:36 (CET).
Last updated on May 14 2024 at 22:30 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/license.html
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,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 14 2024 at 18:36 (CET).
Last updated on May 14 2024 at 22:30 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -635,7 +635,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 14 2024 at 18:36 (CET).
Last updated on May 14 2024 at 22:30 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,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 14 2024 at 18:36 (CET).
Last updated on May 14 2024 at 22:30 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
9 changes: 8 additions & 1 deletion docs/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
</ul>
</li>
<li><a class="reference internal" href="#stop-ubra-after-usage-to-avoid-memory-leaks">Stop <code class="docutils literal notranslate"><span class="pre">ubra</span></code> after usage to avoid memory leaks</a></li>
<li><a class="reference internal" href="#more">More?</a></li>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#what-are-the-benefits-of-the-unicorn-binance-rest-api">What are the benefits of the UNICORN Binance REST API?</a></li>
</ul>
Expand Down Expand Up @@ -338,6 +339,11 @@ <h2>Stop <code class="docutils literal notranslate"><span class="pre">ubra</span
</pre></div>
</div>
</section>
<section id="more">
<h2>More?<a class="headerlink" href="#more" title="Link to this heading"></a></h2>
<p><a class="reference external" href="https://unicorn-binance-rest-api.docs.lucit.tech/unicorn_binance_rest_api.html">Discover even more possibilities</a>
or try our <a class="reference internal" href="#examples">examples</a>!</p>
</section>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Link to this heading"></a></h2>
<p>The Python module <a class="reference external" href="https://www.lucit.tech/unicorn-binance-rest-api.html">UNICORN Binance REST API</a>
Expand Down Expand Up @@ -696,6 +702,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
</ul>
</li>
<li><a class="reference internal" href="#stop-ubra-after-usage-to-avoid-memory-leaks">Stop <code class="docutils literal notranslate"><span class="pre">ubra</span></code> after usage to avoid memory leaks</a></li>
<li><a class="reference internal" href="#more">More?</a></li>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#what-are-the-benefits-of-the-unicorn-binance-rest-api">What are the benefits of the UNICORN Binance REST API?</a></li>
</ul>
Expand Down Expand Up @@ -850,7 +857,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 14 2024 at 18:36 (CET).
Last updated on May 14 2024 at 22:30 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,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 14 2024 at 18:36 (CET).
Last updated on May 14 2024 at 22:30 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/security.html
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,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 14 2024 at 18:36 (CET).
Last updated on May 14 2024 at 22:30 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
Loading

0 comments on commit bbc91e7

Please sign in to comment.