Skip to content

Commit 1c03a38

Browse files
oliver-zehentleitneroliver-zehentleitner
committed
1.33.1
1 parent 4b241e0 commit 1c03a38

16 files changed

+1072
-1027
lines changed

‎CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to
66
[Semantic Versioning](http://semver.org/).
77

8-
## 1.33.0.dev (development stage/unreleased/unstable)
8+
## 1.33.1.dev (development stage/unreleased/unstable)
9+
10+
## 1.33.1
911
### Added
1012
- Logging websockets version on start up (logging level: INFO)
1113
### Changed

‎docs/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 713274858561bea65d2e702118df6653
3+
config: 10ebcc209006816846ea51019759a8a3
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/CHANGELOG.html

Lines changed: 766 additions & 739 deletions
Large diffs are not rendered by default.

‎docs/README.html

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>UNICORN Binance WebSocket API &#8212; unicorn-binance-websocket-api 1.33.0 documentation</title>
8+
<title>UNICORN Binance WebSocket API &#8212; unicorn-binance-websocket-api 1.33.1 documentation</title>
99
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="_static/pydoctheme.css" type="text/css" />
1111

@@ -48,7 +48,7 @@ <h3>Navigation</h3>
4848
<li><a href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api">unicorn-binance-websocket-api</a> &#187;</li>
4949

5050

51-
<a href="index.html">unicorn-binance-websocket-api 1.33.0 documentation</a> &#187;
51+
<a href="index.html">unicorn-binance-websocket-api 1.33.1 documentation</a> &#187;
5252

5353

5454
<li class="nav-item nav-item-this"><a href="">UNICORN Binance WebSocket API</a></li>
@@ -71,7 +71,8 @@ <h3>Navigation</h3>
7171
<a class="reference external" href="https://pepy.tech/project/unicorn-binance-websocket-api"><img alt="Downloads" src="https://pepy.tech/badge/unicorn-binance-websocket-api" /></a>
7272
<a class="reference external" href="https://pypi.org/project/unicorn-binance-websocket-api/"><img alt="PyPI - Wheel" src="https://img.shields.io/pypi/wheel/unicorn-binance-websocket-api.svg?label=PyPI%20wheel" /></a>
7373
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues"><img alt="PyPI - Status" src="https://img.shields.io/pypi/status/unicorn-binance-websocket-api.svg" /></a>
74-
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/actions/workflows/python-app.yml"><img alt="Python application" src="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/actions/workflows/python-app.yml/badge.svg" /></a><a class="reference external" href="https://lgtm.com/projects/g/oliver-zehentleitner/unicorn-binance-websocket-api/alerts/"><img alt="Total alerts" src="https://img.shields.io/lgtm/alerts/g/oliver-zehentleitner/unicorn-binance-websocket-api.svg?logo=lgtm&amp;logoWidth=18" /></a>
74+
<a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/actions/workflows/python-app.yml"><img alt="Python application" src="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/actions/workflows/python-app.yml/badge.svg" /></a>
75+
<a class="reference external" href="https://lgtm.com/projects/g/oliver-zehentleitner/unicorn-binance-websocket-api/alerts/"><img alt="Total alerts" src="https://img.shields.io/lgtm/alerts/g/oliver-zehentleitner/unicorn-binance-websocket-api.svg?logo=lgtm&amp;logoWidth=18" /></a>
7576
<a class="reference external" href="https://lgtm.com/projects/g/oliver-zehentleitner/unicorn-binance-websocket-api/context:python"><img alt="Language grade: Python" src="https://img.shields.io/lgtm/grade/python/g/oliver-zehentleitner/unicorn-binance-websocket-api.svg?logo=lgtm&amp;logoWidth=18" /></a>
7677
<a class="reference external" href="https://codecov.io/gh/oliver-zehentleitner/unicorn-binance-websocket-api"><img alt="codecov" src="https://codecov.io/gh/oliver-zehentleitner/unicorn-binance-websocket-api/branch/master/graph/badge.svg?token=Z6SEARA4W4" /></a>
7778
<a class="reference external" href="https://t.me/unicorndevs"><img alt="Telegram" src="https://img.shields.io/badge/chat-telegram-yellow.svg" /></a>
@@ -89,28 +90,28 @@ <h1>UNICORN Binance WebSocket API<a class="headerlink" href="#unicorn-binance-we
8990
<h2><a class="reference external" href="https://oliver-zehentleitner.github.io/unicorn-binance-websocket-api/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.unicorn_binance_websocket_api_manager.BinanceWebSocketApiManager.create_stream">Create a multiplex websocket connection</a> to Binance with just 3 lines of code:<a class="headerlink" href="#create-a-multiplex-websocket-connection-to-binance-with-just-3-lines-of-code" title="Permalink to this headline"></a></h2>
9091
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">unicorn_binance_websocket_api.unicorn_binance_websocket_api_manager</span> <span class="kn">import</span> <span class="n">BinanceWebSocketApiManager</span>
9192

92-
<span class="n">binance_websocket_api_manager</span> <span class="o">=</span> <span class="n">BinanceWebSocketApiManager</span><span class="p">(</span><span class="n">exchange</span><span class="o">=</span><span class="s2">&quot;binance.com&quot;</span><span class="p">)</span>
93-
<span class="n">binance_websocket_api_manager</span><span class="o">.</span><span class="n">create_stream</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="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>
93+
<span class="n">ubwa</span> <span class="o">=</span> <span class="n">BinanceWebSocketApiManager</span><span class="p">(</span><span class="n">exchange</span><span class="o">=</span><span class="s2">&quot;binance.com&quot;</span><span class="p">)</span>
94+
<span class="n">ubwa</span><span class="o">.</span><span class="n">create_stream</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="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>
9495
</pre></div>
9596
</div>
9697
</div>
9798
<div class="section" id="and-4-more-lines-to-print-the-receives">
9899
<h2>And 4 more lines to print the receives:<a class="headerlink" href="#and-4-more-lines-to-print-the-receives" title="Permalink to this headline"></a></h2>
99100
<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>
100-
<span class="n">oldest_stream_data_from_stream_buffer</span> <span class="o">=</span> <span class="n">binance_websocket_api_manager</span><span class="o">.</span><span class="n">pop_stream_data_from_stream_buffer</span><span class="p">()</span>
101-
<span class="k">if</span> <span class="n">oldest_stream_data_from_stream_buffer</span><span class="p">:</span>
102-
<span class="nb">print</span><span class="p">(</span><span class="n">oldest_stream_data_from_stream_buffer</span><span class="p">)</span>
101+
<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>
102+
<span class="k">if</span> <span class="n">oldest_data_from_stream_buffer</span><span class="p">:</span>
103+
<span class="nb">print</span><span class="p">(</span><span class="n">oldest_data_from_stream_buffer</span><span class="p">)</span>
103104
</pre></div>
104105
</div>
105106
<p>Basically that’s it, but there are more options:</p>
106107
</div>
107108
<div class="section" id="convert-received-raw-webstream-data-into-well-formed-python-dictionaries-with-unicornfy">
108109
<h2>Convert received raw webstream data into well-formed Python dictionaries with <a class="reference external" href="https://github.com/oliver-zehentleitner/unicorn-fy">UnicornFy</a>:<a class="headerlink" href="#convert-received-raw-webstream-data-into-well-formed-python-dictionaries-with-unicornfy" title="Permalink to this headline"></a></h2>
109-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">unicorn_fied_stream_data</span> <span class="o">=</span> <span class="n">UnicornFy</span><span class="o">.</span><span class="n">binance_com_websocket</span><span class="p">(</span><span class="n">oldest_stream_data_from_stream_buffer</span><span class="p">)</span>
110+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">unicorn_fied_stream_data</span> <span class="o">=</span> <span class="n">UnicornFy</span><span class="o">.</span><span class="n">binance_com_websocket</span><span class="p">(</span><span class="n">oldest_data_from_stream_buffer</span><span class="p">)</span>
110111
</pre></div>
111112
</div>
112113
<p>or</p>
113-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">binance_websocket_api_manager</span><span class="o">.</span><span class="n">create_stream</span><span class="p">([</span><span class="s1">&#39;trade&#39;</span><span class="p">],</span> <span class="p">[</span><span class="s1">&#39;btcusdt&#39;</span><span class="p">],</span> <span class="n">output</span><span class="o">=</span><span class="s2">&quot;UnicornFy&quot;</span><span class="p">)</span>
114+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ubwa</span><span class="o">.</span><span class="n">create_stream</span><span class="p">([</span><span class="s1">&#39;trade&#39;</span><span class="p">],</span> <span class="p">[</span><span class="s1">&#39;btcusdt&#39;</span><span class="p">],</span> <span class="n">output</span><span class="o">=</span><span class="s2">&quot;UnicornFy&quot;</span><span class="p">)</span>
114115
</pre></div>
115116
</div>
116117
</div>
@@ -119,11 +120,11 @@ <h2><a class="reference external" href="https://oliver-zehentleitner.github.io/u
119120
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">markets</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;engbtc&#39;</span><span class="p">,</span> <span class="s1">&#39;zileth&#39;</span><span class="p">]</span>
120121
<span class="n">channels</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;kline_5m&#39;</span><span class="p">,</span> <span class="s1">&#39;kline_15m&#39;</span><span class="p">,</span> <span class="s1">&#39;kline_30m&#39;</span><span class="p">,</span> <span class="s1">&#39;kline_1h&#39;</span><span class="p">,</span> <span class="s1">&#39;kline_12h&#39;</span><span class="p">,</span> <span class="s1">&#39;depth5&#39;</span><span class="p">]</span>
121122

122-
<span class="n">binance_websocket_api_manager</span><span class="o">.</span><span class="n">subscribe_to_stream</span><span class="p">(</span><span class="n">stream_id</span><span class="p">,</span> <span class="n">channels</span><span class="o">=</span><span class="n">channels</span><span class="p">,</span> <span class="n">markets</span><span class="o">=</span><span class="n">markets</span><span class="p">)</span>
123+
<span class="n">ubwa</span><span class="o">.</span><span class="n">subscribe_to_stream</span><span class="p">(</span><span class="n">stream_id</span><span class="p">,</span> <span class="n">channels</span><span class="o">=</span><span class="n">channels</span><span class="p">,</span> <span class="n">markets</span><span class="o">=</span><span class="n">markets</span><span class="p">)</span>
123124

124-
<span class="n">binance_websocket_api_manager</span><span class="o">.</span><span class="n">unsubscribe_from_stream</span><span class="p">(</span><span class="n">stream_id</span><span class="p">,</span> <span class="n">markets</span><span class="o">=</span><span class="n">markets</span><span class="p">)</span>
125+
<span class="n">ubwa</span><span class="o">.</span><span class="n">unsubscribe_from_stream</span><span class="p">(</span><span class="n">stream_id</span><span class="p">,</span> <span class="n">markets</span><span class="o">=</span><span class="n">markets</span><span class="p">)</span>
125126

126-
<span class="n">binance_websocket_api_manager</span><span class="o">.</span><span class="n">unsubscribe_from_stream</span><span class="p">(</span><span class="n">stream_id</span><span class="p">,</span> <span class="n">channels</span><span class="o">=</span><span class="n">channels</span><span class="p">)</span>
127+
<span class="n">ubwa</span><span class="o">.</span><span class="n">unsubscribe_from_stream</span><span class="p">(</span><span class="n">stream_id</span><span class="p">,</span> <span class="n">channels</span><span class="o">=</span><span class="n">channels</span><span class="p">)</span>
127128
</pre></div>
128129
</div>
129130
<p><a class="reference external" href="https://oliver-zehentleitner.github.io/unicorn-binance-websocket-api/unicorn_binance_websocket_api.html">Discover even more possibilities</a>
@@ -627,7 +628,7 @@ <h3>Navigation</h3>
627628
<li><a href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api">unicorn-binance-websocket-api</a> &#187;</li>
628629

629630

630-
<a href="index.html">unicorn-binance-websocket-api 1.33.0 documentation</a> &#187;
631+
<a href="index.html">unicorn-binance-websocket-api 1.33.1 documentation</a> &#187;
631632

632633

633634
<li class="nav-item nav-item-this"><a href="">UNICORN Binance WebSocket API</a></li>
@@ -642,7 +643,7 @@ <h3>Navigation</h3>
642643
&copy; <a href="copyright.html">Copyright</a> 2021, Oliver Zehentleitner.
643644
<br />
644645

645-
Last updated on Aug 30 2021 at 23:55 (CET).
646+
Last updated on Sep 19 2021 at 23:14 (CET).
646647
<a href="https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues">Found a bug</a>?
647648
<br />
648649

‎docs/_sources/CHANGELOG.md.txt

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,15 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to
66
[Semantic Versioning](http://semver.org/).
77

8-
## 1.33.0.dev (development stage/unreleased/unstable)
8+
## 1.33.1.dev (development stage/unreleased/unstable)
9+
10+
## 1.33.1
11+
### Added
12+
- Logging websockets version on start up (logging level: INFO)
13+
### Changed
14+
- `print_summary()` "most" to "peak".
15+
### Fixed
16+
- More accurate measurement of the received data quantity.
917

1018
## 1.33.0
1119
### Added

‎docs/_sources/README.md.txt

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/unicorn-binance-websocket-api.svg)](https://www.python.org/downloads/)
44
[![Downloads](https://pepy.tech/badge/unicorn-binance-websocket-api)](https://pepy.tech/project/unicorn-binance-websocket-api)
55
[![PyPI - Wheel](https://img.shields.io/pypi/wheel/unicorn-binance-websocket-api.svg?label=PyPI%20wheel)](https://pypi.org/project/unicorn-binance-websocket-api/)
6-
[![PyPI - Status](https://img.shields.io/pypi/status/unicorn-binance-websocket-api.svg)](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues)
7-
[![Python application](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/actions/workflows/python-app.yml/badge.svg)](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/actions/workflows/python-app.yml)[![Total alerts](https://img.shields.io/lgtm/alerts/g/oliver-zehentleitner/unicorn-binance-websocket-api.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/oliver-zehentleitner/unicorn-binance-websocket-api/alerts/)
6+
[![PyPI - Status](https://img.shields.io/pypi/status/unicorn-binance-websocket-api.svg)](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/issues)
7+
[![Python application](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/actions/workflows/python-app.yml/badge.svg)](https://github.com/oliver-zehentleitner/unicorn-binance-websocket-api/actions/workflows/python-app.yml)
8+
[![Total alerts](https://img.shields.io/lgtm/alerts/g/oliver-zehentleitner/unicorn-binance-websocket-api.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/oliver-zehentleitner/unicorn-binance-websocket-api/alerts/)
89
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/oliver-zehentleitner/unicorn-binance-websocket-api.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/oliver-zehentleitner/unicorn-binance-websocket-api/context:python)
910
[![codecov](https://codecov.io/gh/oliver-zehentleitner/unicorn-binance-websocket-api/branch/master/graph/badge.svg?token=Z6SEARA4W4)](https://codecov.io/gh/oliver-zehentleitner/unicorn-binance-websocket-api)
1011
[![Telegram](https://img.shields.io/badge/chat-telegram-yellow.svg)](https://t.me/unicorndevs)
@@ -26,37 +27,37 @@ Part of ['UNICORN Binance Suite'](https://github.com/oliver-zehentleitner/unicor
2627
```
2728
from unicorn_binance_websocket_api.unicorn_binance_websocket_api_manager import BinanceWebSocketApiManager
2829

29-
binance_websocket_api_manager = BinanceWebSocketApiManager(exchange="binance.com")
30-
binance_websocket_api_manager.create_stream(['trade', 'kline_1m'], ['btcusdt', 'bnbbtc', 'ethbtc'])
30+
ubwa = BinanceWebSocketApiManager(exchange="binance.com")
31+
ubwa.create_stream(['trade', 'kline_1m'], ['btcusdt', 'bnbbtc', 'ethbtc'])
3132
```
3233
### And 4 more lines to print the receives:
3334
```
3435
while True:
35-
oldest_stream_data_from_stream_buffer = binance_websocket_api_manager.pop_stream_data_from_stream_buffer()
36-
if oldest_stream_data_from_stream_buffer:
37-
print(oldest_stream_data_from_stream_buffer)
36+
oldest_data_from_stream_buffer = ubwa.pop_stream_data_from_stream_buffer()
37+
if oldest_data_from_stream_buffer:
38+
print(oldest_data_from_stream_buffer)
3839
```
3940

4041
Basically that's it, but there are more options:
4142

4243
### Convert received raw webstream data into well-formed Python dictionaries with [UnicornFy](https://github.com/oliver-zehentleitner/unicorn-fy):
4344
```
44-
unicorn_fied_stream_data = UnicornFy.binance_com_websocket(oldest_stream_data_from_stream_buffer)
45+
unicorn_fied_stream_data = UnicornFy.binance_com_websocket(oldest_data_from_stream_buffer)
4546
```
4647
or
4748
```
48-
binance_websocket_api_manager.create_stream(['trade'], ['btcusdt'], output="UnicornFy")
49+
ubwa.create_stream(['trade'], ['btcusdt'], output="UnicornFy")
4950
```
5051
### [Subscribe](https://oliver-zehentleitner.github.io/unicorn-binance-websocket-api/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.unicorn_binance_websocket_api_manager.BinanceWebSocketApiManager.subscribe_to_stream) / [unsubscribe](https://oliver-zehentleitner.github.io/unicorn-binance-websocket-api/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.unicorn_binance_websocket_api_manager.BinanceWebSocketApiManager.unsubscribe_from_stream) new markets and channels:
5152
```
5253
markets = ['engbtc', 'zileth']
5354
channels = ['kline_5m', 'kline_15m', 'kline_30m', 'kline_1h', 'kline_12h', 'depth5']
5455

55-
binance_websocket_api_manager.subscribe_to_stream(stream_id, channels=channels, markets=markets)
56+
ubwa.subscribe_to_stream(stream_id, channels=channels, markets=markets)
5657

57-
binance_websocket_api_manager.unsubscribe_from_stream(stream_id, markets=markets)
58+
ubwa.unsubscribe_from_stream(stream_id, markets=markets)
5859

59-
binance_websocket_api_manager.unsubscribe_from_stream(stream_id, channels=channels)
60+
ubwa.unsubscribe_from_stream(stream_id, channels=channels)
6061
```
6162

6263
[Discover even more possibilities](https://oliver-zehentleitner.github.io/unicorn-binance-websocket-api/unicorn_binance_websocket_api.html)

‎docs/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '1.33.0',
3+
VERSION: '1.33.1',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

0 commit comments

Comments
 (0)