No project description provided
Project description
UNICORN Binance Local Depth Cache
Description | Installation | How To | Documentation | Examples | Change Log | Wiki | Social | Notifications | Bugs | Contributing | Commercial Support
A local Binance DepthCache for Python that supports multiple depth caches in one instance in a easy, fast, flexible, robust and fully-featured way.
Part of 'UNICORN Binance Suite'.
Create a local depth cache of Binance with just 3 lines of code:
import unicorn_binance_local_depth_cache
ubldc = unicorn_binance_local_depth_cache.BinanceLocalDepthCacheManager(exchange="binance.com")
ubldc.create_depth_cache("LUNABTC")
And get the depth with:
asks = ubldc.get_asks("LUNABTC")
bids = ubldc.get_bids("LUNABTC")
Catch an exception if the cache is out of sync while accessing its data
try:
print(f"Top 10 asks: {ubldc.get_asks(market=market)[:10]}")
print(f"Top 10 bids: {ubldc.get_bids(market=market)[:10]}")
except DepthCacheOutOfSync as error_msg:
print(f"ERROR: {error_msg}")
Get the right logger
logging.getLogger("unicorn_binance_local_depth_cache")
Description
The Python package UNICORN Binance Local Depth Cache provides a local depth cache for the Binance Exchanges Binance - more are coming soon.
The algorythm was designed according to these instructions: How to manage a local order book correctly
What are the benefits of the UNICORN Binance Local Depth Cache?
- 100% auto-reconnect!
- Supported Exchanges
Exchange | Exchange string |
---|---|
Binance | BinanceWebSocketApiManager(exchange="binance.com") |
More are comming soon | - |
- Get notified if a dept cache is out of sync
- If a depth cache is out of sync it gets refreshed automatically within a few seconds
- Create multiple depth caches within a single instance
- Each dept_cache is processed in a separate thread
- Start multiple caches with just one command:
create_depth_caches(['lunabtc', 'lunausdt'])
Installation and Upgrade
The module requires Python 3.7 or above.
The current dependencies are listed here.
If you run into errors during the installation take a look here.
A wheel of the latest release with PIP from PyPI
pip install unicorn-binance-local-depth-cache --upgrade
From source of the latest release with PIP from Github
Linux, macOS, ...
Run in bash:
pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/archive/$(curl -s https://api.github.com/repos/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade
Windows
Use the below command with the version (such as 0.1.0) you determined here:
pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/archive/0.1.0.tar.gz --upgrade
From the latest source (dev-stage) with PIP from Github
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-local-depth-cache/tarball/master --upgrade
Conda environment, Virtualenv or plain Python
Download the latest release or the current master branch and use:
- ./environment.yml
- ./requirements.txt
- ./setup.py
Change Log
https://lucit-systems-and-development.github.io/unicorn-binance-local-depth-cache/CHANGELOG.html
Documentation
Examples
- example_depth_cache.py
- example_refresh_interval.py
- example_shared_ubwa_instance.py
- example_update_interval.py
- example_version_of_this_package.py
Project Homepage
https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache
Wiki
https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/wiki
Social
Receive Notifications
To receive notifications on available updates you can
the repository on GitHub, write your
own script
with using
is_update_available()
.
Follow us on Twitter or on Facebook for general news about the unicorn-binance-suite!
To receive news (like inspection windows/maintenance) about the Binance API`s subscribe to their telegram groups:
- https://t.me/binance_api_announcements
- https://t.me/binance_api_english
- https://t.me/BinanceExchange
- https://t.me/Binance_USA
- https://t.me/Binance_JEX_EN
- https://t.me/BinanceDEXchange
How to report Bugs or suggest Improvements?
List of planned features - click if you need one of them or suggest a new feature!
Before you report a bug, try the latest release. If the issue still exists, provide the error trace, OS and Python version and explain how to reproduce the error. A demo script is appreciated.
If you dont find an issue related to your topic, please open a new issue!
Contributing
UNICORN Binance Local Depth Cache is an open source project which welcomes contributions which can be anything from simple documentation fixes and reporting dead links to new features. To contribute follow this guide.
Contributors
We open source!
Commercial Support
Do you need a developer, operator or consultant?
Contact me for a non-binding initial consultation via my company LUCIT from Vienna (Austria) or via Telegram.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for unicorn_binance_local_depth_cache-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9d45d76e754314809c7c79f67487d6c5f54994caec9deee69f1b25ee663aa84 |
|
MD5 | 320369f23c9caf35b3623da48ed40afd |
|
BLAKE2b-256 | 3ff9f29912d64bc94b9009ac421ea8fdbe1b49d7559cf0622aef6ee605a243f5 |