UNICORN Binance DepthCache Cluster

The ubdcc package is the all-in-one installer and cluster manager for the UNICORN Binance DepthCache Cluster.

What you get

• All components installed: ubdcc-mgmt, ubdcc-restapi, ubdcc-dcn and their dependencies
• ubdcc command: Cluster manager to start, stop and monitor your UBDCC instance (work in progress)

Quick Start

pip install ubdcc

This installs everything you need. Start the cluster:

ubdcc start --dcn 4

This starts 1 mgmt + 1 restapi + 4 DCN processes and drops you into an interactive console where you can monitor and manage the cluster (status, stop, restart <name>, help).

The REST API is available at http://127.0.0.1:42081/.

Development (without pip install)

When working on the source code, run directly from the package directory:

cd packages/ubdcc
python -m ubdcc start --dcn 4
python -m ubdcc status
python -m ubdcc stop

For full documentation, architecture overview, REST API reference and Kubernetes setup, see the main project README.

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 don't find an issue related to your topic, please open a new issue!

Report a security bug!

Contributing

UNICORN Binance DepthCache Cluster 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!

Disclaimer

This project is for informational purposes only. You should not construe this information or any other material as legal, tax, investment, financial or other advice. Nothing contained herein constitutes a solicitation, recommendation, endorsement or offer by us or any third party provider to buy or sell any securities or other financial instruments in this or any other jurisdiction in which such solicitation or offer would be unlawful under the securities laws of such jurisdiction.

If you intend to use real money, use it at your own risk!

Under no circumstances will we be responsible or liable for any claims, damages, losses, expenses, costs or liabilities of any kind, including but not limited to direct or indirect damages for loss of profits.