Skip to content

Commit

Permalink
2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
oliver-zehentleitner committed Nov 9, 2023
1 parent b1a2903 commit 0a5a82e
Show file tree
Hide file tree
Showing 36 changed files with 3,876 additions and 820 deletions.
132 changes: 65 additions & 67 deletions docs/CHANGELOG.html

Large diffs are not rendered by default.

123 changes: 71 additions & 52 deletions docs/README.html

Large diffs are not rendered by default.

121 changes: 121 additions & 0 deletions docs/_sources/changelog.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# unicorn-binance-rest-api 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-binance-rest-api releases!](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/discussions/categories/releases)

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

## 1.10.0.dev (development stage/unreleased/unstable)

## 1.10.0
### Added
- `"s": 1,` to helpers.py to fix kline_1s support
- `create_margin_oco_order()`, `cancel_margin_oco_order()`, `get_margin_oco_order()`, `get_open_margin_oco_orders()`

## 1.9.0
### Added
- `futures_stream_get_listen_key()`, `futures_stream_keepalive()` and `futures_stream_close()`
- `futures_coin_stream_get_listen_key()`, `futures_coin_stream_keepalive()` and `futures_coin_stream_close()`
### Removed
- jex.com support

## 1.8.1
### Fixing
- `requests.exceptions.InvalidHeader`: Header part (False) from {'X-MBX-APIKEY': False} must be of type str or bytes, not <class 'bool'>

## 1.8.0
### Added
- `output="value"` and `throw_exception=True` to: `stream_get_listen_key()`, `margin_stream_get_listen_key()`, `isolated_margin_stream_get_listen_key()`
- `throw_exception=True` to: `_request()`, `_request_api()`, `_request_margin_api()`, `_request_website()`, `_request_futures_api()`, `_request_futures_data_api()`, `_request_futures_coin_api()`, `_request_futures_coin_data_api()`, `_handle_response()`, `stream_keepalive()`, `stream_close()`, `margin_stream_keepalive()`, `margin_stream_close()`, `isolated_margin_stream_keepalive()`, `isolated_margin_stream_close()`
### Fixing
- Issue in `get_used_weight()`

## 1.7.0
### Added
- SOCKS5 proxy support to [`BinanceRestApiManager()`](https://unicorn-binance-rest-api.docs.lucit.tech/unicorn_binance_rest_api.html#unicorn_binance_rest_api.manager.BinanceRestApiManager) -
New parameter: `socks5_proxy_server`, `socks5_proxy_user`, `socks5_proxy_pass`, `socks5_proxy_ssl_verification`

## 1.6.0
### Added
- New kline interval: 1s `KLINE_INTERVAL_1SECOND`
- `futures_place_batch_order()` - Placing batch orders for USD-M API. Thx [@hawkeye-bot](https://github.com/hawkeye-bot)
[PR#42](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/pull/42)
### Changed
- Dependency regex no specific version anymore

## 1.5.0
### Added
- `cancel_all_open_margin_orders()`
- `futures_auto_cancel_all_open_orders()`

## 1.4.3
Codebase equal to 1.4.2, testing azure pipe

## 1.4.2
### Changed
- Dependency regex to <= 2022.3.2 [issue#24](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/24)

## 1.4.1
### Fixed
- Binance Futures Testnet URL [issue#20](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/20)

## 1.4.0
### Adding
- `futures_commission_rate()` [issue#18](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/18)
### Changed
- Moved from https://github.com/oliver-zehentleitner to https://github.com/LUCIT-Systems-and-Development/
- removed "unicorn_binance_rest_api_"-part of the module file names (more info: [Discussions](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/discussions/19))
- Correctly scope loggers so that it plays nicely with others. [PR#17](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/pull/17)
- renamed logger name of all modules to "unicorn_binance_rest_api", in the implementation of
[PR#17](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/pull/17) every module has had
its own logger name.

## 1.3.0
### Added
- `exchange` parameter to manager class to replace `tld` parameter
- support for new endpoints: trbinance.com
- `disable_colorama` parameter to manager class
- `cancel_all_open_orders()` to cancel all orders of a symbol with one request. Thx @mfurlend
[issue#3](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/3)
### Changed
- `tld` is now obsolete
### Fixed
- ValueError in `get_used_weight()`
- get_open_margin_orders()
### Removed
- double definition of `make_universal_transfer()`
- binance.je support (Binance Jersey has ceased operations.)

## 1.2.0
### Added
- get_used_weight()
- futures_coin_place_batch_order()
### Changed
- Migrate from WAPI to SAPI [issue#7](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/7)
- URLs to Biannce Docs

## 1.1.1
### Fixed
- changed FUTURES_COIN_URL [PR#5](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/pull/5) -
Thanks to [flo-rian](https://github.com/flo-rian)

## 1.1.0
### Added
- logging
- update check

## 1.0.0
forked from Sam McHardy [python-binance v0.7.10](https://github.com/sammchardy/python-binance)
### Added
- get_latest_release_info()
- get_latest_version()
- is_update_availabe()
- get_version()
- get_user_agent()
- colorama as requirement
### Removed
- Websocket support from python-binance and dependencies
76 changes: 76 additions & 0 deletions docs/_sources/code_of_conduct.md.txt
Original file line number Diff line number Diff line change
@@ -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
17 changes: 17 additions & 0 deletions docs/_sources/contributing.md.txt
Original file line number Diff line number Diff line change
@@ -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-rest-api/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-rest-api/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
139 changes: 115 additions & 24 deletions docs/_sources/copyright.rst.txt
Original file line number Diff line number Diff line change
@@ -1,24 +1,115 @@
MIT License
===========

Copyright (c) 2017-2021 Sam McHardy (https://github.com/sammchardy)
Copyright (c) 2021-2023 LUCIT Systems and Development (https://www.lucit.tech) and Oliver Zehentleitner (https://about.me/oliver-zehentleitner)


Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
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 REST
API, a part 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 REST API
- Project page: https://www.lucit.tech/unicorn-binance-rest-api.html
- GitHub repository: https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api
- PyPI repository: https://pypi.org/project/unicorn-binance-rest-api
- Get a license: https://shop.lucit.services/software


3. LICENSE CONDITIONS AND VERIFICATION

The use of UNICORN Binance REST API 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.

Furthermore, this license explicitly permits Conda-Forge, an open-source community-driven platform for package
management and distribution operated by NumFOCUS, to test the software package following its creation to ensure
functionality, compatibility, and security standards are met. This permission is granted to support the community's
efforts in maintaining a robust ecosystem for software distribution and to guarantee the quality and performance of the
software for end users.

For information on library versions that do not contain a license requirement, please contact: [email protected]


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 REST API 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
9 changes: 6 additions & 3 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@ Welcome to unicorn-binance-rest-api's documentation!
:maxdepth: 3
:caption: Contents:

Readme <README.md>
Readme <readme.md>
Modules <modules.rst>
ChangeLog <CHANGELOG.md>
Copyright <copyright.rst>
ChangeLog <changelog.md>
Code of Conduct <code_of_conduct.md>
Contributing <contributing.md>
License <license.rst>
Security <security.md>


Indices and tables
Expand Down
Loading

0 comments on commit 0a5a82e

Please sign in to comment.