Skip to content

Commit

Permalink
2.9.0 RC + docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oliver-zehentleitner committed Nov 14, 2024
1 parent 4aafdda commit 933ecdc
Show file tree
Hide file tree
Showing 30 changed files with 1,971 additions and 2,019 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build_wheels.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ jobs:
generate_release_notes: true
name: unicorn-binance-websocket-api
prerelease: false
tag_name: 2.10.0
tag_name: 2.9.0
token: ${{ secrets.GITHUB_TOKEN }}

- name: Create PyPi Release
Expand Down
14 changes: 4 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p

[Discussions about unicorn-binance-websocket-api releases!](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/discussions/categories/releases)

[How to upgrade to the latest version!](https://unicorn-binance-websocket-api.docs.lucit.tech/readme.html#installation-and-upgrade)
[How to upgrade to the latest version!](https://unicorn-binance-websocket-api.docs.lucit.tech/readme.html#installation-and-upgrade)

## 2.10.0.dev (development stage/unreleased/unstable)
## 2.9.0.dev (development stage/unreleased/unstable)

## 2.10.0
## 2.9.0
### Added
- New `Websocket API Spot` functions:
- `manager.api.spot.cancel_and_replace_order()`
Expand All @@ -36,20 +36,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
- `manager.api.futures.get_server_time()`
- `manager.api.futures.modify_order()`
- `manager.api.futures.ping()`
- Error handling if someone tries to use the WebSocket API Feature with an unsupported exchange.
### Changed
- ujson has been replaced by orjson (faster!)
- Websocket API functions are no longer available under `manager.api` but under `manager.api.spot`. In addition, there
is now also `manager.api.futures`.
- No more use of deepcopy in ws api (faster!)
- Enhanced logging in WS API

## 2.9.0
### Added
- Support for 'binance.com-futures' WebSocket API.
- Error handling if someone tries to use the WebSocket API Feature with an unsupported exchange.
### Fixed
- Type Error of returned value of `api.create_order()` and `api.create_test_order()`.

## 2.8.1
### Changed
- Log levels in `send_with_stream()` to be less verbose.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,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.10.0) you determined
Use the below command with the version (such as 2.9.0) 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.10.0.tar.gz --upgrade`
`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/2.9.0.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.10.0
2.9.0
meta.yaml,pyproject.toml,setup.py,README.md,.github/workflows/build_wheels.yml,dev/sphinx/source/conf.py,unicorn_binance_websocket_api/manager.py
14 changes: 4 additions & 10 deletions dev/sphinx/source/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p

[Discussions about unicorn-binance-websocket-api releases!](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/discussions/categories/releases)

[How to upgrade to the latest version!](https://unicorn-binance-websocket-api.docs.lucit.tech/readme.html#installation-and-upgrade)
[How to upgrade to the latest version!](https://unicorn-binance-websocket-api.docs.lucit.tech/readme.html#installation-and-upgrade)

## 2.10.0.dev (development stage/unreleased/unstable)
## 2.9.0.dev (development stage/unreleased/unstable)

## 2.10.0
## 2.9.0
### Added
- New `Websocket API Spot` functions:
- `manager.api.spot.cancel_and_replace_order()`
Expand All @@ -36,20 +36,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
- `manager.api.futures.get_server_time()`
- `manager.api.futures.modify_order()`
- `manager.api.futures.ping()`
- Error handling if someone tries to use the WebSocket API Feature with an unsupported exchange.
### Changed
- ujson has been replaced by orjson (faster!)
- Websocket API functions are no longer available under `manager.api` but under `manager.api.spot`. In addition, there
is now also `manager.api.futures`.
- No more use of deepcopy in ws api (faster!)
- Enhanced logging in WS API

## 2.9.0
### Added
- Support for 'binance.com-futures' WebSocket API.
- Error handling if someone tries to use the WebSocket API Feature with an unsupported exchange.
### Fixed
- Type Error of returned value of `api.create_order()` and `api.create_test_order()`.

## 2.8.1
### Changed
- Log levels in `send_with_stream()` to be less verbose.
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.10.0'
release = '2.9.0'

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

Expand Down
4 changes: 2 additions & 2 deletions dev/sphinx/source/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,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.10.0) you determined
Use the below command with the version (such as 2.9.0) 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.10.0.tar.gz --upgrade`
`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/2.9.0.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 docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 2787ad24273029e33ed6ce644f0bdeaa
config: da9f97396f6bd67258066a483f217a50
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 1 addition & 1 deletion docs/.buildinfo.bak
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d250c15ae63cde9bb6cd52f47021e5e4
config: 2787ad24273029e33ed6ce644f0bdeaa
tags: 645f666f9bcd5a90fca523b33c5a78b7
4 changes: 2 additions & 2 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.10.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Overview: module code &#8212; unicorn-binance-websocket-api 2.9.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" />
Expand Down Expand Up @@ -255,7 +255,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 Nov 14 2024 at 11:42 (CET).
Last updated on Nov 14 2024 at 11:47 (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> 8.1.3.
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/unicorn_binance_websocket_api/manager.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.manager &#8212; unicorn-binance-websocket-api 2.10.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>unicorn_binance_websocket_api.manager &#8212; unicorn-binance-websocket-api 2.9.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" />
Expand Down Expand Up @@ -203,7 +203,7 @@ <h1>Source code for unicorn_binance_websocket_api.manager</h1><div class="highli
<span class="kn">import</span> <span class="nn">websockets</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.10.0.dev&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.9.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>
Expand Down Expand Up @@ -5457,7 +5457,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 Nov 14 2024 at 11:32 (CET).
Last updated on Nov 14 2024 at 11:47 (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> 8.1.3.
Expand Down
14 changes: 4 additions & 10 deletions docs/_sources/changelog.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p

[Discussions about unicorn-binance-websocket-api releases!](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/discussions/categories/releases)

[How to upgrade to the latest version!](https://unicorn-binance-websocket-api.docs.lucit.tech/readme.html#installation-and-upgrade)
[How to upgrade to the latest version!](https://unicorn-binance-websocket-api.docs.lucit.tech/readme.html#installation-and-upgrade)

## 2.10.0.dev (development stage/unreleased/unstable)
## 2.9.0.dev (development stage/unreleased/unstable)

## 2.10.0
## 2.9.0
### Added
- New `Websocket API Spot` functions:
- `manager.api.spot.cancel_and_replace_order()`
Expand All @@ -36,20 +36,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
- `manager.api.futures.get_server_time()`
- `manager.api.futures.modify_order()`
- `manager.api.futures.ping()`
- Error handling if someone tries to use the WebSocket API Feature with an unsupported exchange.
### Changed
- ujson has been replaced by orjson (faster!)
- Websocket API functions are no longer available under `manager.api` but under `manager.api.spot`. In addition, there
is now also `manager.api.futures`.
- No more use of deepcopy in ws api (faster!)
- Enhanced logging in WS API

## 2.9.0
### Added
- Support for 'binance.com-futures' WebSocket API.
- Error handling if someone tries to use the WebSocket API Feature with an unsupported exchange.
### Fixed
- Type Error of returned value of `api.create_order()` and `api.create_test_order()`.

## 2.8.1
### Changed
- Log levels in `send_with_stream()` to be less verbose.
Expand Down
4 changes: 2 additions & 2 deletions docs/_sources/readme.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,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.10.0) you determined
Use the below command with the version (such as 2.9.0) 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.10.0.tar.gz --upgrade`
`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/2.9.0.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
Loading

0 comments on commit 933ecdc

Please sign in to comment.