From fde71fd3790643bcd727250e43a9f4da70174857 Mon Sep 17 00:00:00 2001 From: Oliver Date: Thu, 23 Nov 2023 12:47:27 +0100 Subject: [PATCH] release 2.0.0 --- dev/sphinx/source/changelog.md | 25 + dev/sphinx/source/code_of_conduct.md | 76 +++ dev/sphinx/source/contributing.md | 17 + dev/sphinx/source/license.rst | 108 ++++ dev/sphinx/source/modules.rst | 4 + dev/sphinx/source/readme.md | 205 +++++++ dev/sphinx/source/security.md | 37 ++ docs/.buildinfo | 2 +- docs/CNAME | 2 +- docs/_sources/changelog.md.txt | 25 + docs/_sources/code_of_conduct.md.txt | 76 +++ docs/_sources/contributing.md.txt | 17 + docs/_sources/index.rst.txt | 11 +- docs/_sources/license.rst.txt | 108 ++++ docs/_sources/modules.rst.txt | 4 + docs/_sources/readme.md.txt | 205 +++++++ docs/_sources/security.md.txt | 37 ++ docs/_static/basic.css | 22 + docs/_static/documentation_options.js | 5 +- docs/_static/icons8-facebook-20.png | Bin 0 -> 441 bytes docs/_static/icons8-github-20.png | Bin 0 -> 747 bytes docs/_static/icons8-linkedin-20.png | Bin 0 -> 325 bytes docs/_static/icons8-medium-monogram-20.png | Bin 0 -> 362 bytes docs/_static/icons8-twitter-20.png | Bin 0 -> 384 bytes docs/_static/icons8-xing-20.png | Bin 0 -> 464 bytes docs/_static/icons8-youtube-20.png | Bin 0 -> 316 bytes docs/_static/searchbox.html | 32 ++ docs/_static/searchtools.js | 26 +- docs/_static/sphinx_highlight.js | 16 +- docs/changelog.html | 363 ++++++++++++ docs/code_of_conduct.html | 405 ++++++++++++++ docs/contributing.html | 340 ++++++++++++ docs/genindex.html | 94 ++-- docs/index.html | 183 +++--- docs/license.html | 394 +++++++++++++ docs/modules.html | 304 ++++++++++ docs/objects.inv | Bin 353 -> 454 bytes docs/readme.html | 615 +++++++++++++++++++++ docs/search.html | 92 +-- docs/searchindex.js | 2 +- docs/security.html | 349 ++++++++++++ 41 files changed, 4030 insertions(+), 171 deletions(-) create mode 100644 dev/sphinx/source/changelog.md create mode 100644 dev/sphinx/source/code_of_conduct.md create mode 100644 dev/sphinx/source/contributing.md create mode 100644 dev/sphinx/source/license.rst create mode 100644 dev/sphinx/source/modules.rst create mode 100644 dev/sphinx/source/readme.md create mode 100644 dev/sphinx/source/security.md create mode 100644 docs/_sources/changelog.md.txt create mode 100644 docs/_sources/code_of_conduct.md.txt create mode 100644 docs/_sources/contributing.md.txt create mode 100644 docs/_sources/license.rst.txt create mode 100644 docs/_sources/modules.rst.txt create mode 100644 docs/_sources/readme.md.txt create mode 100644 docs/_sources/security.md.txt create mode 100644 docs/_static/icons8-facebook-20.png create mode 100644 docs/_static/icons8-github-20.png create mode 100644 docs/_static/icons8-linkedin-20.png create mode 100644 docs/_static/icons8-medium-monogram-20.png create mode 100644 docs/_static/icons8-twitter-20.png create mode 100644 docs/_static/icons8-xing-20.png create mode 100644 docs/_static/icons8-youtube-20.png create mode 100644 docs/_static/searchbox.html create mode 100644 docs/changelog.html create mode 100644 docs/code_of_conduct.html create mode 100644 docs/contributing.html create mode 100644 docs/license.html create mode 100644 docs/modules.html create mode 100644 docs/readme.html create mode 100644 docs/security.html diff --git a/dev/sphinx/source/changelog.md b/dev/sphinx/source/changelog.md new file mode 100644 index 0000000..72e3e65 --- /dev/null +++ b/dev/sphinx/source/changelog.md @@ -0,0 +1,25 @@ +# unicorn-binance-suite Change Log + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to +[Semantic Versioning](http://semver.org/). + +[Discussions about unicorn-fy releases!](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/discussions/categories/releases) + +[How to upgrade to the latest version!](https://unicorn-binance-suite.docs.lucit.tech/readme.html#installation-and-upgrade) + +## 1.1.0.dev (development stage/unreleased/unstable) + +## 1.1.0 +## Adding +- unicorn-binance-trailing-stop-loss + +## 1.0.2 +Testing azure pipe + +## 1.0.1 +PYPI and Conda integration + +## 1.0.0 +Initial release. diff --git a/dev/sphinx/source/code_of_conduct.md b/dev/sphinx/source/code_of_conduct.md new file mode 100644 index 0000000..af959f8 --- /dev/null +++ b/dev/sphinx/source/code_of_conduct.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at https://www.lucit.tech/contact-unicorn-developers.html. +All complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/dev/sphinx/source/contributing.md b/dev/sphinx/source/contributing.md new file mode 100644 index 0000000..f65a041 --- /dev/null +++ b/dev/sphinx/source/contributing.md @@ -0,0 +1,17 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via +[issue](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/issues/new/choose) +with the owners of this repository before making a change. + +Please note we have a +[code of conduct](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/blob/master/CODE_OF_CONDUCT.md), +please follow it in all your interactions with the project. + +## Pull Request Process + +1. Discuss with owners +2. Fork +3. Contribute +4. Fulfill and confirm requirements of the pull request +5. Trigger the pull request diff --git a/dev/sphinx/source/license.rst b/dev/sphinx/source/license.rst new file mode 100644 index 0000000..aff9171 --- /dev/null +++ b/dev/sphinx/source/license.rst @@ -0,0 +1,108 @@ +LSOSL - LUCIT Synergetic Open Source License +============================================ + +Version 1.0, November 2023 + +1. INTRODUCTION +2. PROJECT INFORMATION +3. LICENSE CONDITIONS AND VERIFICATION +4. LICENSE PURCHASE +5. CONTRIBUTING CODE +6. USAGE AND DISTRIBUTION +7. DATA COLLECTION AND LICENSE CONTROL +8. THIRD-PARTY SOFTWARE +9. DISCLAIMER OF WARRANTY AND LIABILITY +10. CHANGES TO LICENSE TERMS + +------------------------------------------------------------------------------------------------------------------------ + +1. INTRODUCTION + +The "LUCIT Synergetic Open Source License" oversees the utilization and distribution of the UNICORN Binance Suite +by LUCIT IT-Management GmbH. This API enables the effortless integration of Binance features into diverse applications. + + +2. PROJECT INFORMATION + +- Project name: UNICORN Binance Suite +- Project page: https://www.lucit.tech/unicorn-binance-suite.html +- GitHub repository: https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite +- PyPI repository: https://pypi.org/project/unicorn-binance-suite +- Get a license: https://shop.lucit.services/software + + +3. LICENSE CONDITIONS AND VERIFICATION + +The use of UNICORN Binance Suite requires a license key and an API secret. + +Licenses are available at: https://shop.lucit.services/software + +Verification is done via a client-side module that forwards the license details to our backend for validation. +The software may be used and distributed without restriction, the only condition is that the execution requires a valid +license from LUCIT (https://shop.lucit.services/software) and must be operated with such a license. + +For transparency, our licensing client module is available on GitHub: +https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python + + +4. LICENSE PURCHASE + +Usage of the our software necessitates obtaining a license from the LUCIT Online Shop. + +More details can be found at: https://shop.lucit.services/software + + +5. CONTRIBUTING CODE + +Contributions via GitHub pull requests are welcome. However, contributors should be aware that submitted code +automatically becomes LUCIT IT-Management GmbH's property and copyright. + + +6. USAGE AND DISTRIBUTION + +The LSOSL licensed projects of LUCIT IT-Management GmbH can be used and integrated into any application without +restriction and distributed as desired. The only condition is that the execution of our software requires a valid +license from LUCIT (https://shop.lucit.services/software) and must be operated with such a license. + +For information on library versions that do not contain a license requirement, please contact: sales@lucit.tech + + +7. DATA COLLECTION AND LICENSE CONTROL + +For license adherence, test license misuse prevention, API rate monitoring, and service improvement, we gather: + +- User IP addresses +- Instance log data +- Used Python version +- Operating system type +- API usage rates +- MAC addresses (for misuse detection) +- Data volume processed (anonymously aggregated) + +This data is stored only for its intended purpose and duration, except for anonymous statistics. We commit to +confidentiality and non-disclosure. Details are in our privacy policy. + + +8. THIRD-PARTY SOFTWARE + +The software may embed third-party code or libraries, each governed by their respective licenses. Ensure awareness and +compliance when using the software. + + +9. DISCLAIMER OF WARRANTY AND LIABILITY + +The software is rendered "as is", sans any assurances. LUCIT IT-Management GmbH disclaims liability for any potential +repercussions arising from software usage. + + +10. CHANGES TO LICENSE TERMS + +LUCIT IT-Management GmbH reserves the right to modify, alter, or update the terms of this license at any time and at +its sole discretion. Users are encouraged to review the license terms regularly to ensure compliance. + +------------------------------------------------------------------------------------------------------------------------ + +Thank you for selecting the UNICORN Binance Suite and products from LUCIT IT-Management GmbH. We deeply value +your trust in our technologies. + +LUCIT IT-Management GmbH - Am Berg 391, 3970 Weitra, AUSTRIA - https://www.lucit.tech \ No newline at end of file diff --git a/dev/sphinx/source/modules.rst b/dev/sphinx/source/modules.rst new file mode 100644 index 0000000..aee1c6d --- /dev/null +++ b/dev/sphinx/source/modules.rst @@ -0,0 +1,4 @@ +unicorn_binance_suite +============================= + + diff --git a/dev/sphinx/source/readme.md b/dev/sphinx/source/readme.md new file mode 100644 index 0000000..2a7c788 --- /dev/null +++ b/dev/sphinx/source/readme.md @@ -0,0 +1,205 @@ +[![Get a UNICORN Binance Suite License](https://raw.githubusercontent.com/LUCIT-Systems-and-Development/unicorn-binance-suite/master/images/logo/LUCIT-UBS-License-Offer.png)](https://shop.lucit.services) + +[![GitHub](https://img.shields.io/badge/source-github-cbc2c8)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite) +[![GitHub Release](https://img.shields.io/github/release/LUCIT-Systems-and-Development/unicorn-binance-suite.svg?label=github)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/releases) +[![GitHub Downloads](https://img.shields.io/github/downloads/LUCIT-Systems-and-Development/unicorn-binance-suite/total?color=blue)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/releases) +[![Anaconda Release](https://anaconda.org/lucit/unicorn-binance-suite/badges/version.svg)](https://anaconda.org/lucit/unicorn-binance-suite) +[![Anaconda Downloads](https://anaconda.org/lucit/unicorn-binance-suite/badges/downloads.svg)](https://anaconda.org/lucit/unicorn-binance-suite) +[![PyPi Release](https://img.shields.io/pypi/v/unicorn-binance-suite?color=blue)](https://pypi.org/project/unicorn-binance-suite/) +[![PyPi Downloads](https://pepy.tech/badge/unicorn-binance-suite)](https://pepy.tech/project/unicorn-binance-suite) +[![License](https://img.shields.io/badge/license-LSOSL-blue)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/blob/master/LICENSE) +[![Supported Python Version](https://img.shields.io/pypi/pyversions/unicorn_binance_suite.svg)](https://www.python.org/downloads/) +[![PyPI - Status](https://img.shields.io/pypi/status/unicorn_binance_suite.svg)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/issues) +[![Build and Publish GH+PyPi](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/actions/workflows/build_wheels.yml/badge.svg)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/actions/workflows/build_wheels.yml) +[![Build and Publish Anaconda](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/actions/workflows/build_conda.yml/badge.svg)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/actions/workflows/build_conda.yml) +[![Read the Docs](https://img.shields.io/badge/read-%20docs-yellow)](https://unicorn-binance-suite.docs.lucit.tech/) +[![Read How To`s](https://img.shields.io/badge/read-%20howto-yellow)](https://medium.lucit.tech) +[![Telegram](https://img.shields.io/badge/chat-telegram-41ab8c)](https://t.me/unicorndevs) +[![Gitter](https://badges.gitter.im/unicorn-binance-suite/unicorn-binance-suite.svg)](https://gitter.im/unicorn-binance-suite/unicorn-binance-suite?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +[![LUCIT-UBS-Banner](https://raw.githubusercontent.com/LUCIT-Systems-and-Development/unicorn-binance-suite/master/images/logo/LUCIT-UBS-Banner-Readme.png)](https://www.lucit.tech/unicorn-binance-suite.html) + +# UNICORN Binance Suite +[Description](#description) | [Installation](#installation-and-upgrade) | [How To](#howto) | [Change Log](#change-log) | +[Documentation](#documentation) | [Social](#social) | [Notifications](#receive-notifications) | [Bugs](#how-to-report-bugs-or-suggest-improvements) | +[Contributing](#contributing) | [Disclaimer](#disclaimer) | [Commercial Support](#commercial-support) + +## Description +The [`UNICORN Binance Suite`](https://www.lucit.tech/unicorn-binance-suite.html) for Python is a collection of open +source Python packages from [LUCIT Systems and Development](https://www.lucit.tech) that are useful for creating +automated trading systems (bots) that connect to the Binance API. + +The suite is the most stable, powerful and convenient way to interact with various Binance API endpoints via +[REST](https://www.lucit.tech/unicorn-binance-rest-api.html) and +[Websocket](https://www.lucit.tech/unicorn-binance-websocket-api.html) and to +[manage local order books](https://www.lucit.tech/unicorn-binance-local-depth-cache.html) and +[trailing stop losses](https://www.lucit.tech/unicorn-binance-trailing-stop-loss.html). + +All libraries in the suite are coordinated with each other, interlock perfectly, are fully documented and offer +standardized interfaces and tools for the programmer. LUCIT continuously develops the modules, fixes bugs, tests the +libraries extensively and offers [fast, direct and free support](https://www.lucit.tech/get-support.html). + +All modules are delivered optimized as PyPy and as C++ compilations (Cython) via PyPi and Anaconda. The package +creation runs completely transparently directly from the respective GitHub repository through GitHub Actions and is +deployed directly to PyPi and Anaconda in a traceable manner. This process makes it tamper-proof for the user to +understand which code is contained in which package and can therefore easily install optimized builds for the platform, +architecture and Python version used. + +## Modules of the UNICORN Binance Suite + +- [`UnicornFy`](https://www.lucit.tech/unicorn-fy.html): Convert received raw data from crypto exchange API endpoints into well-formed python dictionaries. +- [`UNICORN Binance Local Depth Cache`](https://www.lucit.tech/unicorn-binance-local-depth-cache.html): A local Binance DepthCache Manager for Python that supports multiple depth caches in one instance in a easy, fast, flexible, robust and fully-featured way. +- [`UNICORN Binance REST API`](https://www.lucit.tech/unicorn-binance-rest-api.html): An unofficial Python API to use the Binance REST API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, us, tr) in a easy, fast, flexible, robust and fully-featured way. +- [`UNICORN Binance Trailing Stop Loss`](https://www.lucit.tech/unicorn-binance-trailing-stop-loss.html): A Trailing Stop Loss Python Lib and [Command Line Tool](https://www.lucit.tech/ubtsl-cli.html). +- [`UNICORN Binance WebSocket API`](https://www.lucit.tech/unicorn-binance-websocket-api.html): An unofficial Python API to use the Binance Websocket API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, com-coin_futures, us, tr, dex/chain+testnet) in a easy, fast, flexible, robust and fully-featured way. + +If you like the project, please +[![star](https://raw.githubusercontent.com/lucit-systems-and-development/unicorn-binance-suite/master/images/misc/star.png)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/stargazers) it on +[GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite)! + +## Get a UNICORN Binance Suite License + +To run modules of the *UNICORN Binance Suite* you need a [valid license](https://medium.lucit.tech/how-to-obtain-and-use-a-unicorn-binance-suite-license-key-and-run-the-ubs-module-according-to-best-87b0088124a8#4ca4)! + +## Installation and Upgrade + +The modules require Python 3.7 or above, as they depend on Pythons latest asyncio features for asynchronous/concurrent +processing. + +For the PyPy interpreter we offer packages only from Python version 3.9 and higher. + +Anaconda packages are available from Python version 3.8 and higher. + +If you run into errors during the installation take a look [here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/wiki/Installation). + +### A Cython binary, PyPy or source code based CPython wheel of the latest version with `pip` from [PyPI](https://pypi.org/project/unicorn-binance-rest-api/) +Our [Cython](https://cython.org/) and [PyPy](https://www.pypy.org/) Wheels are available on [PyPI](https://pypi.org/), +these wheels offer significant advantages for Python developers: + +- ***Performance Boost with Cython Wheels:*** Cython is a programming language that supplements Python with static + typing and C-level performance. By compiling Python code into C, Cython Wheels can significantly enhance the + execution speed of Python code, especially in computationally intensive tasks. This means faster runtimes and more + efficient processing for users of our package. + +- ***PyPy Wheels for Enhanced Efficiency:*** PyPy is an alternative Python interpreter known for its speed and + efficiency. It uses Just-In-Time (JIT) compilation, which can dramatically improve the performance of Python code. + Our PyPy Wheels are tailored for compatibility with PyPy, allowing users to leverage this speed advantage seamlessly. + +Both Cython and PyPy Wheels on PyPI make the installation process simpler and more straightforward. They ensure that +you get the optimized version of our package with minimal setup, allowing you to focus on development rather than +configuration. + +#### Installation +`pip install unicorn-binance-suite` + +#### Update +`pip install unicorn-binance-suite --upgrade` + +### A Conda Package of the latest version with `conda` from [Anaconda](https://anaconda.org/lucit) +The `unicorn-binance-suite` package is also available as a Cython version for the `linux-64`, `osx-64` +and `win-64` architectures with [Conda](https://docs.conda.io/en/latest/) through the +[`lucit` channel](https://anaconda.org/lucit). + +For optimal compatibility and performance, it is recommended to source the necessary dependencies from the +[`conda-forge` channel](https://anaconda.org/conda-forge). + +#### Installation +``` +conda config --add channels conda-forge +conda config --add channels lucit +conda install -c lucit unicorn-binance-suite +``` + +#### Update +`conda update -c lucit unicorn-binance-suite` + +### From source of the latest release with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite) +#### Linux, macOS, ... +Run in bash: + +`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/archive/$(curl -s https://api.github.com/repos/LUCIT-Systems-and-Development/unicorn-binance-suite/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade` + +#### Windows +Use the below command with the version (such as 1.1.0) you determined +[here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/releases/latest): + +`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/archive/1.1.0.tar.gz --upgrade` + +### From the latest source (dev-stage) with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite) +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-suite/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-suite/releases/latest) +or the [current master branch](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/archive/master.zip) + and use: + +- ./environment.yml +- ./pyproject.toml +- ./requirements.txt +- ./setup.py + +## Change Log +[https://unicorn-binance-suite.docs.lucit.tech//changelog.html](https://unicorn-binance-suite.docs.lucit.tech/changelog.html) + +Please look for the information in the README.md of the [responsible subrepository](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite#description). + +## Documentation +- [General](https://unicorn-binance-suite.docs.lucit.tech/) + +Please look for the information in the README.md of the [responsible subrepository](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite#description). + +## Howto +- [How to Obtain and Use a Unicorn Binance Suite License Key and Run the UBS Module According to Best Practice](https://medium.lucit.tech/how-to-obtain-and-use-a-unicorn-binance-suite-license-key-and-run-the-ubs-module-according-to-best-87b0088124a8) +- [Instructions about the UNICORN Binance Suite](https://medium.lucit.tech/unicorn-binance-suite/home) + +## Project Homepage +[https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite) + +## Wiki +[https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/wiki](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/wiki) + +## Social +- [Discussions](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/discussions) +- [https://t.me/unicorndevs](https://t.me/unicorndevs) +- [https://dev.binance.vision](https://dev.binance.vision) +- [https://community.binance.org](https://community.binance.org) + +## Receive Notifications +Follow us on [Twitter](https://twitter.com/LUCIT_SysDev) or on [Facebook](https://www.facebook.com/lucit.systems.and.development) for general news about the [unicorn-binance-suite](https://www.lucit.tech/unicorn-binance-suite.html)! + +Please look for the information in the README.md of the [responsible subrepository](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite#description) for spezific notifications. + +## How to report Bugs or suggest Improvements? +Please look for the information in the README.md of the [responsible subrepository](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite#description). + +## Contributing +Please look for the information in the README.md of the [responsible subrepository](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite#description). + +## 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. + +### SOCKS5 Proxy / Geoblocking +We would like to explicitly point out that in our opinion US citizens are exclusively authorized to trade on Binance.US +and that this restriction must not be circumvented! + +The purpose of supporting a SOCKS5 proxy in the UNICORN Binance Suite and its modules is to allow non-US citizens to +use US services. For example, GitHub actions with UBS will not work without a SOCKS5 proxy, as they will inevitably run +on servers in the US and be blocked by Binance.com. Moreover, it also seems justified that traders, data scientists and +companies from the US analyze binance.com market data - as long as they do not trade there. + +## Commercial Support + +[![Get professional and fast support](https://raw.githubusercontent.com/LUCIT-Systems-and-Development/unicorn-binance-suite/master/images/support/LUCIT-get-professional-and-fast-support.png)](https://www.lucit.tech/get-support.html) + +***Do you need a developer, operator or consultant?*** [Contact us](https://www.lucit.tech/contact.html) for a non-binding initial consultation! diff --git a/dev/sphinx/source/security.md b/dev/sphinx/source/security.md new file mode 100644 index 0000000..bdc59d9 --- /dev/null +++ b/dev/sphinx/source/security.md @@ -0,0 +1,37 @@ +# Security Policies and Procedures +This document outlines security procedures and general policies for the `unicorn-fy` project. + + * [Reporting a Bug](#reporting-a-bug) + * [Disclosure Policy](#disclosure-policy) + * [Comments on this Policy](#comments-on-this-policy) + +## Reporting a Bug +`LUCIT Systems and Development` takes all security bugs in `unicorn-binance-suite` seriously. +Thank you for improving the security of `unicorn-binance-suite`. We appreciate your efforts and +responsible disclosure and will make every effort to acknowledge your contributions. + +Report security bugs via our contact form: +https://www.lucit.tech/contact-unicorn-developers.html + +The lead maintainer will acknowledge your email within 48 hours, and will send a +more detailed response within 48 hours indicating the next steps in handling +your report. After the initial reply to your report, the security team will +endeavor to keep you informed of the progress towards a fix and full +announcement, and may ask for additional information or guidance. + +Report security bugs in third-party modules to the person or team maintaining +the module. + +## Disclosure Policy +When the security team receives a security bug report, they will assign it to a +primary handler. This person will coordinate the fix and release process, +involving the following steps: + + * Confirm the problem and determine the affected versions. + * Audit code to find any potential similar problems. + * Prepare fixes for all releases still under maintenance. These fixes will be + released as fast as possible to pip. + +## Comments on this Policy +If you have suggestions on how this process could be improved please submit a +pull request. diff --git a/docs/.buildinfo b/docs/.buildinfo index e3d3014..26983ef 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -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: 68f30f40e00f73fa59bbae2ba9165d97 +config: b8b59c6c0745ef4357db33a2cd2f7b6c tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/CNAME b/docs/CNAME index ff73d58..5bd2bb4 100644 --- a/docs/CNAME +++ b/docs/CNAME @@ -1 +1 @@ -unicorn-binance-suite.docs.lucit.tech \ No newline at end of file +unicorn-binance-suite.docs.lucit.tech diff --git a/docs/_sources/changelog.md.txt b/docs/_sources/changelog.md.txt new file mode 100644 index 0000000..72e3e65 --- /dev/null +++ b/docs/_sources/changelog.md.txt @@ -0,0 +1,25 @@ +# unicorn-binance-suite Change Log + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to +[Semantic Versioning](http://semver.org/). + +[Discussions about unicorn-fy releases!](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/discussions/categories/releases) + +[How to upgrade to the latest version!](https://unicorn-binance-suite.docs.lucit.tech/readme.html#installation-and-upgrade) + +## 1.1.0.dev (development stage/unreleased/unstable) + +## 1.1.0 +## Adding +- unicorn-binance-trailing-stop-loss + +## 1.0.2 +Testing azure pipe + +## 1.0.1 +PYPI and Conda integration + +## 1.0.0 +Initial release. diff --git a/docs/_sources/code_of_conduct.md.txt b/docs/_sources/code_of_conduct.md.txt new file mode 100644 index 0000000..af959f8 --- /dev/null +++ b/docs/_sources/code_of_conduct.md.txt @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at https://www.lucit.tech/contact-unicorn-developers.html. +All complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/docs/_sources/contributing.md.txt b/docs/_sources/contributing.md.txt new file mode 100644 index 0000000..f65a041 --- /dev/null +++ b/docs/_sources/contributing.md.txt @@ -0,0 +1,17 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via +[issue](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/issues/new/choose) +with the owners of this repository before making a change. + +Please note we have a +[code of conduct](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/blob/master/CODE_OF_CONDUCT.md), +please follow it in all your interactions with the project. + +## Pull Request Process + +1. Discuss with owners +2. Fork +3. Contribute +4. Fulfill and confirm requirements of the pull request +5. Trigger the pull request diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt index ebbacbc..1391899 100644 --- a/docs/_sources/index.rst.txt +++ b/docs/_sources/index.rst.txt @@ -10,10 +10,13 @@ Welcome to unicorn-binance-suite's documentation! :maxdepth: 3 :caption: Contents: - Readme - ChangeLog - Copyright - + Readme + Modules + ChangeLog + Code of Conduct + Contributing + License + Security Indices and tables ================== diff --git a/docs/_sources/license.rst.txt b/docs/_sources/license.rst.txt new file mode 100644 index 0000000..aff9171 --- /dev/null +++ b/docs/_sources/license.rst.txt @@ -0,0 +1,108 @@ +LSOSL - LUCIT Synergetic Open Source License +============================================ + +Version 1.0, November 2023 + +1. INTRODUCTION +2. PROJECT INFORMATION +3. LICENSE CONDITIONS AND VERIFICATION +4. LICENSE PURCHASE +5. CONTRIBUTING CODE +6. USAGE AND DISTRIBUTION +7. DATA COLLECTION AND LICENSE CONTROL +8. THIRD-PARTY SOFTWARE +9. DISCLAIMER OF WARRANTY AND LIABILITY +10. CHANGES TO LICENSE TERMS + +------------------------------------------------------------------------------------------------------------------------ + +1. INTRODUCTION + +The "LUCIT Synergetic Open Source License" oversees the utilization and distribution of the UNICORN Binance Suite +by LUCIT IT-Management GmbH. This API enables the effortless integration of Binance features into diverse applications. + + +2. PROJECT INFORMATION + +- Project name: UNICORN Binance Suite +- Project page: https://www.lucit.tech/unicorn-binance-suite.html +- GitHub repository: https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite +- PyPI repository: https://pypi.org/project/unicorn-binance-suite +- Get a license: https://shop.lucit.services/software + + +3. LICENSE CONDITIONS AND VERIFICATION + +The use of UNICORN Binance Suite requires a license key and an API secret. + +Licenses are available at: https://shop.lucit.services/software + +Verification is done via a client-side module that forwards the license details to our backend for validation. +The software may be used and distributed without restriction, the only condition is that the execution requires a valid +license from LUCIT (https://shop.lucit.services/software) and must be operated with such a license. + +For transparency, our licensing client module is available on GitHub: +https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python + + +4. LICENSE PURCHASE + +Usage of the our software necessitates obtaining a license from the LUCIT Online Shop. + +More details can be found at: https://shop.lucit.services/software + + +5. CONTRIBUTING CODE + +Contributions via GitHub pull requests are welcome. However, contributors should be aware that submitted code +automatically becomes LUCIT IT-Management GmbH's property and copyright. + + +6. USAGE AND DISTRIBUTION + +The LSOSL licensed projects of LUCIT IT-Management GmbH can be used and integrated into any application without +restriction and distributed as desired. The only condition is that the execution of our software requires a valid +license from LUCIT (https://shop.lucit.services/software) and must be operated with such a license. + +For information on library versions that do not contain a license requirement, please contact: sales@lucit.tech + + +7. DATA COLLECTION AND LICENSE CONTROL + +For license adherence, test license misuse prevention, API rate monitoring, and service improvement, we gather: + +- User IP addresses +- Instance log data +- Used Python version +- Operating system type +- API usage rates +- MAC addresses (for misuse detection) +- Data volume processed (anonymously aggregated) + +This data is stored only for its intended purpose and duration, except for anonymous statistics. We commit to +confidentiality and non-disclosure. Details are in our privacy policy. + + +8. THIRD-PARTY SOFTWARE + +The software may embed third-party code or libraries, each governed by their respective licenses. Ensure awareness and +compliance when using the software. + + +9. DISCLAIMER OF WARRANTY AND LIABILITY + +The software is rendered "as is", sans any assurances. LUCIT IT-Management GmbH disclaims liability for any potential +repercussions arising from software usage. + + +10. CHANGES TO LICENSE TERMS + +LUCIT IT-Management GmbH reserves the right to modify, alter, or update the terms of this license at any time and at +its sole discretion. Users are encouraged to review the license terms regularly to ensure compliance. + +------------------------------------------------------------------------------------------------------------------------ + +Thank you for selecting the UNICORN Binance Suite and products from LUCIT IT-Management GmbH. We deeply value +your trust in our technologies. + +LUCIT IT-Management GmbH - Am Berg 391, 3970 Weitra, AUSTRIA - https://www.lucit.tech \ No newline at end of file diff --git a/docs/_sources/modules.rst.txt b/docs/_sources/modules.rst.txt new file mode 100644 index 0000000..aee1c6d --- /dev/null +++ b/docs/_sources/modules.rst.txt @@ -0,0 +1,4 @@ +unicorn_binance_suite +============================= + + diff --git a/docs/_sources/readme.md.txt b/docs/_sources/readme.md.txt new file mode 100644 index 0000000..2a7c788 --- /dev/null +++ b/docs/_sources/readme.md.txt @@ -0,0 +1,205 @@ +[![Get a UNICORN Binance Suite License](https://raw.githubusercontent.com/LUCIT-Systems-and-Development/unicorn-binance-suite/master/images/logo/LUCIT-UBS-License-Offer.png)](https://shop.lucit.services) + +[![GitHub](https://img.shields.io/badge/source-github-cbc2c8)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite) +[![GitHub Release](https://img.shields.io/github/release/LUCIT-Systems-and-Development/unicorn-binance-suite.svg?label=github)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/releases) +[![GitHub Downloads](https://img.shields.io/github/downloads/LUCIT-Systems-and-Development/unicorn-binance-suite/total?color=blue)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/releases) +[![Anaconda Release](https://anaconda.org/lucit/unicorn-binance-suite/badges/version.svg)](https://anaconda.org/lucit/unicorn-binance-suite) +[![Anaconda Downloads](https://anaconda.org/lucit/unicorn-binance-suite/badges/downloads.svg)](https://anaconda.org/lucit/unicorn-binance-suite) +[![PyPi Release](https://img.shields.io/pypi/v/unicorn-binance-suite?color=blue)](https://pypi.org/project/unicorn-binance-suite/) +[![PyPi Downloads](https://pepy.tech/badge/unicorn-binance-suite)](https://pepy.tech/project/unicorn-binance-suite) +[![License](https://img.shields.io/badge/license-LSOSL-blue)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/blob/master/LICENSE) +[![Supported Python Version](https://img.shields.io/pypi/pyversions/unicorn_binance_suite.svg)](https://www.python.org/downloads/) +[![PyPI - Status](https://img.shields.io/pypi/status/unicorn_binance_suite.svg)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/issues) +[![Build and Publish GH+PyPi](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/actions/workflows/build_wheels.yml/badge.svg)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/actions/workflows/build_wheels.yml) +[![Build and Publish Anaconda](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/actions/workflows/build_conda.yml/badge.svg)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/actions/workflows/build_conda.yml) +[![Read the Docs](https://img.shields.io/badge/read-%20docs-yellow)](https://unicorn-binance-suite.docs.lucit.tech/) +[![Read How To`s](https://img.shields.io/badge/read-%20howto-yellow)](https://medium.lucit.tech) +[![Telegram](https://img.shields.io/badge/chat-telegram-41ab8c)](https://t.me/unicorndevs) +[![Gitter](https://badges.gitter.im/unicorn-binance-suite/unicorn-binance-suite.svg)](https://gitter.im/unicorn-binance-suite/unicorn-binance-suite?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +[![LUCIT-UBS-Banner](https://raw.githubusercontent.com/LUCIT-Systems-and-Development/unicorn-binance-suite/master/images/logo/LUCIT-UBS-Banner-Readme.png)](https://www.lucit.tech/unicorn-binance-suite.html) + +# UNICORN Binance Suite +[Description](#description) | [Installation](#installation-and-upgrade) | [How To](#howto) | [Change Log](#change-log) | +[Documentation](#documentation) | [Social](#social) | [Notifications](#receive-notifications) | [Bugs](#how-to-report-bugs-or-suggest-improvements) | +[Contributing](#contributing) | [Disclaimer](#disclaimer) | [Commercial Support](#commercial-support) + +## Description +The [`UNICORN Binance Suite`](https://www.lucit.tech/unicorn-binance-suite.html) for Python is a collection of open +source Python packages from [LUCIT Systems and Development](https://www.lucit.tech) that are useful for creating +automated trading systems (bots) that connect to the Binance API. + +The suite is the most stable, powerful and convenient way to interact with various Binance API endpoints via +[REST](https://www.lucit.tech/unicorn-binance-rest-api.html) and +[Websocket](https://www.lucit.tech/unicorn-binance-websocket-api.html) and to +[manage local order books](https://www.lucit.tech/unicorn-binance-local-depth-cache.html) and +[trailing stop losses](https://www.lucit.tech/unicorn-binance-trailing-stop-loss.html). + +All libraries in the suite are coordinated with each other, interlock perfectly, are fully documented and offer +standardized interfaces and tools for the programmer. LUCIT continuously develops the modules, fixes bugs, tests the +libraries extensively and offers [fast, direct and free support](https://www.lucit.tech/get-support.html). + +All modules are delivered optimized as PyPy and as C++ compilations (Cython) via PyPi and Anaconda. The package +creation runs completely transparently directly from the respective GitHub repository through GitHub Actions and is +deployed directly to PyPi and Anaconda in a traceable manner. This process makes it tamper-proof for the user to +understand which code is contained in which package and can therefore easily install optimized builds for the platform, +architecture and Python version used. + +## Modules of the UNICORN Binance Suite + +- [`UnicornFy`](https://www.lucit.tech/unicorn-fy.html): Convert received raw data from crypto exchange API endpoints into well-formed python dictionaries. +- [`UNICORN Binance Local Depth Cache`](https://www.lucit.tech/unicorn-binance-local-depth-cache.html): A local Binance DepthCache Manager for Python that supports multiple depth caches in one instance in a easy, fast, flexible, robust and fully-featured way. +- [`UNICORN Binance REST API`](https://www.lucit.tech/unicorn-binance-rest-api.html): An unofficial Python API to use the Binance REST API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, us, tr) in a easy, fast, flexible, robust and fully-featured way. +- [`UNICORN Binance Trailing Stop Loss`](https://www.lucit.tech/unicorn-binance-trailing-stop-loss.html): A Trailing Stop Loss Python Lib and [Command Line Tool](https://www.lucit.tech/ubtsl-cli.html). +- [`UNICORN Binance WebSocket API`](https://www.lucit.tech/unicorn-binance-websocket-api.html): An unofficial Python API to use the Binance Websocket API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, com-coin_futures, us, tr, dex/chain+testnet) in a easy, fast, flexible, robust and fully-featured way. + +If you like the project, please +[![star](https://raw.githubusercontent.com/lucit-systems-and-development/unicorn-binance-suite/master/images/misc/star.png)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/stargazers) it on +[GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite)! + +## Get a UNICORN Binance Suite License + +To run modules of the *UNICORN Binance Suite* you need a [valid license](https://medium.lucit.tech/how-to-obtain-and-use-a-unicorn-binance-suite-license-key-and-run-the-ubs-module-according-to-best-87b0088124a8#4ca4)! + +## Installation and Upgrade + +The modules require Python 3.7 or above, as they depend on Pythons latest asyncio features for asynchronous/concurrent +processing. + +For the PyPy interpreter we offer packages only from Python version 3.9 and higher. + +Anaconda packages are available from Python version 3.8 and higher. + +If you run into errors during the installation take a look [here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/wiki/Installation). + +### A Cython binary, PyPy or source code based CPython wheel of the latest version with `pip` from [PyPI](https://pypi.org/project/unicorn-binance-rest-api/) +Our [Cython](https://cython.org/) and [PyPy](https://www.pypy.org/) Wheels are available on [PyPI](https://pypi.org/), +these wheels offer significant advantages for Python developers: + +- ***Performance Boost with Cython Wheels:*** Cython is a programming language that supplements Python with static + typing and C-level performance. By compiling Python code into C, Cython Wheels can significantly enhance the + execution speed of Python code, especially in computationally intensive tasks. This means faster runtimes and more + efficient processing for users of our package. + +- ***PyPy Wheels for Enhanced Efficiency:*** PyPy is an alternative Python interpreter known for its speed and + efficiency. It uses Just-In-Time (JIT) compilation, which can dramatically improve the performance of Python code. + Our PyPy Wheels are tailored for compatibility with PyPy, allowing users to leverage this speed advantage seamlessly. + +Both Cython and PyPy Wheels on PyPI make the installation process simpler and more straightforward. They ensure that +you get the optimized version of our package with minimal setup, allowing you to focus on development rather than +configuration. + +#### Installation +`pip install unicorn-binance-suite` + +#### Update +`pip install unicorn-binance-suite --upgrade` + +### A Conda Package of the latest version with `conda` from [Anaconda](https://anaconda.org/lucit) +The `unicorn-binance-suite` package is also available as a Cython version for the `linux-64`, `osx-64` +and `win-64` architectures with [Conda](https://docs.conda.io/en/latest/) through the +[`lucit` channel](https://anaconda.org/lucit). + +For optimal compatibility and performance, it is recommended to source the necessary dependencies from the +[`conda-forge` channel](https://anaconda.org/conda-forge). + +#### Installation +``` +conda config --add channels conda-forge +conda config --add channels lucit +conda install -c lucit unicorn-binance-suite +``` + +#### Update +`conda update -c lucit unicorn-binance-suite` + +### From source of the latest release with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite) +#### Linux, macOS, ... +Run in bash: + +`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/archive/$(curl -s https://api.github.com/repos/LUCIT-Systems-and-Development/unicorn-binance-suite/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade` + +#### Windows +Use the below command with the version (such as 1.1.0) you determined +[here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/releases/latest): + +`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/archive/1.1.0.tar.gz --upgrade` + +### From the latest source (dev-stage) with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite) +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-suite/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-suite/releases/latest) +or the [current master branch](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/archive/master.zip) + and use: + +- ./environment.yml +- ./pyproject.toml +- ./requirements.txt +- ./setup.py + +## Change Log +[https://unicorn-binance-suite.docs.lucit.tech//changelog.html](https://unicorn-binance-suite.docs.lucit.tech/changelog.html) + +Please look for the information in the README.md of the [responsible subrepository](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite#description). + +## Documentation +- [General](https://unicorn-binance-suite.docs.lucit.tech/) + +Please look for the information in the README.md of the [responsible subrepository](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite#description). + +## Howto +- [How to Obtain and Use a Unicorn Binance Suite License Key and Run the UBS Module According to Best Practice](https://medium.lucit.tech/how-to-obtain-and-use-a-unicorn-binance-suite-license-key-and-run-the-ubs-module-according-to-best-87b0088124a8) +- [Instructions about the UNICORN Binance Suite](https://medium.lucit.tech/unicorn-binance-suite/home) + +## Project Homepage +[https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite) + +## Wiki +[https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/wiki](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/wiki) + +## Social +- [Discussions](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/discussions) +- [https://t.me/unicorndevs](https://t.me/unicorndevs) +- [https://dev.binance.vision](https://dev.binance.vision) +- [https://community.binance.org](https://community.binance.org) + +## Receive Notifications +Follow us on [Twitter](https://twitter.com/LUCIT_SysDev) or on [Facebook](https://www.facebook.com/lucit.systems.and.development) for general news about the [unicorn-binance-suite](https://www.lucit.tech/unicorn-binance-suite.html)! + +Please look for the information in the README.md of the [responsible subrepository](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite#description) for spezific notifications. + +## How to report Bugs or suggest Improvements? +Please look for the information in the README.md of the [responsible subrepository](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite#description). + +## Contributing +Please look for the information in the README.md of the [responsible subrepository](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite#description). + +## 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. + +### SOCKS5 Proxy / Geoblocking +We would like to explicitly point out that in our opinion US citizens are exclusively authorized to trade on Binance.US +and that this restriction must not be circumvented! + +The purpose of supporting a SOCKS5 proxy in the UNICORN Binance Suite and its modules is to allow non-US citizens to +use US services. For example, GitHub actions with UBS will not work without a SOCKS5 proxy, as they will inevitably run +on servers in the US and be blocked by Binance.com. Moreover, it also seems justified that traders, data scientists and +companies from the US analyze binance.com market data - as long as they do not trade there. + +## Commercial Support + +[![Get professional and fast support](https://raw.githubusercontent.com/LUCIT-Systems-and-Development/unicorn-binance-suite/master/images/support/LUCIT-get-professional-and-fast-support.png)](https://www.lucit.tech/get-support.html) + +***Do you need a developer, operator or consultant?*** [Contact us](https://www.lucit.tech/contact.html) for a non-binding initial consultation! diff --git a/docs/_sources/security.md.txt b/docs/_sources/security.md.txt new file mode 100644 index 0000000..bdc59d9 --- /dev/null +++ b/docs/_sources/security.md.txt @@ -0,0 +1,37 @@ +# Security Policies and Procedures +This document outlines security procedures and general policies for the `unicorn-fy` project. + + * [Reporting a Bug](#reporting-a-bug) + * [Disclosure Policy](#disclosure-policy) + * [Comments on this Policy](#comments-on-this-policy) + +## Reporting a Bug +`LUCIT Systems and Development` takes all security bugs in `unicorn-binance-suite` seriously. +Thank you for improving the security of `unicorn-binance-suite`. We appreciate your efforts and +responsible disclosure and will make every effort to acknowledge your contributions. + +Report security bugs via our contact form: +https://www.lucit.tech/contact-unicorn-developers.html + +The lead maintainer will acknowledge your email within 48 hours, and will send a +more detailed response within 48 hours indicating the next steps in handling +your report. After the initial reply to your report, the security team will +endeavor to keep you informed of the progress towards a fix and full +announcement, and may ask for additional information or guidance. + +Report security bugs in third-party modules to the person or team maintaining +the module. + +## Disclosure Policy +When the security team receives a security bug report, they will assign it to a +primary handler. This person will coordinate the fix and release process, +involving the following steps: + + * Confirm the problem and determine the affected versions. + * Audit code to find any potential similar problems. + * Prepare fixes for all releases still under maintenance. These fixes will be + released as fast as possible to pip. + +## Comments on this Policy +If you have suggestions on how this process could be improved please submit a +pull request. diff --git a/docs/_static/basic.css b/docs/_static/basic.css index 7577acb..30fee9d 100644 --- a/docs/_static/basic.css +++ b/docs/_static/basic.css @@ -237,6 +237,10 @@ a.headerlink { visibility: hidden; } +a:visited { + color: #551A8B; +} + h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, @@ -670,6 +674,16 @@ dd { margin-left: 30px; } +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + dl > dd:last-child, dl > dd:last-child > :last-child { margin-bottom: 0; @@ -738,6 +752,14 @@ abbr, acronym { cursor: help; } +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + /* -- code displays --------------------------------------------------------- */ pre { diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index 5016d16..3f42394 100644 --- a/docs/_static/documentation_options.js +++ b/docs/_static/documentation_options.js @@ -1,6 +1,5 @@ -var DOCUMENTATION_OPTIONS = { - URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '1.1.0', +const DOCUMENTATION_OPTIONS = { + VERSION: '1.2.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/_static/icons8-facebook-20.png b/docs/_static/icons8-facebook-20.png new file mode 100644 index 0000000000000000000000000000000000000000..7ed19e5b2971c4503c072766f9b958fc3f6bd154 GIT binary patch literal 441 zcmV;q0Y?6bP)j9C z>;}cERg{7t^k{8weFC*;#X4(STNEMjQgmcfjrlWa4GMt|dqRJdg?=11 zC9aj;aQD{6{fdn%`L?^ql+q~AqS_SKHhLpje)qMnQJyjmTNG?$?-@V8x*+q$#^rn) zr;i)H8Ybih1uRm)xwEFLY%1#qdD*29U*Ai+3{_PJNRCt`dl;2BKQ4q&ZJ@{%q_2W;l-g-)-o+^C_iXbQp3QJMK zHKWu(lYXf5V++kU-4vt}Eev6^dlr}WAqdOxoGn`r1ieSsbnot7WmmlJ#EiSHw!3Bp z4Gi3SIOlU_<~ws3`>$3H+nLL|mvL_)Ier6d`*V37~$hc69OW5c_XI$K4LnAx3 z2Git0#-$$*@9~Tol|E%UlmY0r@5GaOp?b7c&Cp!XhkNRvILL5emadI0A9#G}DH&Q-M@72^bk3s%?G@ zr^~9K`&oTiH#1g z_rmifv>q}|Scw6w)>P;l)gS!24{y5aQ)VKq>c&SYuq3n;CZ=@SXY;8rMTsqyOc(o1 zl9FiAr6o9e_EJV5de6XH+S{%NR@+IF1?$xdV}<2Nu8o d>Vf?S`w5HmtLN1D$#nn#002ovPDHLkV1iJ+TX6sY literal 0 HcmV?d00001 diff --git a/docs/_static/icons8-linkedin-20.png b/docs/_static/icons8-linkedin-20.png new file mode 100644 index 0000000000000000000000000000000000000000..5b84f9b132dbc8067dfa73ca537deb70afbbd10e GIT binary patch literal 325 zcmV-L0lNN)P)I7U?7x8TNyz17`0z21iIS|>aj^`0;m~p6J6VN8$7M}S13{qmoEB62#VW>*3mwE@kXqb^4ORdE XOr?XuY&q7`00000NkvXXu0mjfy_J)X literal 0 HcmV?d00001 diff --git a/docs/_static/icons8-medium-monogram-20.png b/docs/_static/icons8-medium-monogram-20.png new file mode 100644 index 0000000000000000000000000000000000000000..48e23ae0dfb0106db0a5b4fc56e94e77854561c6 GIT binary patch literal 362 zcmV-w0hRuVP)Gt$Ji6XNJhr}pEF4|$fN5ZCeS<`7!+&zHcx-(G zeGPQ0oe9U%@r@{&ZOW#=<%l+L?yi&nVIXnB3b;nCtgin*e*FfE_pU!cyn*%=Q~&?{ z_YbV`_>Bi}jm;}|!z}`-A<4jlSML7*^8F`Rvuo|l|59;{|8G2b_5bUSU*s9M>EzY_ zbD&;dedOZ**xqITm+U|L|IMeb;DSLE&u(R=Yb8#nXwMc|Mcw#m``-FQB71RCt{2lCeqyK@f%~GdZ-0AXrO4OKq$zd;+nvw(Z4`sF-yDV&z%R1->d4AyWqsfPtN6sk+6n?$-zwfvjZYU& zGi+qNF9o92?O51P<-<}SSVzRN=c`5mQ&}ko7PV!ESn|rcMz0`Boo)k-oK^teA zT4!#8j2?`Dz1D4Sxf;^WrqSpYv7Qj?bGW9QgU#mSleJ!^kaffVJ7l>*mfNB}%WlHD e6b~8;{-JLdq)%l5sjGkh00000WbcEP)I5;E=8LmKDn47A*Gxs3{snzsD;n49}Ed8|4GE( zu^S4pm7oDq1#$m_CI$cZ?GHv4FUK@6KDmJy1E=kF{eSk3<^R@=9tiRH~{GnIBKQf#P{Z|37^D_8$bIXU+zTu_Pt`Uw6_0 zY+%*`KU9~;6EF~jOINN28~Ehi`~TeO+5e-a2Z9aTebM$mcX|@(23D+I3pViayLbP^ z^V0wCyKDnC(0@V*X4u9PFiyw*08Wf2O1q(hZz_@DSLr<9F`< z=S)imM*_$|w4_43fwk*4{BPf~?Z0|O4Vd4!&J%3loPEyZ8OVT!#d72SAH8l3Hq^c? zjB*1R5>o!>E%F5$xbCF=f9AwwA`DExpY?b%lHf5NI1w!@k~BqS*iD zjS>Ili(^p>huCCIOanmxRB9xoR58RScMyd^YH=DiSOEZT-r9(RWAMcQ00008O4J&mpImtZxqbn5+|f5|hSUyg??u?p zZush#7@gXfxA6L62j#u%8)Z~a9aNZ*Vc*^ibV_g6rzK7wjH?(_B0rro+ti;6^f`m4 LtDnm{r-UW|vgv%= literal 0 HcmV?d00001 diff --git a/docs/_static/searchbox.html b/docs/_static/searchbox.html new file mode 100644 index 0000000..d302d05 --- /dev/null +++ b/docs/_static/searchbox.html @@ -0,0 +1,32 @@ +{# + basic/searchbox.html + ~~~~~~~~~~~~~~~~~~~~ + + Sphinx sidebar template: quick search box. + + :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +#} +{%- if builder != "singlehtml" %} +
+

