Skip to content

Commit

Permalink
2.8.1 RC
Browse files Browse the repository at this point in the history
  • Loading branch information
oliver-zehentleitner committed Nov 1, 2024
1 parent 2a45cfb commit 38a58fa
Show file tree
Hide file tree
Showing 37 changed files with 2,148 additions and 2,132 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build_wheels.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ jobs:
generate_release_notes: true
name: unicorn-binance-websocket-api
prerelease: false
tag_name: 2.8.0
tag_name: 2.8.1
token: ${{ secrets.GITHUB_TOKEN }}

- name: Create PyPi Release
Expand Down
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ 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.8.0.dev (development stage/unreleased/unstable)
## 2.8.1.dev (development stage/unreleased/unstable)

## 2.8.1
### Changed
- Log levels in `send_with_stream()` to be less verbose.
### Fixed
- `AttributeError: 'NoneType' object has no attribute 'get'` in `get_latest_version()`.

## 2.8.0
### Added
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -487,10 +487,10 @@ Run in bash:
`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/$(curl -s https://api.github.com/repos/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade`

#### Windows
Use the below command with the version (such as 2.8.0) you determined
Use the below command with the version (such as 2.8.1) you determined
[here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/releases/latest):

`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/2.8.0.tar.gz --upgrade`
`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/2.8.1.tar.gz --upgrade`
### From the latest source (dev-stage) with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api)
This is not a release version and can not be considered to be stable!

Expand Down
2 changes: 1 addition & 1 deletion dev/set_version_config.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
2.8.0
2.8.1
meta.yaml,pyproject.toml,setup.py,README.md,.github/workflows/build_wheels.yml,dev/sphinx/source/conf.py,unicorn_binance_websocket_api/manager.py
Empty file modified dev/sphinx/create_docs.sh
100644 → 100755
Empty file.
Empty file modified dev/sphinx/install_sphinx.sh
100644 → 100755
Empty file.
8 changes: 7 additions & 1 deletion dev/sphinx/source/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ 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.8.0.dev (development stage/unreleased/unstable)
## 2.8.1.dev (development stage/unreleased/unstable)

## 2.8.1
### Changed
- Log levels in `send_with_stream()` to be less verbose.
### Fixed
- `AttributeError: 'NoneType' object has no attribute 'get'` in `get_latest_version()`.

## 2.8.0
### Added
Expand Down
2 changes: 1 addition & 1 deletion dev/sphinx/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = '2.8.0'
release = '2.8.1'

html_last_updated_fmt = "%b %d %Y at %H:%M (CET)"

Expand Down
23 changes: 7 additions & 16 deletions dev/sphinx/source/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ async def main():
stream_label="TRADES",
process_asyncio_queue=process_asyncio_queue)
while not ubwa.is_manager_stopping():
await asyncio.sleep(1)
await asyncio.sleep(1)
with BinanceWebSocketApiManager(exchange='binance.com') as ubwa:
try:
Expand Down Expand Up @@ -334,6 +334,8 @@ parameter of
to control the output format.

- Helpful management features like
[`clear_asyncio_queue()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.clear_asyncio_queue),
[`clear_stream_buffer()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.clear_stream_buffer),
[`get_binance_api_status()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_binance_api_status),
[`get_current_receiving_speed()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_current_receiving_speed),
[`get_errors_from_endpoints()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_errors_from_endpoints),
Expand All @@ -357,7 +359,6 @@ to control the output format.
[`set_ringbuffer_error_max_size()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.set_ringbuffer_error_max_size),
[`subscribe_to_stream()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.subscribe_to_stream),
[`stop_stream()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.stop_stream),
[`stop_manager_with_all_streams()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.stop_manager_with_all_streams),
[`unsubscribe_from_stream()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.unsubscribe_from_stream),
[`wait_till_stream_has_started()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.wait_till_stream_has_started)
and many more! Explore them [here](https://unicorn-binance-websocket-api.docs.lucit.tech/modules.html).
Expand Down Expand Up @@ -404,8 +405,8 @@ If you like the project, please [![star](https://raw.githubusercontent.com/lucit
[GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api)!

## Live Demo
This live demo script is streaming from [binance.com](https://www.binance.com) and runs on a *cx31* virtual
machine of [HETZNER CLOUD](https://www.hetzner.com) - [get 20 EUR starting credit!](https://hetzner.cloud/?ref=rKgYRMq0l8fd)
This live demo script is streaming from [binance.com](https://www.binance.com) and runs on a *CCX13* virtual
machine of [HETZNER CLOUD](https://hetzner.cloud/?ref=rKgYRMq0l8fd)

[Open live monitor!](https://www.lucit.tech/unicorn-binance-websocket-api-live-demo.html)

Expand Down Expand Up @@ -486,25 +487,15 @@ Run in bash:
`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/$(curl -s https://api.github.com/repos/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade`

#### Windows
Use the below command with the version (such as 2.8.0) you determined
Use the below command with the version (such as 2.8.1) you determined
[here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/releases/latest):

`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/2.8.0.tar.gz --upgrade`
`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/2.8.1.tar.gz --upgrade`
### From the latest source (dev-stage) with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api)
This is not a release version and can not be considered to be stable!

`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/tarball/master --upgrade`

### [Conda environment](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html), [Virtualenv](https://virtualenv.pypa.io/en/latest/) or plain [Python](https://www.python.org)
Download the [latest release](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/releases/latest)
or the [current master branch](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/master.zip)
and use:

- ./environment.yml
- ./pyproject.toml
- ./requirements.txt
- ./setup.py

## Change Log
[https://unicorn-binance-websocket-api.docs.lucit.tech/changelog.html](https://unicorn-binance-websocket-api.docs.lucit.tech/changelog.html)

Expand Down
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 2378c4895ab8bf9c492f28e3df6cc630
config: fd133eda891a50821eb39e080c87ce22
tags: 645f666f9bcd5a90fca523b33c5a78b7
12 changes: 6 additions & 6 deletions docs/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; unicorn-binance-websocket-api 2.8.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Overview: module code &#8212; unicorn-binance-websocket-api 2.8.1 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" />
Expand Down Expand Up @@ -98,7 +98,7 @@ <h3>GitHub</h3>
</div>
</div>

<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand Down Expand Up @@ -156,7 +156,7 @@ <h1>All modules for which code is available</h1>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo">
<div style="text-align: center;">
Expand Down Expand Up @@ -212,7 +212,7 @@ <h3>GitHub</h3>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand Down Expand Up @@ -254,10 +254,10 @@ <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 16 2024 at 22:48 (CET).
Last updated on Nov 01 2024 at 11:34 (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.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
with <a href="https://github.com/LUCIT-Systems-and-Development/python-docs-theme-lucit">python-docs-theme-lucit</a>
by <a href="https://www.lucit.tech">LUCIT Systems and Development</a>.
</div>
Expand Down
12 changes: 6 additions & 6 deletions docs/_modules/unicorn_binance_websocket_api/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.api &#8212; unicorn-binance-websocket-api 2.8.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>unicorn_binance_websocket_api.api &#8212; unicorn-binance-websocket-api 2.8.1 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" />
Expand Down Expand Up @@ -98,7 +98,7 @@ <h3>GitHub</h3>
</div>
</div>

<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand Down Expand Up @@ -2142,7 +2142,7 @@ <h1>Source code for unicorn_binance_websocket_api.api</h1><div class="highlight"
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo">
<div style="text-align: center;">
Expand Down Expand Up @@ -2198,7 +2198,7 @@ <h3>GitHub</h3>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand Down Expand Up @@ -2241,10 +2241,10 @@ <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 16 2024 at 22:48 (CET).
Last updated on Nov 01 2024 at 11:34 (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.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
with <a href="https://github.com/LUCIT-Systems-and-Development/python-docs-theme-lucit">python-docs-theme-lucit</a>
by <a href="https://www.lucit.tech">LUCIT Systems and Development</a>.
</div>
Expand Down
12 changes: 6 additions & 6 deletions docs/_modules/unicorn_binance_websocket_api/connection.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.8.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.8.1 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" />
Expand Down Expand Up @@ -98,7 +98,7 @@ <h3>GitHub</h3>
</div>
</div>

<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand Down Expand Up @@ -370,7 +370,7 @@ <h1>Source code for unicorn_binance_websocket_api.connection</h1><div class="hig
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo">
<div style="text-align: center;">
Expand Down Expand Up @@ -426,7 +426,7 @@ <h3>GitHub</h3>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand Down Expand Up @@ -469,10 +469,10 @@ <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 16 2024 at 22:48 (CET).
Last updated on Nov 01 2024 at 11:34 (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.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
with <a href="https://github.com/LUCIT-Systems-and-Development/python-docs-theme-lucit">python-docs-theme-lucit</a>
by <a href="https://www.lucit.tech">LUCIT Systems and Development</a>.
</div>
Expand Down
12 changes: 6 additions & 6 deletions docs/_modules/unicorn_binance_websocket_api/exceptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.exceptions &#8212; unicorn-binance-websocket-api 2.8.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>unicorn_binance_websocket_api.exceptions &#8212; unicorn-binance-websocket-api 2.8.1 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" />
Expand Down Expand Up @@ -98,7 +98,7 @@ <h3>GitHub</h3>
</div>
</div>

<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand Down Expand Up @@ -242,7 +242,7 @@ <h1>Source code for unicorn_binance_websocket_api.exceptions</h1><div class="hig
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo">
<div style="text-align: center;">
Expand Down Expand Up @@ -298,7 +298,7 @@ <h3>GitHub</h3>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand Down Expand Up @@ -341,10 +341,10 @@ <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 16 2024 at 22:48 (CET).
Last updated on Nov 01 2024 at 11:34 (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.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
with <a href="https://github.com/LUCIT-Systems-and-Development/python-docs-theme-lucit">python-docs-theme-lucit</a>
by <a href="https://www.lucit.tech">LUCIT Systems and Development</a>.
</div>
Expand Down
Loading

0 comments on commit 38a58fa

Please sign in to comment.