GitHub

+ +
+ +{%- endif %} +{%- if pagename != "search" and builder != "singlehtml" %} + + +
+{%- endif %} diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js index 97d56a7..7918c3f 100644 --- a/docs/_static/searchtools.js +++ b/docs/_static/searchtools.js @@ -57,12 +57,12 @@ const _removeChildren = (element) => { const _escapeRegExp = (string) => string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string -const _displayItem = (item, searchTerms) => { +const _displayItem = (item, searchTerms, highlightTerms) => { const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; - const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT; const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; const [docName, title, anchor, descr, score, _filename] = item; @@ -75,20 +75,24 @@ const _displayItem = (item, searchTerms) => { if (dirname.match(/\/index\/$/)) dirname = dirname.substring(0, dirname.length - 6); else if (dirname === "index/") dirname = ""; - requestUrl = docUrlRoot + dirname; + requestUrl = contentRoot + dirname; linkUrl = requestUrl; } else { // normal html builders - requestUrl = docUrlRoot + docName + docFileSuffix; + requestUrl = contentRoot + docName + docFileSuffix; linkUrl = docName + docLinkSuffix; } let linkEl = listItem.appendChild(document.createElement("a")); linkEl.href = linkUrl + anchor; linkEl.dataset.score = score; linkEl.innerHTML = title; - if (descr) + if (descr) { listItem.appendChild(document.createElement("span")).innerHTML = " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } else if (showSearchSummary) fetch(requestUrl) .then((responseData) => responseData.text()) @@ -97,6 +101,9 @@ const _displayItem = (item, searchTerms) => { listItem.appendChild( Search.makeSearchSummary(data, searchTerms) ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); }); Search.output.appendChild(listItem); }; @@ -115,14 +122,15 @@ const _finishSearch = (resultCount) => { const _displayNextItem = ( results, resultCount, - searchTerms + searchTerms, + highlightTerms, ) => { // results left, load the summary and display it // this is intended to be dynamic (don't sub resultsCount) if (results.length) { - _displayItem(results.pop(), searchTerms); + _displayItem(results.pop(), searchTerms, highlightTerms); setTimeout( - () => _displayNextItem(results, resultCount, searchTerms), + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), 5 ); } @@ -360,7 +368,7 @@ const Search = { // console.info("search results:", Search.lastresults); // print the results - _displayNextItem(results, results.length, searchTerms); + _displayNextItem(results, results.length, searchTerms, highlightTerms); }, /** diff --git a/docs/_static/sphinx_highlight.js b/docs/_static/sphinx_highlight.js index aae669d..8a96c69 100644 --- a/docs/_static/sphinx_highlight.js +++ b/docs/_static/sphinx_highlight.js @@ -29,14 +29,19 @@ const _highlight = (node, addItems, text, className) => { } span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); parent.insertBefore( span, parent.insertBefore( - document.createTextNode(val.substr(pos + text.length)), + rest, node.nextSibling ) ); node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); if (isInSVG) { const rect = document.createElementNS( @@ -140,5 +145,10 @@ const SphinxHighlight = { }, }; -_ready(SphinxHighlight.highlightSearchWords); -_ready(SphinxHighlight.initEscapeListener); +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/docs/changelog.html b/docs/changelog.html new file mode 100644 index 0000000..b8a7f47 --- /dev/null +++ b/docs/changelog.html @@ -0,0 +1,363 @@ + + + + + + + + unicorn-binance-suite Change Log — unicorn_binance_suite 1.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + +
+
+
+
+ +
+

unicorn-binance-suite Change Log

+

All notable changes to this project will be documented in this file.

+

The format is based on Keep a Changelog and this project adheres to +Semantic Versioning.

+

Discussions about unicorn-fy releases!

+

How to upgrade to the latest version!

+
+

1.1.0.dev (development stage/unreleased/unstable)

+
+
+

1.1.0

+
+
+

Adding

+
    +
  • unicorn-binance-trailing-stop-loss

  • +
+
+
+

1.0.2

+

Testing azure pipe

+
+
+

1.0.1

+

PYPI and Conda integration

+
+
+

1.0.0

+

Initial release.

+
+
+ + +
+
+
+
+ +
+
+ + + + + + + + \ No newline at end of file diff --git a/docs/code_of_conduct.html b/docs/code_of_conduct.html new file mode 100644 index 0000000..18da746 --- /dev/null +++ b/docs/code_of_conduct.html @@ -0,0 +1,405 @@ + + + + + + + + Contributor Covenant Code of Conduct — unicorn_binance_suite 1.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + +
+
+
+
+ +
+

Contributor Covenant Code of Conduct

+
+

Our Pledge

+

In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation.

+
+
+

Our Standards

+

Examples of behavior that contributes to creating a positive environment +include:

+
    +
  • Using welcoming and inclusive language

  • +
  • Being respectful of differing viewpoints and experiences

  • +
  • Gracefully accepting constructive criticism

  • +
  • Focusing on what is best for the community

  • +
  • Showing empathy towards other community members

  • +
+

Examples of unacceptable behavior by participants include:

+
    +
  • The use of sexualized language or imagery and unwelcome sexual attention or +advances

  • +
  • Trolling, insulting/derogatory comments, and personal or political attacks

  • +
  • Public or private harassment

  • +
  • Publishing others’ private information, such as a physical or electronic +address, without explicit permission

  • +
  • Other conduct which could reasonably be considered inappropriate in a +professional setting

  • +
+
+
+

Our Responsibilities

+

Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior.

+

Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful.

+
+
+

Scope

+

This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers.

+
+
+

Enforcement

+

Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at https://www.lucit.tech/contact-unicorn-developers.html. +All complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately.

+

Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project’s leadership.

+
+
+

Attribution

+

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

+

For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq

+
+
+ + +
+
+
+
+ +
+
+ + + + + + + + \ No newline at end of file diff --git a/docs/contributing.html b/docs/contributing.html new file mode 100644 index 0000000..03c1d39 --- /dev/null +++ b/docs/contributing.html @@ -0,0 +1,340 @@ + + + + + + + + Contributing — unicorn_binance_suite 1.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + +
+
+
+
+ +
+

Contributing

+

When contributing to this repository, please first discuss the change you wish to make via +issue +with the owners of this repository before making a change.

+

Please note we have a +code of conduct, +please follow it in all your interactions with the project.

+
+

Pull Request Process

+
    +
  1. Discuss with owners

  2. +
  3. Fork

  4. +
  5. Contribute

  6. +
  7. Fulfill and confirm requirements of the pull request

  8. +
  9. Trigger the pull request

  10. +
+
+
+ + +
+
+
+
+ +
+
+ + + + + + + + \ No newline at end of file diff --git a/docs/genindex.html b/docs/genindex.html index 38a1338..a0092b0 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -1,22 +1,20 @@ - - + - Index — unicorn-binance-suite 1.1.0 documentation + Index — unicorn_binance_suite 1.1.0 documentation - - + + - - - + + + - - + - - + + + - - + + + + + + + + + + + + + + + + +
+ + + + +
+ + + +
+
+
+
+ +
+

LSOSL - LUCIT Synergetic Open Source License

+

Version 1.0, November 2023

+
    +
  1. INTRODUCTION

  2. +
  3. PROJECT INFORMATION

  4. +
  5. LICENSE CONDITIONS AND VERIFICATION

  6. +
  7. LICENSE PURCHASE

  8. +
  9. CONTRIBUTING CODE

  10. +
  11. USAGE AND DISTRIBUTION

  12. +
  13. DATA COLLECTION AND LICENSE CONTROL

  14. +
  15. THIRD-PARTY SOFTWARE

  16. +
  17. DISCLAIMER OF WARRANTY AND LIABILITY

  18. +
  19. CHANGES TO LICENSE TERMS

  20. +
+
+
    +
  1. INTRODUCTION

  2. +
+

The “LUCIT Synergetic Open Source License” oversees the utilization and distribution of the UNICORN Binance Suite +by LUCIT IT-Management GmbH. This API enables the effortless integration of Binance features into diverse applications.

+
    +
  1. PROJECT INFORMATION

  2. +
+ +
    +
  1. LICENSE CONDITIONS AND VERIFICATION

  2. +
+

The use of UNICORN Binance Suite requires a license key and an API secret.

+

Licenses are available at: https://shop.lucit.services/software

+

Verification is done via a client-side module that forwards the license details to our backend for validation. +The software may be used and distributed without restriction, the only condition is that the execution requires a valid +license from LUCIT (https://shop.lucit.services/software) and must be operated with such a license.

+

For transparency, our licensing client module is available on GitHub: +https://github.com/LUCIT-Systems-and-Development/lucit-licensing-python

+
    +
  1. LICENSE PURCHASE

  2. +
+

Usage of the our software necessitates obtaining a license from the LUCIT Online Shop.

+

More details can be found at: https://shop.lucit.services/software

+
    +
  1. CONTRIBUTING CODE

  2. +
+

Contributions via GitHub pull requests are welcome. However, contributors should be aware that submitted code +automatically becomes LUCIT IT-Management GmbH’s property and copyright.

+
    +
  1. USAGE AND DISTRIBUTION

  2. +
+

The LSOSL licensed projects of LUCIT IT-Management GmbH can be used and integrated into any application without +restriction and distributed as desired. The only condition is that the execution of our software requires a valid +license from LUCIT (https://shop.lucit.services/software) and must be operated with such a license.

+

For information on library versions that do not contain a license requirement, please contact: sales@lucit.tech

+
    +
  1. DATA COLLECTION AND LICENSE CONTROL

  2. +
+

For license adherence, test license misuse prevention, API rate monitoring, and service improvement, we gather:

+
    +
  • User IP addresses

  • +
  • Instance log data

  • +
  • Used Python version

  • +
  • Operating system type

  • +
  • API usage rates

  • +
  • MAC addresses (for misuse detection)

  • +
  • Data volume processed (anonymously aggregated)

  • +
+

This data is stored only for its intended purpose and duration, except for anonymous statistics. We commit to +confidentiality and non-disclosure. Details are in our privacy policy.

+
    +
  1. THIRD-PARTY SOFTWARE

  2. +
+

The software may embed third-party code or libraries, each governed by their respective licenses. Ensure awareness and +compliance when using the software.

+
    +
  1. DISCLAIMER OF WARRANTY AND LIABILITY

  2. +
+

The software is rendered “as is”, sans any assurances. LUCIT IT-Management GmbH disclaims liability for any potential +repercussions arising from software usage.

+
    +
  1. CHANGES TO LICENSE TERMS

  2. +
+

LUCIT IT-Management GmbH reserves the right to modify, alter, or update the terms of this license at any time and at +its sole discretion. Users are encouraged to review the license terms regularly to ensure compliance.

+
+

Thank you for selecting the UNICORN Binance Suite and products from LUCIT IT-Management GmbH. We deeply value +your trust in our technologies.

+

LUCIT IT-Management GmbH - Am Berg 391, 3970 Weitra, AUSTRIA - https://www.lucit.tech

+
+ + +
+
+
+
+ +
+
+ + + + + + + + \ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 0000000..1ad613c --- /dev/null +++ b/docs/modules.html @@ -0,0 +1,304 @@ + + + + + + + + unicorn_binance_suite — unicorn_binance_suite 1.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + +
+
+
+
+ +
+

unicorn_binance_suite

+
+ + +
+
+
+
+ +
+
+ + + + + + + + \ No newline at end of file diff --git a/docs/objects.inv b/docs/objects.inv index c7c505d39497c5143dd2a3f653946ec0085ca5ec..73786b28f61894b1f150fa081827f86b47c7b738 100644 GIT binary patch delta 344 zcmV-e0jK`q0>%T7F9}~_X>MU|V`X2FI81+0%}#_c5We#i;{#yg)uWt9aF>W1kEA=D zg(fhwDXo#4ui@+YBo+!0%qHHZ-+Vv)T5J_J)JX$_(~nvZ(g(m5yl-9KfoFqaIXxRz zjFb-EID%{@K_N|oqN$ckjl$Za+ga^b(J&Ks)||Z)8|HTkwk`~sKrYjAVg}QNWO#pn zxefluE+9!mY*^FBEa}vlx=FO6QIJn#@=IHsH;gyxPMU|V`VLoI81+!L2AP=5JmSo#qs7=h`1k=DJ?| zfXXSPfWja-()j&b_ws;#5GI=XD~?~TV?OX#FDd5`BoYf7w0CNs}0R_Jpcdz diff --git a/docs/readme.html b/docs/readme.html new file mode 100644 index 0000000..ec006ff --- /dev/null +++ b/docs/readme.html @@ -0,0 +1,615 @@ + + + + + + + + UNICORN Binance Suite — unicorn_binance_suite 1.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Get a UNICORN Binance Suite License

+

GitHub +GitHub Release +GitHub Downloads +Anaconda Release +Anaconda Downloads +PyPi Release +PyPi Downloads +License +Supported Python Version +PyPI - Status +Build and Publish GH+PyPi +Build and Publish Anaconda +Read the Docs +Read How To`s +Telegram +Gitter

+

LUCIT-UBS-Banner

+
+

UNICORN Binance Suite

+

Description | Installation | How To | Change Log | +Documentation | Social | Notifications | Bugs | +Contributing | Disclaimer | Commercial Support

+
+

Description

+

The UNICORN Binance Suite for Python is a collection of open +source Python packages from LUCIT Systems and Development that are useful for creating +automated trading systems (bots) that connect to the Binance API.

+

The suite is the most stable, powerful and convenient way to interact with various Binance API endpoints via +REST and +Websocket and to +manage local order books and +trailing stop losses.

+

All libraries in the suite are coordinated with each other, interlock perfectly, are fully documented and offer +standardized interfaces and tools for the programmer. LUCIT continuously develops the modules, fixes bugs, tests the +libraries extensively and offers fast, direct and free support.

+

All modules are delivered optimized as PyPy and as C++ compilations (Cython) via PyPi and Anaconda. The package +creation runs completely transparently directly from the respective GitHub repository through GitHub Actions and is +deployed directly to PyPi and Anaconda in a traceable manner. This process makes it tamper-proof for the user to +understand which code is contained in which package and can therefore easily install optimized builds for the platform, +architecture and Python version used.

+
+
+

Modules of the UNICORN Binance Suite

+
    +
  • UnicornFy: Convert received raw data from crypto exchange API endpoints into well-formed python dictionaries.

  • +
  • UNICORN Binance Local Depth Cache: A local Binance DepthCache Manager for Python that supports multiple depth caches in one instance in a easy, fast, flexible, robust and fully-featured way.

  • +
  • UNICORN Binance REST API: An unofficial Python API to use the Binance REST API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, us, tr) in a easy, fast, flexible, robust and fully-featured way.

  • +
  • UNICORN Binance Trailing Stop Loss: A Trailing Stop Loss Python Lib and Command Line Tool.

  • +
  • UNICORN Binance WebSocket API: An unofficial Python API to use the Binance Websocket API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, com-coin_futures, us, tr, dex/chain+testnet) in a easy, fast, flexible, robust and fully-featured way.

  • +
+

If you like the project, please +star it on +GitHub!

+
+
+

Get a UNICORN Binance Suite License

+

To run modules of the UNICORN Binance Suite you need a valid license!

+
+
+

Installation and Upgrade

+

The modules require Python 3.7 or above, as they depend on Pythons latest asyncio features for asynchronous/concurrent +processing.

+

For the PyPy interpreter we offer packages only from Python version 3.9 and higher.

+

Anaconda packages are available from Python version 3.8 and higher.

+

If you run into errors during the installation take a look here.

+
+

A Cython binary, PyPy or source code based CPython wheel of the latest version with pip from PyPI

+

Our Cython and PyPy Wheels are available on PyPI, +these wheels offer significant advantages for Python developers:

+
    +
  • Performance Boost with Cython Wheels: Cython is a programming language that supplements Python with static +typing and C-level performance. By compiling Python code into C, Cython Wheels can significantly enhance the +execution speed of Python code, especially in computationally intensive tasks. This means faster runtimes and more +efficient processing for users of our package.

  • +
  • PyPy Wheels for Enhanced Efficiency: PyPy is an alternative Python interpreter known for its speed and +efficiency. It uses Just-In-Time (JIT) compilation, which can dramatically improve the performance of Python code. +Our PyPy Wheels are tailored for compatibility with PyPy, allowing users to leverage this speed advantage seamlessly.

  • +
+

Both Cython and PyPy Wheels on PyPI make the installation process simpler and more straightforward. They ensure that +you get the optimized version of our package with minimal setup, allowing you to focus on development rather than +configuration.

+
+

Installation

+

pip install unicorn-binance-suite

+
+
+

Update

+

pip install unicorn-binance-suite --upgrade

+
+
+
+

A Conda Package of the latest version with conda from Anaconda

+

The unicorn-binance-suite package is also available as a Cython version for the linux-64, osx-64 +and win-64 architectures with Conda through the +lucit channel.

+

For optimal compatibility and performance, it is recommended to source the necessary dependencies from the +conda-forge channel.

+
+

Installation

+
conda config --add channels conda-forge
+conda config --add channels lucit
+conda install -c lucit unicorn-binance-suite
+
+
+
+
+

Update

+

conda update -c lucit unicorn-binance-suite

+
+
+
+

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-suite/archive/$(curl -s https://api.github.com/repos/LUCIT-Systems-and-Development/unicorn-binance-suite/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade

+
+
+

Windows

+

Use the below command with the version (such as 1.1.0) you determined +here:

+

pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/archive/1.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-suite/tarball/master --upgrade

+
+
+

Conda environment, Virtualenv or plain Python

+

Download the latest release +or the current master branch +and use:

+
    +
  • ./environment.yml

  • +
  • ./pyproject.toml

  • +
  • ./requirements.txt

  • +
  • ./setup.py

  • +
+
+
+
+

Change Log

+

https://unicorn-binance-suite.docs.lucit.tech//changelog.html

+

Please look for the information in the README.md of the responsible subrepository.

+
+
+

Documentation

+ +

Please look for the information in the README.md of the responsible subrepository.

+
+
+

Howto

+ +
+
+

Project Homepage

+

https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite

+
+
+

Wiki

+

https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/wiki

+
+
+

Social

+ +
+
+

Receive Notifications

+

Follow us on Twitter or on Facebook for general news about the unicorn-binance-suite!

+

Please look for the information in the README.md of the responsible subrepository for spezific notifications.

+
+
+

How to report Bugs or suggest Improvements?

+

Please look for the information in the README.md of the responsible subrepository.

+
+
+

Contributing

+

Please look for the information in the README.md of the responsible subrepository.

+
+
+

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.

+
+
+

SOCKS5 Proxy / Geoblocking

+

We would like to explicitly point out that in our opinion US citizens are exclusively authorized to trade on Binance.US +and that this restriction must not be circumvented!

+

The purpose of supporting a SOCKS5 proxy in the UNICORN Binance Suite and its modules is to allow non-US citizens to +use US services. For example, GitHub actions with UBS will not work without a SOCKS5 proxy, as they will inevitably run +on servers in the US and be blocked by Binance.com. Moreover, it also seems justified that traders, data scientists and +companies from the US analyze binance.com market data - as long as they do not trade there.

+
+
+
+

Commercial Support

+

Get professional and fast support

+

Do you need a developer, operator or consultant? Contact us for a non-binding initial consultation!

+
+
+ + +
+
+
+
+ +
+
+ + + + + + + + \ No newline at end of file diff --git a/docs/search.html b/docs/search.html index 0563bdc..b4370a0 100644 --- a/docs/search.html +++ b/docs/search.html @@ -1,25 +1,23 @@ - - + - Search — unicorn-binance-suite 1.1.0 documentation + Search — unicorn_binance_suite 1.1.0 documentation - - + + - - - + + + - @@ -46,31 +44,39 @@