From 86fd2da654d1dcafb10f794d597610eee52c4cf9 Mon Sep 17 00:00:00 2001 From: Oliver Date: Mon, 13 May 2024 14:24:16 +0200 Subject: [PATCH] docs examples --- README.md | 4 +- dev/sphinx/source/changelog.md | 5 + dev/sphinx/source/readme.md | 11 +- docs/_modules/index.html | 2 +- docs/_modules/unicorn_fy/unicorn_fy.html | 67 ++-- docs/_sources/changelog.md.txt | 5 + docs/_sources/readme.md.txt | 11 +- docs/changelog.html | 397 ++++++++++++----------- docs/code_of_conduct.html | 2 +- docs/contributing.html | 2 +- docs/genindex.html | 26 +- docs/index.html | 54 +-- docs/license.html | 2 +- docs/modules.html | 5 +- docs/objects.inv | Bin 625 -> 599 bytes docs/py-modindex.html | 2 +- docs/readme.html | 23 +- docs/search.html | 2 +- docs/searchindex.js | 2 +- docs/security.html | 2 +- docs/unicorn_fy.html | 43 +-- 21 files changed, 292 insertions(+), 375 deletions(-) diff --git a/README.md b/README.md index 73105ff..3413307 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ and can be activated by setting parameter or for specific streams with the parameter [`output` of `create_stream()` to `UnicornFy`](https://lucit-systems-and-development.github.io/unicorn-binance-websocket-api/unicorn_binance_websocket_api.html?highlight=output#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.create_stream). -## Get the right [logger](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/example_logging.py): +## Get the right [logger](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/examples/_archive/example_logging.py): ``` logging.getLogger("unicorn_fy") ``` @@ -227,7 +227,7 @@ or the [current master branch](https://github.com/LUCIT-Systems-and-Development/ To receive notifications on available updates you can [![watch](https://raw.githubusercontent.com/lucit-systems-and-development/unicorn-fy/master/images/misc/watch.png)](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/watchers) the repository on [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-fy), write your -[own script](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/example_version_of_this_package.py) +[own script](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/examples/_archive/example_version_of_this_package.py) with using [`is_update_available()`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=is_update#unicorn_fy.unicorn_fy.UnicornFy.is_update_availabe) or you use the diff --git a/dev/sphinx/source/changelog.md b/dev/sphinx/source/changelog.md index b61fc39..3d9f402 100644 --- a/dev/sphinx/source/changelog.md +++ b/dev/sphinx/source/changelog.md @@ -10,6 +10,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p [How to upgrade to the latest version!](https://unicorn-fy.docs.lucit.tech/readme.html#installation-and-upgrade) ## 0.14.2.dev (development stage/unreleased/unstable) +### Added +- `__version__` and made use of it. +### Removed +- `binance_je_websocket()` +- `jex_com_websocket()` ## 0.14.2 ### Added diff --git a/dev/sphinx/source/readme.md b/dev/sphinx/source/readme.md index 86f763e..3413307 100644 --- a/dev/sphinx/source/readme.md +++ b/dev/sphinx/source/readme.md @@ -20,7 +20,6 @@ [![Telegram](https://img.shields.io/badge/community-telegram-41ab8c)](https://t.me/unicorndevs) [![Gitter](https://img.shields.io/badge/community-gitter-41ab8c)](https://gitter.im/unicorn-binance-suite/unicorn-fy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Get Free Professional Support](https://img.shields.io/badge/chat-lucit%20support-004166)](https://www.lucit.tech/get-support.html) -[![ChatGPT UNICORN Binance Suite Assistant](https://img.shields.io/badge/chatgpt-%20ubs%20assistant-DA70D6)](https://chat.openai.com/g/g-VjCOjRhCJ-unicorn-binance-suite-assistant) [![LUCIT-UNICORNFY-Banner](https://raw.githubusercontent.com/lucit-systems-and-development/unicorn-fy/master/images/logo/LUCIT-UNICORNFY-Banner-Readme.png)](https://www.lucit.tech/unicorn-fy.html) @@ -34,9 +33,7 @@ into well-formed python dictionaries. Part of ['UNICORN Binance Suite'](https://www.lucit.tech/unicorn-binance-suite.html). -Get help with the integration of the `UNICORN Binance Suite` modules from the -[`UNICORN Binance Suite Assistant` GPT](https://chat.openai.com/g/g-VjCOjRhCJ-unicorn-binance-suite-assistant) or -[a real human LUCIT employee](https://www.lucit.tech/get-support.html). +[Get help](https://www.lucit.tech/get-support.html) with the integration of the `UNICORN Binance Suite` modules! ``` import unicorn_fy @@ -76,7 +73,7 @@ and can be activated by setting parameter or for specific streams with the parameter [`output` of `create_stream()` to `UnicornFy`](https://lucit-systems-and-development.github.io/unicorn-binance-websocket-api/unicorn_binance_websocket_api.html?highlight=output#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.create_stream). -## Get the right [logger](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/example_logging.py): +## Get the right [logger](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/examples/_archive/example_logging.py): ``` logging.getLogger("unicorn_fy") ``` @@ -96,10 +93,8 @@ logging.getLogger("unicorn_fy") | [Binance Futures Testnet](https://testnet.binancefuture.com) ([API](https://github.com/binance-exchange/binance-official-api-docs)) | [`binance_com_futures_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_coin_futures_websocket) | STABLE | | [Binance Coin Futures](https://www.binance.com) ([API](https://github.com/binance-exchange/binance-official-api-docs)) | [`binance_com_coin_futures_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_coin_futures_websocket) | NEEDS_YOUR_HELP | | [Binance Coin Futures Testnet](https://testnet.binancefuture.com) ([API](https://github.com/binance-exchange/binance-official-api-docs)) | [`binance_com_coin_futures_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_futures_websocket) | NEEDS_YOUR_HELP | -| [Binance Jersey](https://www.binance.je) ([API](https://github.com/binance-jersey/binance-official-api-docs/)) | [`binance_je_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_je_websocket) | STABLE | | [Binance US](https://www.binance.us) ([API](https://github.com/binance-us/binance-official-api-docs)) | [`binance_us_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_us_websocket) | STABLE | | [Binance TR](https://www.trbinance.com) ([API](https://www.trbinance.com/apidocs)) | [`trbinance_com_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.trbinance_com_websocket) | STABLE | -| [Binance JEX](https://www.jex.com) ([API](https://jexapi.github.io/api-doc/spot.html#change-log)) | [`jex_com_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.jex_com_websocket) | STABLE | | [Binance DEX](https://www.binance.org) ([API](https://docs.binance.org/)) | [`binance_org_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_org_websocket) | NEEDS_YOUR_HELP | | [Binance DEX Testnet](https://testnet.binance.org) ([API](https://docs.binance.org/)) | [`binance_org_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_org_websocket) | NEEDS_YOUR_HELP | @@ -232,7 +227,7 @@ or the [current master branch](https://github.com/LUCIT-Systems-and-Development/ To receive notifications on available updates you can [![watch](https://raw.githubusercontent.com/lucit-systems-and-development/unicorn-fy/master/images/misc/watch.png)](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/watchers) the repository on [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-fy), write your -[own script](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/example_version_of_this_package.py) +[own script](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/examples/_archive/example_version_of_this_package.py) with using [`is_update_available()`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=is_update#unicorn_fy.unicorn_fy.UnicornFy.is_update_availabe) or you use the diff --git a/docs/_modules/index.html b/docs/_modules/index.html index c0bcda0..f9cbbf0 100644 --- a/docs/_modules/index.html +++ b/docs/_modules/index.html @@ -248,7 +248,7 @@

Navigation

Index of all LUCIT Software Documentation
© Copyright 2023-2023, LUCIT Systems and Development. All Rights Reserved.. See License for more information.
- Last updated on May 09 2024 at 21:03 (CET). + Last updated on May 13 2024 at 14:24 (CET). Found a bug?
Created using Sphinx 7.2.6. diff --git a/docs/_modules/unicorn_fy/unicorn_fy.html b/docs/_modules/unicorn_fy/unicorn_fy.html index 36cf1fc..7e5983c 100644 --- a/docs/_modules/unicorn_fy/unicorn_fy.html +++ b/docs/_modules/unicorn_fy/unicorn_fy.html @@ -190,7 +190,10 @@

Source code for unicorn_fy.unicorn_fy

 import time
 import ujson as json
 
-logger = logging.getLogger("unicorn_fy")
+__app_name__: str = "unicorn-fy"
+__version__: str = "0.14.2.dev"
+__logger__ = logging.getLogger("unicorn_fy")
+logger = __logger__
 
 
 
@@ -205,20 +208,20 @@

Source code for unicorn_fy.unicorn_fy

         - Binance-com-coin_futures
         - Binance-com-margin
         - Binance-com-isolated_margin
-        - Binance.je
         - Binance.us
         - trBinance.com
         - Binance.org
-        - Jex.com
     """
-    VERSION = "0.14.2"
 
     def __init__(self, debug=False):
         self.last_update_check_github = {'timestamp': time.time(),
                                          'status': None}
+        self.name = __app_name__
+        self.version = __version__
+
         if debug is True:
-            logger.info(f"New instance of unicorn-fy_{self.VERSION}-{'compiled' if cython.compiled else 'source'} on "
-                        f"{str(platform.system())} {str(platform.release())} started ...")
+            logger.info(f"New instance of {__app_name__}_{__version__}-{'compiled' if cython.compiled else 'source'} "
+                        f"on {str(platform.system())} {str(platform.release())} started ...")
 
     def __enter__(self):
         logger.debug(f"Entering with-context of UnicornFy() ...")
@@ -327,21 +330,6 @@ 

Source code for unicorn_fy.unicorn_fy

                                                    show_deprecated_warning=False)
-
-[docs] - @staticmethod - def binance_je_websocket(stream_data_json): - """ - unicorn_fy binance.je (Jersey) raw_stream_data - - :param stream_data_json: The received raw stream data from the Binance websocket - :type stream_data_json: json - - :return: dict - """ - return UnicornFy.binance_websocket(stream_data_json, exchange="binance.je", show_deprecated_warning=False)
- -
[docs] @staticmethod @@ -395,7 +383,7 @@

Source code for unicorn_fy.unicorn_fy

         logger.debug("UnicornFy->binance_websocket(" + str(stream_data_json) + ")")
         if show_deprecated_warning is True:
             logger.warning("Using `UnicornFy.binance_websocket()` is deprecated, use "
-                           "`UnicornFy.binance_com_websocket()` or `UnicornFy.binance_je_websocket()` instead!")
+                           "`UnicornFy.binance_com_websocket()` instead!")
 
         if UnicornFy.is_json(stream_data_json) is False:
             return stream_data_json
@@ -459,12 +447,12 @@ 

Source code for unicorn_fy.unicorn_fy

 
         try:
             if stream_data['result'] is None:
-                unicorn_fied_version = [exchange, UnicornFy.VERSION]
+                unicorn_fied_version = [exchange, UnicornFy.get_version()]
                 stream_data['unicorn_fied'] = unicorn_fied_version
                 logger.debug(f"UnicornFy->binance_websocket({str(stream_data)}, {str(exchange)}")
                 return stream_data
             else:
-                unicorn_fied_version = [exchange, UnicornFy.VERSION]
+                unicorn_fied_version = [exchange, UnicornFy.get_version]
                 stream_data['unicorn_fied'] = unicorn_fied_version
                 logger.debug(f"UnicornFy->binance_websocket({str(stream_data)}, {str(exchange)}")
                 return stream_data
@@ -473,7 +461,7 @@ 

Source code for unicorn_fy.unicorn_fy

 
         try:
             if stream_data['error']:
-                unicorn_fied_version = [exchange, UnicornFy.VERSION]
+                unicorn_fied_version = [exchange, UnicornFy.get_version()]
                 stream_data['unicorn_fied'] = unicorn_fied_version
                 logger.debug(f"UnicornFy->binance_websocket({str(stream_data)}, {str(exchange)}")
                 return stream_data
@@ -744,7 +732,7 @@ 

Source code for unicorn_fy.unicorn_fy

                                  'order_creation_time': stream_data['data']['O'],
                                  'cumulative_quote_asset_transacted_quantity': stream_data['data']['Z'],
                                  'last_quote_asset_transacted_quantity': stream_data['data']['Y']}
-        unicorn_fied_version = [exchange, UnicornFy.VERSION]
+        unicorn_fied_version = [exchange, UnicornFy.get_version()]
         unicorn_fied_data['unicorn_fied'] = unicorn_fied_version
         logger.debug("UnicornFy->binance_com_futures_websocket(" + str(unicorn_fied_data) + ")")
         return unicorn_fied_data
@@ -833,12 +821,12 @@

Source code for unicorn_fy.unicorn_fy

 
         try:
             if stream_data['result'] is None:
-                unicorn_fied_version = [exchange, UnicornFy.VERSION]
+                unicorn_fied_version = [exchange, UnicornFy.get_version()]
                 stream_data['unicorn_fied'] = unicorn_fied_version
                 logger.debug(f"UnicornFy->binance_futures_websocket({str(stream_data)}, {str(exchange)}")
                 return stream_data
             else:
-                unicorn_fied_version = [exchange, UnicornFy.VERSION]
+                unicorn_fied_version = [exchange, UnicornFy.get_version()]
                 stream_data['unicorn_fied'] = unicorn_fied_version
                 logger.debug(f"UnicornFy->binance_futures_websocket({str(stream_data)}, {str(exchange)}")
                 return stream_data
@@ -847,7 +835,7 @@ 

Source code for unicorn_fy.unicorn_fy

 
         try:
             if stream_data['error']:
-                unicorn_fied_version = [exchange, UnicornFy.VERSION]
+                unicorn_fied_version = [exchange, UnicornFy.get_version()]
                 stream_data['unicorn_fied'] = unicorn_fied_version
                 logger.debug(f"UnicornFy->binance_futures_websocket({str(stream_data)}, {str(exchange)}")
                 return stream_data
@@ -1432,7 +1420,7 @@ 

Source code for unicorn_fy.unicorn_fy

         except KeyError as error_msg:
             logger.critical(f"UnicornFy->binance_futures_websocket({str(unicorn_fied_data)}) - "
                             f"error: {str(error_msg)} - Variable: {stream_data['data']}")
-        unicorn_fied_version = [exchange, UnicornFy.VERSION]
+        unicorn_fied_version = [exchange, UnicornFy.get_version()]
         try:
             unicorn_fied_data['unicorn_fied'] = unicorn_fied_version
         except TypeError as error_msg:
@@ -1442,21 +1430,6 @@ 

Source code for unicorn_fy.unicorn_fy

         return unicorn_fied_data
-
-[docs] - @staticmethod - def jex_com_websocket(stream_data_json): - """ - unicorn_fy jex.com raw_stream_data - - :param stream_data_json: The received raw stream data from the Binance websocket - :type stream_data_json: json - - :return: dict - """ - return UnicornFy.binance_websocket(stream_data_json, exchange="jex.com", show_deprecated_warning=False)
- -
[docs] @staticmethod @@ -1503,7 +1476,7 @@

Source code for unicorn_fy.unicorn_fy

 
         :return: str
         """
-        return UnicornFy.VERSION
+ return __version__
@@ -1680,7 +1653,7 @@

Navigation

Index of all LUCIT Software Documentation
© Copyright 2023-2023, LUCIT Systems and Development. All Rights Reserved.. See License for more information.
- Last updated on May 09 2024 at 20:42 (CET). + Last updated on May 13 2024 at 14:24 (CET). Found a bug?
Created using Sphinx 7.2.6. diff --git a/docs/_sources/changelog.md.txt b/docs/_sources/changelog.md.txt index b61fc39..3d9f402 100644 --- a/docs/_sources/changelog.md.txt +++ b/docs/_sources/changelog.md.txt @@ -10,6 +10,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p [How to upgrade to the latest version!](https://unicorn-fy.docs.lucit.tech/readme.html#installation-and-upgrade) ## 0.14.2.dev (development stage/unreleased/unstable) +### Added +- `__version__` and made use of it. +### Removed +- `binance_je_websocket()` +- `jex_com_websocket()` ## 0.14.2 ### Added diff --git a/docs/_sources/readme.md.txt b/docs/_sources/readme.md.txt index 86f763e..3413307 100644 --- a/docs/_sources/readme.md.txt +++ b/docs/_sources/readme.md.txt @@ -20,7 +20,6 @@ [![Telegram](https://img.shields.io/badge/community-telegram-41ab8c)](https://t.me/unicorndevs) [![Gitter](https://img.shields.io/badge/community-gitter-41ab8c)](https://gitter.im/unicorn-binance-suite/unicorn-fy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Get Free Professional Support](https://img.shields.io/badge/chat-lucit%20support-004166)](https://www.lucit.tech/get-support.html) -[![ChatGPT UNICORN Binance Suite Assistant](https://img.shields.io/badge/chatgpt-%20ubs%20assistant-DA70D6)](https://chat.openai.com/g/g-VjCOjRhCJ-unicorn-binance-suite-assistant) [![LUCIT-UNICORNFY-Banner](https://raw.githubusercontent.com/lucit-systems-and-development/unicorn-fy/master/images/logo/LUCIT-UNICORNFY-Banner-Readme.png)](https://www.lucit.tech/unicorn-fy.html) @@ -34,9 +33,7 @@ into well-formed python dictionaries. Part of ['UNICORN Binance Suite'](https://www.lucit.tech/unicorn-binance-suite.html). -Get help with the integration of the `UNICORN Binance Suite` modules from the -[`UNICORN Binance Suite Assistant` GPT](https://chat.openai.com/g/g-VjCOjRhCJ-unicorn-binance-suite-assistant) or -[a real human LUCIT employee](https://www.lucit.tech/get-support.html). +[Get help](https://www.lucit.tech/get-support.html) with the integration of the `UNICORN Binance Suite` modules! ``` import unicorn_fy @@ -76,7 +73,7 @@ and can be activated by setting parameter or for specific streams with the parameter [`output` of `create_stream()` to `UnicornFy`](https://lucit-systems-and-development.github.io/unicorn-binance-websocket-api/unicorn_binance_websocket_api.html?highlight=output#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.create_stream). -## Get the right [logger](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/example_logging.py): +## Get the right [logger](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/examples/_archive/example_logging.py): ``` logging.getLogger("unicorn_fy") ``` @@ -96,10 +93,8 @@ logging.getLogger("unicorn_fy") | [Binance Futures Testnet](https://testnet.binancefuture.com) ([API](https://github.com/binance-exchange/binance-official-api-docs)) | [`binance_com_futures_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_coin_futures_websocket) | STABLE | | [Binance Coin Futures](https://www.binance.com) ([API](https://github.com/binance-exchange/binance-official-api-docs)) | [`binance_com_coin_futures_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_coin_futures_websocket) | NEEDS_YOUR_HELP | | [Binance Coin Futures Testnet](https://testnet.binancefuture.com) ([API](https://github.com/binance-exchange/binance-official-api-docs)) | [`binance_com_coin_futures_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_com_futures_websocket) | NEEDS_YOUR_HELP | -| [Binance Jersey](https://www.binance.je) ([API](https://github.com/binance-jersey/binance-official-api-docs/)) | [`binance_je_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_je_websocket) | STABLE | | [Binance US](https://www.binance.us) ([API](https://github.com/binance-us/binance-official-api-docs)) | [`binance_us_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_us_websocket) | STABLE | | [Binance TR](https://www.trbinance.com) ([API](https://www.trbinance.com/apidocs)) | [`trbinance_com_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.trbinance_com_websocket) | STABLE | -| [Binance JEX](https://www.jex.com) ([API](https://jexapi.github.io/api-doc/spot.html#change-log)) | [`jex_com_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.jex_com_websocket) | STABLE | | [Binance DEX](https://www.binance.org) ([API](https://docs.binance.org/)) | [`binance_org_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_org_websocket) | NEEDS_YOUR_HELP | | [Binance DEX Testnet](https://testnet.binance.org) ([API](https://docs.binance.org/)) | [`binance_org_websocket(stream_data_json)`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=binance_com#unicorn_fy.unicorn_fy.UnicornFy.binance_org_websocket) | NEEDS_YOUR_HELP | @@ -232,7 +227,7 @@ or the [current master branch](https://github.com/LUCIT-Systems-and-Development/ To receive notifications on available updates you can [![watch](https://raw.githubusercontent.com/lucit-systems-and-development/unicorn-fy/master/images/misc/watch.png)](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/watchers) the repository on [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-fy), write your -[own script](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/example_version_of_this_package.py) +[own script](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/examples/_archive/example_version_of_this_package.py) with using [`is_update_available()`](https://unicorn-fy.docs.lucit.tech//unicorn_fy.html?highlight=is_update#unicorn_fy.unicorn_fy.UnicornFy.is_update_availabe) or you use the diff --git a/docs/changelog.html b/docs/changelog.html index ceb13a3..b1bc16d 100644 --- a/docs/changelog.html +++ b/docs/changelog.html @@ -65,106 +65,110 @@

Table of Contents

B

@@ -167,14 +165,12 @@

B

  • binance_com_isolated_margin_websocket() (unicorn_fy.unicorn_fy.UnicornFy static method)
  • binance_com_margin_websocket() (unicorn_fy.unicorn_fy.UnicornFy static method) -
  • -
  • binance_com_websocket() (unicorn_fy.unicorn_fy.UnicornFy static method)
  • -

    J

    - - -
    -

    M

      @@ -274,14 +262,6 @@

      U

    -

    V

    - - -
    -
    @@ -386,7 +366,7 @@

    Navigation

    Index of all LUCIT Software Documentation
    © Copyright 2023-2023, LUCIT Systems and Development. All Rights Reserved.. See License for more information.
    - Last updated on May 09 2024 at 21:03 (CET). + Last updated on May 13 2024 at 14:24 (CET). Found a bug?
    Created using Sphinx 7.2.6. diff --git a/docs/index.html b/docs/index.html index 5357117..7561f34 100644 --- a/docs/index.html +++ b/docs/index.html @@ -196,32 +196,32 @@

    Welcome to UnicornFy’s documentation!ChangeLog
  • Code of Conduct
      @@ -382,7 +382,7 @@

      Navigation

      Index of all LUCIT Software Documentation
      © Copyright 2023-2023, LUCIT Systems and Development. All Rights Reserved.. See License for more information.
      - Last updated on May 09 2024 at 21:03 (CET). + Last updated on May 13 2024 at 14:24 (CET). Found a bug?
      Created using Sphinx 7.2.6. diff --git a/docs/license.html b/docs/license.html index f210dd8..3c0ca70 100644 --- a/docs/license.html +++ b/docs/license.html @@ -314,7 +314,7 @@

      Navigation

      Index of all LUCIT Software Documentation
      © Copyright 2023-2023, LUCIT Systems and Development. All Rights Reserved.. See License for more information.
      - Last updated on May 09 2024 at 21:03 (CET). + Last updated on May 13 2024 at 14:24 (CET). Found a bug?
      Created using Sphinx 7.2.6. diff --git a/docs/modules.html b/docs/modules.html index b5e48be..02ce48e 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -176,14 +176,12 @@

      unicorn_fySubmodules
    • unicorn_fy.unicorn_fy module
      • UnicornFy @@ -332,7 +329,7 @@

        Navigation

        Index of all LUCIT Software Documentation
        © Copyright 2023-2023, LUCIT Systems and Development. All Rights Reserved.. See License for more information.
        - Last updated on May 09 2024 at 21:03 (CET). + Last updated on May 13 2024 at 14:24 (CET). Found a bug?
        Created using Sphinx 7.2.6. diff --git a/docs/objects.inv b/docs/objects.inv index 5d9396c3ae125187e9307a1bd9de421ea32526ab..1e4c0ef757ae0002bda3e756c1249a0b5c84fa96 100644 GIT binary patch delta 486 zcmVZQ5n8Yl!(SZGU+LMx5EYGlnKjkfWvuaVcw zlVoh!TRAPXH1@$D{xkEN56PC3w;F?&O)pOUO@}5q5FbRk$h#wT?tM1YSE8;8Q(7l@ z_cbp+ju`D!jNpdu%I>hF`3P^LdjrE#jA^Ou0o*!5$J};Pn}}TH=KPfz4nXJQ+GU zS--5P&|l$Lsao*X8+aT;c&oq-L9?0z?uKRc%WWbT9^b(6@IVlX%V3{>K1IQQi@RRk6EahV`%+4FO@?^O%zt5dMlm(*FCy(f=7^4Kgls=N{V cfEvv3{V&dX33+vTMfroG^uv(*1rKyji+|JdN&o-= delta 512 zcmV+b0{{Kj1n~rrdw*`*Fbv1I0}kHJ4$6Skf(XliA&X4Xu4JApA-GC{mK8X*li+sCTeTF@_!nn#)d!3)ad9w9`Feir0hEF0xM&cjIu!*xn^RMx32|DRvV+{0<+0~xtzLwE{*;9{YMn+ni}w=h`0Q!!dVSI!g-i7NSX6~{Yl(qq2L$6UuJe_ z%d=q!$uEjL$NY+jWBwpb)`Qov7=iwgVbk(1@Y6&AlxZe)WF<#jdQe1ALGPvsvX(s` zvVEg!U|*errFKj`YiIAlV}sl_%Y`a$#3rBy(_K@ey*`FK*}Y=?Bvbma%l!+hiKyl= Cl>=D- diff --git a/docs/py-modindex.html b/docs/py-modindex.html index dbdd50a..028f8f0 100644 --- a/docs/py-modindex.html +++ b/docs/py-modindex.html @@ -272,7 +272,7 @@

        Navigation

        Index of all LUCIT Software Documentation
        © Copyright 2023-2023, LUCIT Systems and Development. All Rights Reserved.. See License for more information.
        - Last updated on May 09 2024 at 21:03 (CET). + Last updated on May 13 2024 at 14:24 (CET). Found a bug?
        Created using Sphinx 7.2.6. diff --git a/docs/readme.html b/docs/readme.html index f1739fb..f022279 100644 --- a/docs/readme.html +++ b/docs/readme.html @@ -241,8 +241,7 @@

        Navigation

        Github Telegram Gitter -Get Free Professional Support -ChatGPT UNICORN Binance Suite Assistant

        +Get Free Professional Support

        LUCIT-UNICORNFY-Banner

        UnicornFy

        @@ -252,9 +251,7 @@

        UnicornFyLUCIT to convert received raw data from crypto exchange API endpoints into well-formed python dictionaries.

        Part of ‘UNICORN Binance Suite’.

        -

        Get help with the integration of the UNICORN Binance Suite modules from the -UNICORN Binance Suite Assistant GPT or -a real human LUCIT employee.

        +

        Get help with the integration of the UNICORN Binance Suite modules!

        import unicorn_fy
         
         received_stream_data_json = {"stream": "btcusdt@trade",
        @@ -290,7 +287,7 @@ 

        UnicornFyoutput of create_stream() to UnicornFy.

        -

        Get the right logger:

        +

        Get the right logger:

        logging.getLogger("unicorn_fy")
         
        @@ -359,11 +356,6 @@

        WebsocketsBinance Jersey (API) -binance_je_websocket(stream_data_json) -STABLE - - Binance US (API) binance_us_websocket(stream_data_json) STABLE @@ -374,11 +366,6 @@

        WebsocketsBinance JEX (API) -jex_com_websocket(stream_data_json) -STABLE - - Binance DEX (API) binance_org_websocket(stream_data_json) NEEDS_YOUR_HELP @@ -540,7 +527,7 @@

        Receive NotificationsTo receive notifications on available updates you can watch the repository on GitHub, write your -own script +own script with using is_update_available() or you use the @@ -772,7 +759,7 @@

        Navigation

        Index of all LUCIT Software Documentation
        © Copyright 2023-2023, LUCIT Systems and Development. All Rights Reserved.. See License for more information.
        - Last updated on May 09 2024 at 21:03 (CET). + Last updated on May 13 2024 at 14:24 (CET). Found a bug?
        Created using Sphinx 7.2.6. diff --git a/docs/search.html b/docs/search.html index 2df6175..fd8d095 100644 --- a/docs/search.html +++ b/docs/search.html @@ -227,7 +227,7 @@

        Navigation

        Index of all LUCIT Software Documentation
        © Copyright 2023-2023, LUCIT Systems and Development. All Rights Reserved.. See License for more information.
        - Last updated on May 09 2024 at 21:03 (CET). + Last updated on May 13 2024 at 14:24 (CET). Found a bug?
        Created using Sphinx 7.2.6. diff --git a/docs/searchindex.js b/docs/searchindex.js index c919396..0129c75 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "code_of_conduct", "contributing", "index", "license", "modules", "readme", "security", "unicorn_fy"], "filenames": ["changelog.md", "code_of_conduct.md", "contributing.md", "index.rst", "license.rst", "modules.rst", "readme.md", "security.md", "unicorn_fy.rst"], "titles": ["unicorn-fy Change Log", "Contributor Covenant Code of Conduct", "Contributing", "Welcome to UnicornFy\u2019s documentation!", "MIT License", "unicorn_fy", "UnicornFy", "Security Policies and Procedures", "unicorn_fy package"], "terms": {"all": [0, 1, 2, 4, 7], "notabl": 0, "thi": [0, 1, 2, 3, 4, 6, 8], "project": [0, 1, 2, 3, 7], "document": [0, 4, 7], "file": [0, 4, 6], "The": [0, 1, 4, 6, 7, 8], "format": [0, 8], "i": [0, 1, 4, 6, 8], "base": [0, 8], "keep": [0, 7], "changelog": [0, 3, 6], "adher": 0, "semant": 0, "version": [0, 1, 5, 7, 8], "discuss": [0, 2, 6], "about": [0, 1, 8], "releas": [0, 7, 8], "how": [0, 3, 7], "upgrad": [0, 3], "latest": [0, 8], "debug": [0, 8], "paramet": [0, 6, 8], "unicornfi": [0, 5, 8], "cython": 0, "pypi": 0, "wheel": 0, "support": [0, 3, 8], "codebas": 0, "equal": 0, "test": 0, "azur": 0, "pipe": 0, "just": [0, 6], "prepar": [0, 7], "conda": 0, "forg": [0, 6], "packag": [0, 3, 5], "is_update_availab": 0, "typo": 0, "is_update_avail": [0, 5, 6, 8], "move": 0, "from": [0, 1, 4, 8], "http": [0, 1, 4, 6, 7], "github": 0, "com": [0, 6, 8], "oliv": 0, "zehentleitn": 0, "lucit": [0, 1, 4, 6, 7], "system": [0, 4, 6, 7], "correctli": 0, "scope": [0, 3], "logger": [0, 3], "so": [0, 4, 8], "plai": 0, "nice": 0, "other": [0, 1, 4, 6], "name": [0, 8], "unicorn_fi": [0, 3, 6], "binance_futures_websocket": [0, 5, 8], "did": 0, "convert": [0, 6], "bid": 0, "depth": 0, "stream": [0, 6, 8], "issu": [0, 1, 2, 6], "232": 0, "implement": 0, "miss": [0, 8], "account_upd": 0, "binanc": [0, 6, 8], "futur": [0, 6, 8], "event": [0, 1, 4], "thx": 0, "folktale42": 0, "pr": 0, "28": 0, "perpetu": 0, "coin": [0, 6], "binance_com_coin_futures_websocket": [0, 5, 6, 8], "NOT": [0, 4], "readi": 0, "order_trade_upd": 0, "account_config_upd": 0, "margin_cal": 0, "starball": 0, "23": 0, "25": 0, "unittest": 0, "balanceupd": 0, "binance_websocket": [0, 5, 8], "19": 0, "davivc": 0, "trbinanc": [0, 8], "liststatu": 0, "margin": [0, 6, 8], "isolated_margin": [0, 8], "jex": [0, 6, 8], "outboundaccountposit": 0, "thank": [0, 7], "bmschwartz": 0, "handl": [0, 7], "result": [0, 1], "modulenotfounderror": 0, "No": 0, "modul": [0, 3, 5, 6, 7], "uggel": 0, "account_permiss": 0, "outboundaccountinfo": 0, "kind": [0, 4, 6], "ticker": 0, "msg": 0, "error": [0, 6], "except": 0, "show": [0, 1, 8], "python": 0, "trace": [0, 6], "minitick": 0, "arr": 0, "structur": 0, "typeerror": 0, "ujson": 0, "instead": 0, "stock": 0, "json": [0, 8], "copi": [0, 4], "suggest": [0, 3, 7], "modif": 0, "doc": [0, 6], "page": [0, 3], "binance_us_websocket": [0, 5, 6, 8], "exchang": [0, 3, 8], "return": [0, 8], "dict": [0, 8], "binance_com_websocket": [0, 5, 6, 8], "binance_je_websocket": [0, 5, 6, 8], "get_latest_vers": [0, 5, 8], "get_vers": [0, 5, 8], "get_latest_release_info": [0, 5, 8], "creat": [0, 1, 8], "In": [1, 6], "interest": 1, "foster": 1, "an": [1, 4, 6], "open": [1, 6], "welcom": [1, 6], "environ": 1, "we": [1, 2, 6, 7, 8], "maintain": [1, 7], "make": [1, 2, 6, 7], "particip": 1, "commun": [1, 6], "harass": 1, "free": [1, 4], "experi": 1, "everyon": 1, "regardless": 1, "ag": 1, "bodi": 1, "size": 1, "disabl": 1, "ethnic": 1, "sex": 1, "characterist": 1, "gender": 1, "ident": 1, "express": [1, 4], "level": [1, 6], "educ": 1, "socio": 1, "econom": 1, "statu": [1, 6], "nation": 1, "person": [1, 4, 7], "appear": 1, "race": 1, "religion": 1, "sexual": 1, "orient": 1, "exampl": [1, 3], "behavior": 1, "contribut": [1, 3, 7], "posit": 1, "includ": [1, 4, 6], "us": [0, 1, 4], "inclus": 1, "languag": [1, 6], "Being": 1, "respect": [1, 6], "differ": 1, "viewpoint": 1, "gracefulli": 1, "accept": 1, "construct": 1, "critic": 1, "focus": 1, "what": 1, "best": 1, "empathi": 1, "toward": [1, 7], "member": 1, "unaccept": 1, "imageri": 1, "unwelcom": 1, "attent": 1, "advanc": 1, "troll": 1, "insult": 1, "derogatori": 1, "comment": [1, 3], "polit": 1, "attack": 1, "public": 1, "privat": 1, "publish": [1, 4, 6], "inform": [0, 1, 6, 7], "physic": 1, "electron": 1, "address": 1, "without": [1, 4], "explicit": 1, "permiss": [1, 4], "which": [0, 1, 6], "could": [1, 7], "reason": 1, "consid": [1, 6], "inappropri": 1, "profession": 1, "set": [1, 6], "ar": [0, 1, 8], "clarifi": 1, "expect": 1, "take": [0, 1, 6, 7], "appropri": 1, "fair": 1, "correct": 1, "action": [1, 4], "ani": [1, 4, 6, 7], "instanc": 1, "have": [0, 1, 2, 7], "right": [1, 3, 4], "remov": 1, "edit": 1, "reject": 1, "commit": 1, "wiki": [1, 3], "align": 1, "ban": 1, "temporarili": 1, "perman": 1, "thei": [1, 6, 7, 8], "deem": 1, "threaten": 1, "offens": 1, "harm": 1, "appli": 1, "both": [1, 6], "within": [1, 7], "space": 1, "when": [1, 2, 6, 7], "individu": 1, "repres": 1, "its": [1, 6], "offici": 1, "e": [1, 6], "mail": 1, "post": 1, "via": [0, 1, 2, 7], "social": [1, 3], "media": 1, "account": [0, 1], "act": 1, "appoint": 1, "onlin": 1, "offlin": 1, "represent": 1, "mai": [1, 6, 7], "further": 1, "defin": 1, "abus": 1, "otherwis": [1, 4], "report": [1, 3], "contact": [1, 6, 7], "team": [1, 7], "www": [1, 4, 6, 7], "tech": [1, 4, 6, 7], "unicorn": [1, 6, 7], "develop": [1, 3, 4, 6, 7], "html": [1, 6, 7], "complaint": 1, "review": 1, "investig": 1, "necessari": [1, 6], "circumst": [1, 6], "oblig": 1, "confidenti": 1, "regard": 1, "incid": 1, "detail": [1, 7], "specif": [1, 6], "polici": [1, 3], "separ": 1, "who": 1, "do": [0, 1, 4, 6], "follow": [1, 2, 4, 6, 7], "good": 1, "faith": 1, "face": 1, "temporari": 1, "repercuss": 1, "determin": [1, 6, 7], "": [1, 6], "leadership": 1, "adapt": 1, "1": [1, 3, 8], "4": [1, 3], "avail": [0, 1, 6, 8], "org": [0, 1, 6, 8], "For": [1, 6], "answer": 1, "common": 1, "question": 1, "see": 1, "faq": 1, "repositori": [2, 6], "pleas": [0, 2, 6, 7], "first": 2, "chang": [2, 3], "you": [0, 2, 7], "wish": 2, "owner": 2, "befor": [2, 6], "note": [0, 2], "code": [0, 2, 3, 7], "conduct": [2, 3], "your": [2, 7], "interact": 2, "fork": 2, "fulfil": 2, "confirm": [2, 7], "requir": [0, 2, 6], "trigger": 2, "readm": 3, "get": [3, 8], "instal": [0, 3], "log": 3, "homepag": 3, "receiv": [3, 7, 8], "notif": 3, "bug": 3, "improv": [3, 7], "want": [], "sai": [], "disclaim": 3, "commerci": 3, "0": [3, 6, 8], "13": 3, "dev": 3, "stage": 3, "unreleas": 3, "unstabl": 3, "12": 3, "2": [3, 6, 8], "11": 3, "10": 3, "9": [3, 6], "8": [3, 6], "7": [3, 6], "6": 3, "5": 3, "3": [3, 6], "our": [3, 6, 7], "pledg": 3, "standard": 3, "respons": [3, 6, 7], "enforc": 3, "attribut": 3, "pull": [0, 3, 7], "request": [3, 7], "process": [0, 3, 6, 7], "licens": 3, "secur": [3, 6], "disclosur": 3, "index": 3, "search": 3, "copyright": 4, "c": [0, 4, 6], "2019": 4, "2023": 4, "me": 6, "herebi": 4, "grant": 4, "charg": 4, "obtain": [0, 4], "softwar": 4, "associ": 4, "deal": 4, "restrict": 4, "limit": [4, 6], "modifi": 4, "merg": 4, "distribut": [0, 4], "sublicens": 4, "sell": [4, 6], "permit": 4, "whom": 4, "furnish": 4, "subject": 4, "condit": 4, "abov": [4, 6], "notic": 4, "shall": 4, "substanti": 4, "portion": 4, "THE": 4, "provid": [4, 6], "AS": 4, "warranti": 4, "OF": 4, "OR": 4, "impli": 4, "BUT": 4, "TO": 4, "merchant": 4, "fit": 4, "FOR": 4, "A": 4, "particular": 4, "purpos": [4, 6], "AND": 4, "noninfring": 4, "IN": 4, "NO": 4, "author": 4, "holder": 4, "BE": 4, "liabl": [4, 6], "claim": [4, 6], "damag": [4, 6], "liabil": [4, 6], "whether": [0, 4], "contract": 4, "tort": 4, "aris": 4, "out": 4, "connect": 4, "WITH": 4, "submodul": 5, "binance_coin_futures_websocket": [], "binance_com_futures_websocket": [5, 6, 8], "binance_com_isolated_margin_websocket": [5, 6, 8], "binance_com_margin_websocket": [5, 6, 8], "binance_org_websocket": [5, 6, 8], "is_json": [5, 8], "jex_com_websocket": [5, 6, 8], "set_to_false_if_not_exist": [5, 8], "trbinance_com_websocket": [5, 6, 8], "content": 5, "leav": [], "raw": [6, 8], "data": [6, 8], "crypto": [6, 8], "api": 6, "endpoint": [6, 8], "well": 6, "form": [6, 7], "dictionari": 6, "part": 6, "suit": 6, "import": 6, "received_stream_data_json": 6, "btcusdt": 6, "trade": 6, "1556876873656": 6, "t": [0, 6], "117727701": 6, "p": 6, "5786": 6, "76000000": 6, "q": 6, "03200500": 6, "b": 6, "341831847": 6, "341831876": 6, "1556876873648": 6, "m": 6, "true": [6, 8], "unicorn_fied_stream_data": 6, "print": 6, "output": 6, "stream_typ": 6, "event_typ": 6, "event_tim": 6, "symbol": 6, "trade_id": 6, "price": 6, "quantiti": 6, "buyer_order_id": 6, "seller_order_id": 6, "trade_tim": 6, "is_market_mak": 6, "ignor": 6, "lib": 6, "integr": 6, "can": [0, 6], "activ": 6, "output_default": 6, "binancewebsocketapimanag": 6, "create_stream": 6, "getlogg": 6, "stream_data_json": [6, 8], "stabl": 6, "testnet": [6, 8], "isol": 6, "needs_your_help": 6, "jersei": [6, 8], "u": [6, 8], "tr": [6, 8], "dex": 6, "none": 6, "like": 6, "interpret": 6, "offer": 6, "onli": 6, "higher": 6, "current": 6, "depend": 6, "list": 6, "here": 6, "run": 6, "dure": [0, 6], "look": 6, "fy": [6, 7], "updat": 0, "bash": 6, "archiv": 6, "curl": 6, "repo": 6, "grep": 6, "op": 6, "tag_nam": 6, "k": 6, "tar": 6, "gz": 6, "below": 6, "command": 6, "tarbal": 6, "master": 6, "download": 6, "branch": 6, "yml": 6, "pyproject": 6, "toml": 6, "txt": 6, "setup": 6, "py": 6, "gener": [6, 7], "example_log": [], "example_unicorn_fi": [], "example_version_of_this_packag": [], "unicorndev": 6, "vision": 6, "To": 6, "write": 6, "script": 6, "monitor": 6, "servic": 6, "twitter": [], "facebook": 6, "new": [6, 8], "plan": 6, "featur": 6, "click": 6, "need": 6, "one": 6, "them": [0, 6], "try": 6, "still": [6, 7], "exist": [6, 8], "o": 6, "explain": 6, "reproduc": 6, "demo": 6, "appreci": [6, 7], "dont": 6, "find": [6, 7], "relat": 6, "topic": 6, "anyth": [0, 6], "simpl": 6, "fix": [6, 7], "dead": 6, "link": 6, "guid": 6, "hope": [], "enjoi": [], "librari": [], "prove": [], "moment": [], "would": [6, 8], "greatli": [], "googl": [], "should": 6, "constru": 6, "materi": 6, "legal": 6, "tax": 6, "invest": 6, "financi": 6, "advic": 6, "noth": 6, "contain": 6, "herein": 6, "constitut": 6, "solicit": 6, "recommend": 6, "endors": 6, "third": [6, 7], "parti": [6, 7], "bui": 6, "instrument": 6, "jurisdict": 6, "unlaw": 6, "under": [6, 7], "law": 6, "loss": 6, "expens": 6, "cost": 6, "direct": 6, "indirect": 6, "profit": 6, "oper": 6, "consult": 6, "non": [6, 8], "bind": 6, "initi": [6, 7], "outlin": 7, "serious": 7, "effort": 7, "everi": 7, "acknowledg": 7, "lead": 7, "email": 7, "48": 7, "hour": [7, 8], "send": 7, "more": [6, 7], "indic": 7, "next": 7, "step": 7, "after": 7, "repli": 7, "endeavor": 7, "progress": 7, "full": 7, "announc": 7, "ask": 7, "addit": 7, "guidanc": 7, "assign": 7, "primari": 7, "handler": 7, "coordin": 7, "involv": 7, "problem": 7, "affect": 7, "audit": 7, "potenti": 7, "similar": 7, "mainten": 7, "These": 7, "fast": 7, "possibl": [6, 7], "pip": [0, 7], "If": 7, "submit": 7, "class": 8, "fals": 8, "sourc": [0, 8], "object": 8, "unifi": 8, "coin_futur": 8, "je": 8, "static": [6, 8], "show_deprecated_warn": 8, "raw_stream_data": 8, "websocket": 8, "str": 8, "bool": 8, "hide": 8, "warn": 8, "incl": 8, "info": 8, "cach": 8, "time": [0, 6, 8], "string": 8, "verifi": 8, "type": [0, 6, 8], "valu": 8, "kei": 8, "some": [0, 6, 8], "var": 8, "empti": 8, "default": 8, "final": 8, "build": [0, 6], "anaconda": 0, "signific": 6, "advantag": 6, "perform": 6, "boost": 6, "program": 6, "supplement": 6, "By": 6, "compil": [0, 6], "significantli": 6, "enhanc": 6, "execut": 6, "speed": 6, "especi": 6, "computation": 6, "intens": 6, "task": 6, "mean": 6, "faster": 6, "runtim": 6, "effici": 6, "user": 6, "altern": 6, "known": 6, "It": 6, "jit": 6, "dramat": 6, "tailor": 6, "compat": 6, "allow": 6, "leverag": 6, "seamlessli": 6, "simpler": 6, "straightforward": 6, "ensur": 6, "optim": 6, "minim": 6, "focu": 6, "rather": 6, "than": 6, "configur": 6, "through": 6, "channel": 6, "config": 6, "add": 6, "meta": 6, "yaml": 6, "medium": 6, "youtub": 6, "linkedin": 6, "x": 6, "multi_assets_mod": 0, "38": 0, "market": 0, "proper": 0, "39": 0, "am": 4, "berg": 4, "391": 4, "3970": 4, "weitra": 4, "also": [0, 6], "64": 6, "osx": 6, "win": 6, "architectur": [0, 6], "help": 6, "assist": 6, "gpt": 6, "human": 6, "employe": 6, "ufi": 6, "arm64": 0, "raspberri": [0, 6], "pi": [0, 6], "14": [3, 6, 8], "now": 0, "precompil": 0, "automat": 0, "recognis": 0, "suitabl": 0, "target": [0, 6], "even": 0, "don": 0, "special": 0, "On": 6, "pre": 6, "local": 6, "patient": 6, "sinc": 0, "deliv": 0, "extens": 0, "id": 0, "pycharm": 0, "visual": 0, "cannot": 0, "method": [0, 6], "autocomplet": 0, "intellisens": 0, "function": 0, "As": 0, "solut": 0, "stub": [0, 6], "pyi": 0, "attach": 0, "sdk": 6, "start": 6, "two": 6, "githubact": 6, "gh": 6, "virtual": 6, "mac": 6, "server": 6, "cloud": 6, "preconfigur": 6, "pack": 6, "transpar": 6, "behind": 6}, "objects": {"": [[8, 0, 0, "-", "unicorn_fy"]], "unicorn_fy": [[8, 0, 0, "-", "unicorn_fy"]], "unicorn_fy.unicorn_fy": [[8, 1, 1, "", "UnicornFy"]], "unicorn_fy.unicorn_fy.UnicornFy": [[8, 2, 1, "", "VERSION"], [8, 3, 1, "", "binance_com_coin_futures_websocket"], [8, 3, 1, "", "binance_com_futures_websocket"], [8, 3, 1, "", "binance_com_isolated_margin_websocket"], [8, 3, 1, "", "binance_com_margin_websocket"], [8, 3, 1, "", "binance_com_websocket"], [8, 3, 1, "", "binance_futures_websocket"], [8, 3, 1, "", "binance_je_websocket"], [8, 3, 1, "", "binance_org_websocket"], [8, 3, 1, "", "binance_us_websocket"], [8, 3, 1, "", "binance_websocket"], [8, 3, 1, "", "get_latest_release_info"], [8, 3, 1, "", "get_latest_version"], [8, 3, 1, "", "get_version"], [8, 3, 1, "", "is_json"], [8, 3, 1, "", "is_update_available"], [8, 3, 1, "", "jex_com_websocket"], [8, 3, 1, "", "set_to_false_if_not_exist"], [8, 3, 1, "", "trbinance_com_websocket"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"]}, "titleterms": {"unicorn": 0, "fy": 0, "chang": [0, 6], "log": [0, 6], "0": 0, "13": 0, "dev": [0, 6], "develop": 0, "stage": [0, 6], "unreleas": 0, "unstabl": 0, "ad": 0, "12": 0, "2": 0, "1": 0, "fix": 0, "11": 0, "10": 0, "9": 0, "8": 0, "7": 0, "6": 0, "5": 0, "4": 0, "remov": 0, "3": 0, "depric": 0, "contributor": [1, 6], "coven": 1, "code": [1, 6], "conduct": 1, "our": 1, "pledg": 1, "standard": 1, "respons": 1, "scope": 1, "enforc": 1, "attribut": 1, "contribut": [2, 6], "pull": 2, "request": 2, "process": 2, "welcom": 3, "unicornfi": [3, 6], "": 3, "document": [3, 6], "content": [3, 8], "indic": 3, "tabl": 3, "mit": 4, "licens": 4, "unicorn_fi": [5, 8], "get": 6, "right": 6, "logger": 6, "support": 6, "exchang": 6, "websocket": 6, "rest": 6, "instal": 6, "upgrad": 6, "A": 6, "cython": 6, "binari": 6, "pypi": 6, "sourc": 6, "base": 6, "cpython": 6, "wheel": 6, "latest": 6, "version": 6, "pip": 6, "from": 6, "conda": 6, "packag": [6, 8], "releas": 6, "anaconda": 6, "via": [], "forg": [], "github": 6, "linux": 6, "maco": 6, "window": 6, "environ": 6, "virtualenv": 6, "plain": 6, "python": 6, "exampl": 6, "project": 6, "homepag": 6, "wiki": 6, "social": 6, "receiv": 6, "notif": 6, "how": 6, "report": [6, 7], "bug": [6, 7], "suggest": 6, "improv": 6, "you": 6, "want": [], "sai": [], "thank": [], "disclaim": 6, "If": 6, "intend": 6, "us": 6, "real": 6, "monei": 6, "your": 6, "own": 6, "risk": 6, "commerci": 6, "secur": 7, "polici": 7, "procedur": 7, "disclosur": 7, "comment": 7, "thi": 7, "submodul": 8, "modul": 8, "updat": 6, "14": 0, "ar": 6, "creat": 6, "automat": 6, "action": 6}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"Welcome to UnicornFy\u2019s documentation!": [[3, "welcome-to-unicornfy-s-documentation"]], "Contents:": [[3, null]], "Indices and tables": [[3, "indices-and-tables"]], "unicorn_fy": [[5, "unicorn-fy"]], "unicorn-fy Change Log": [[0, "unicorn-fy-change-log"]], "0.14.2.dev (development stage/unreleased/unstable)": [[0, "dev-development-stage-unreleased-unstable"]], "0.14.2": [[0, "id1"]], "Added": [[0, "added"], [0, "id4"], [0, "id7"], [0, "id15"], [0, "id17"], [0, "id19"], [0, "id21"], [0, "id23"], [0, "id25"], [0, "id28"], [0, "id36"], [0, "id39"]], "0.14.1": [[0, "id2"]], "0.14.0": [[0, "id3"]], "0.13.1": [[0, "id5"]], "0.13.0": [[0, "id6"]], "0.12.2": [[0, "id8"]], "0.12.1": [[0, "id9"]], "0.12.0": [[0, "id10"]], "Fixed": [[0, "fixed"], [0, "id12"], [0, "id26"], [0, "id30"], [0, "id32"], [0, "id34"], [0, "id47"]], "0.11.1": [[0, "id11"]], "Changed": [[0, "changed"], [0, "id38"]], "0.11.0": [[0, "id13"]], "Adding": [[0, "adding"], [0, "id42"], [0, "id45"]], "0.10.0": [[0, "id14"]], "0.9.0": [[0, "id16"]], "0.8.0": [[0, "id18"]], "0.7.0": [[0, "id20"]], "0.6.0": [[0, "id22"]], "0.5.0": [[0, "id24"]], "0.4.1": [[0, "id27"]], "0.4.0": [[0, "id29"]], "Removed": [[0, "removed"]], "0.3.5": [[0, "id31"]], "0.3.4": [[0, "id33"]], "0.3.3": [[0, "id35"]], "0.3.2": [[0, "id37"]], "0.3.1": [[0, "id40"]], "Changes": [[0, "changes"], [0, "id43"]], "0.3.0": [[0, "id41"]], "0.2.0": [[0, "id44"]], "Depricated": [[0, "depricated"]], "0.1.1": [[0, "id46"]], "0.1.0": [[0, "id48"]], "Contributor Covenant Code of Conduct": [[1, "contributor-covenant-code-of-conduct"]], "Our Pledge": [[1, "our-pledge"]], "Our Standards": [[1, "our-standards"]], "Our Responsibilities": [[1, "our-responsibilities"]], "Scope": [[1, "scope"]], "Enforcement": [[1, "enforcement"]], "Attribution": [[1, "attribution"]], "Contributing": [[2, "contributing"], [6, "contributing"]], "Pull Request Process": [[2, "pull-request-process"]], "MIT License": [[4, "mit-license"]], "UnicornFy": [[6, "unicornfy"]], "Get the right logger:": [[6, "get-the-right-logger"]], "Supported Exchanges": [[6, "supported-exchanges"]], "Websockets": [[6, "websockets"]], "REST": [[6, "rest"]], "Installation and Upgrade": [[6, "installation-and-upgrade"]], "Packages are created automatically with GitHub Actions": [[6, "packages-are-created-automatically-with-github-actions"]], "A Cython binary, PyPy or source code based CPython wheel of the latest version with pip from PyPI": [[6, "a-cython-binary-pypy-or-source-code-based-cpython-wheel-of-the-latest-version-with-pip-from-pypi"]], "Installation": [[6, "installation"], [6, "id1"]], "Update": [[6, "update"], [6, "id2"]], "A Conda Package of the latest version with conda from Anaconda": [[6, "a-conda-package-of-the-latest-version-with-conda-from-anaconda"]], "From source of the latest release with PIP from Github": [[6, "from-source-of-the-latest-release-with-pip-from-github"]], "Linux, macOS, \u2026": [[6, "linux-macos"]], "Windows": [[6, "windows"]], "From the latest source (dev-stage) with PIP from GitHub": [[6, "from-the-latest-source-dev-stage-with-pip-from-github"]], "Conda environment, Virtualenv or plain Python": [[6, "conda-environment-virtualenv-or-plain-python"]], "Change Log": [[6, "change-log"]], "Documentation": [[6, "documentation"]], "Examples": [[6, "examples"]], "Project Homepage": [[6, "project-homepage"]], "Wiki": [[6, "wiki"]], "Social": [[6, "social"]], "Receive Notifications": [[6, "receive-notifications"]], "How to report Bugs or suggest Improvements?": [[6, "how-to-report-bugs-or-suggest-improvements"]], "Contributors": [[6, "contributors"]], "Disclaimer": [[6, "disclaimer"]], "If you intend to use real money, use it at your own risk!": [[6, "if-you-intend-to-use-real-money-use-it-at-your-own-risk"]], "Commercial Support": [[6, "commercial-support"]], "Security Policies and Procedures": [[7, "security-policies-and-procedures"]], "Reporting a Bug": [[7, "reporting-a-bug"]], "Disclosure Policy": [[7, "disclosure-policy"]], "Comments on this Policy": [[7, "comments-on-this-policy"]], "unicorn_fy package": [[8, "unicorn-fy-package"]], "Submodules": [[8, "submodules"]], "unicorn_fy.unicorn_fy module": [[8, "module-unicorn_fy.unicorn_fy"]], "Module contents": [[8, "module-unicorn_fy"]]}, "indexentries": {"unicornfy (class in unicorn_fy.unicorn_fy)": [[8, "unicorn_fy.unicorn_fy.UnicornFy"]], "version (unicorn_fy.unicorn_fy.unicornfy attribute)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.VERSION"]], "binance_com_coin_futures_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_com_coin_futures_websocket"]], "binance_com_futures_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_com_futures_websocket"]], "binance_com_isolated_margin_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_com_isolated_margin_websocket"]], "binance_com_margin_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_com_margin_websocket"]], "binance_com_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_com_websocket"]], "binance_futures_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_futures_websocket"]], "binance_je_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_je_websocket"]], "binance_org_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_org_websocket"]], "binance_us_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_us_websocket"]], "binance_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_websocket"]], "get_latest_release_info() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.get_latest_release_info"]], "get_latest_version() (unicorn_fy.unicorn_fy.unicornfy method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.get_latest_version"]], "get_version() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.get_version"]], "is_json() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.is_json"]], "is_update_available() (unicorn_fy.unicorn_fy.unicornfy method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.is_update_available"]], "jex_com_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.jex_com_websocket"]], "module": [[8, "module-unicorn_fy"], [8, "module-unicorn_fy.unicorn_fy"]], "set_to_false_if_not_exist() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.set_to_false_if_not_exist"]], "trbinance_com_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.trbinance_com_websocket"]], "unicorn_fy": [[8, "module-unicorn_fy"]], "unicorn_fy.unicorn_fy": [[8, "module-unicorn_fy.unicorn_fy"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "code_of_conduct", "contributing", "index", "license", "modules", "readme", "security", "unicorn_fy"], "filenames": ["changelog.md", "code_of_conduct.md", "contributing.md", "index.rst", "license.rst", "modules.rst", "readme.md", "security.md", "unicorn_fy.rst"], "titles": ["unicorn-fy Change Log", "Contributor Covenant Code of Conduct", "Contributing", "Welcome to UnicornFy\u2019s documentation!", "MIT License", "unicorn_fy", "UnicornFy", "Security Policies and Procedures", "unicorn_fy package"], "terms": {"all": [0, 1, 2, 4, 7], "notabl": 0, "thi": [0, 1, 2, 3, 4, 6, 8], "project": [0, 1, 2, 3, 7], "document": [0, 4, 7], "file": [0, 4, 6], "The": [0, 1, 4, 6, 7, 8], "format": [0, 8], "i": [0, 1, 4, 6, 8], "base": [0, 8], "keep": [0, 7], "changelog": [0, 3, 6], "adher": 0, "semant": 0, "version": [0, 1, 7, 8], "discuss": [0, 2, 6], "about": [0, 1, 8], "releas": [0, 7, 8], "how": [0, 3, 7], "upgrad": [0, 3], "latest": [0, 8], "debug": [0, 8], "paramet": [0, 6, 8], "unicornfi": [0, 5, 8], "cython": 0, "pypi": 0, "wheel": 0, "support": [0, 3, 8], "codebas": 0, "equal": 0, "test": 0, "azur": 0, "pipe": 0, "just": [0, 6], "prepar": [0, 7], "conda": 0, "forg": [0, 6], "packag": [0, 3, 5], "is_update_availab": 0, "typo": 0, "is_update_avail": [0, 5, 6, 8], "move": 0, "from": [0, 1, 4, 8], "http": [0, 1, 4, 6, 7], "github": 0, "com": [0, 6, 8], "oliv": 0, "zehentleitn": 0, "lucit": [0, 1, 4, 6, 7], "system": [0, 4, 6, 7], "correctli": 0, "scope": [0, 3], "logger": [0, 3], "so": [0, 4, 8], "plai": 0, "nice": 0, "other": [0, 1, 4, 6], "name": [0, 8], "unicorn_fi": [0, 3, 6], "binance_futures_websocket": [0, 5, 8], "did": 0, "convert": [0, 6], "bid": 0, "depth": 0, "stream": [0, 6, 8], "issu": [0, 1, 2, 6], "232": 0, "implement": 0, "miss": [0, 8], "account_upd": 0, "binanc": [0, 6, 8], "futur": [0, 6, 8], "event": [0, 1, 4], "thx": 0, "folktale42": 0, "pr": 0, "28": 0, "perpetu": 0, "coin": [0, 6], "binance_com_coin_futures_websocket": [0, 5, 6, 8], "NOT": [0, 4], "readi": 0, "order_trade_upd": 0, "account_config_upd": 0, "margin_cal": 0, "starball": 0, "23": 0, "25": 0, "unittest": 0, "balanceupd": 0, "binance_websocket": [0, 5, 8], "19": 0, "davivc": 0, "trbinanc": [0, 8], "liststatu": 0, "margin": [0, 6, 8], "isolated_margin": [0, 8], "jex": 0, "outboundaccountposit": 0, "thank": [0, 7], "bmschwartz": 0, "handl": [0, 7], "result": [0, 1], "modulenotfounderror": 0, "No": 0, "modul": [0, 3, 5, 6, 7], "uggel": 0, "account_permiss": 0, "outboundaccountinfo": 0, "kind": [0, 4, 6], "ticker": 0, "msg": 0, "error": [0, 6], "except": 0, "show": [0, 1, 8], "python": 0, "trace": [0, 6], "minitick": 0, "arr": 0, "structur": 0, "typeerror": 0, "ujson": 0, "instead": 0, "stock": 0, "json": [0, 8], "copi": [0, 4], "suggest": [0, 3, 7], "modif": 0, "doc": [0, 6], "page": [0, 3], "binance_us_websocket": [0, 5, 6, 8], "exchang": [0, 3, 8], "return": [0, 8], "dict": [0, 8], "binance_com_websocket": [0, 5, 6, 8], "binance_je_websocket": 0, "get_latest_vers": [0, 5, 8], "get_vers": [0, 5, 8], "get_latest_release_info": [0, 5, 8], "creat": [0, 1, 8], "In": [1, 6], "interest": 1, "foster": 1, "an": [1, 4, 6], "open": [1, 6], "welcom": [1, 6], "environ": 1, "we": [1, 2, 6, 7, 8], "maintain": [1, 7], "make": [1, 2, 6, 7], "particip": 1, "commun": [1, 6], "harass": 1, "free": [1, 4], "experi": 1, "everyon": 1, "regardless": 1, "ag": 1, "bodi": 1, "size": 1, "disabl": 1, "ethnic": 1, "sex": 1, "characterist": 1, "gender": 1, "ident": 1, "express": [1, 4], "level": [1, 6], "educ": 1, "socio": 1, "econom": 1, "statu": [1, 6], "nation": 1, "person": [1, 4, 7], "appear": 1, "race": 1, "religion": 1, "sexual": 1, "orient": 1, "exampl": [1, 3], "behavior": 1, "contribut": [1, 3, 7], "posit": 1, "includ": [1, 4, 6], "us": [0, 1, 4], "inclus": 1, "languag": [1, 6], "Being": 1, "respect": [1, 6], "differ": 1, "viewpoint": 1, "gracefulli": 1, "accept": 1, "construct": 1, "critic": 1, "focus": 1, "what": 1, "best": 1, "empathi": 1, "toward": [1, 7], "member": 1, "unaccept": 1, "imageri": 1, "unwelcom": 1, "attent": 1, "advanc": 1, "troll": 1, "insult": 1, "derogatori": 1, "comment": [1, 3], "polit": 1, "attack": 1, "public": 1, "privat": 1, "publish": [1, 4, 6], "inform": [0, 1, 6, 7], "physic": 1, "electron": 1, "address": 1, "without": [1, 4], "explicit": 1, "permiss": [1, 4], "which": [0, 1, 6], "could": [1, 7], "reason": 1, "consid": [1, 6], "inappropri": 1, "profession": 1, "set": [1, 6], "ar": [0, 1, 8], "clarifi": 1, "expect": 1, "take": [0, 1, 6, 7], "appropri": 1, "fair": 1, "correct": 1, "action": [1, 4], "ani": [1, 4, 6, 7], "instanc": 1, "have": [0, 1, 2, 7], "right": [1, 3, 4], "remov": 1, "edit": 1, "reject": 1, "commit": 1, "wiki": [1, 3], "align": 1, "ban": 1, "temporarili": 1, "perman": 1, "thei": [1, 6, 7, 8], "deem": 1, "threaten": 1, "offens": 1, "harm": 1, "appli": 1, "both": [1, 6], "within": [1, 7], "space": 1, "when": [1, 2, 6, 7], "individu": 1, "repres": 1, "its": [1, 6], "offici": 1, "e": [1, 6], "mail": 1, "post": 1, "via": [0, 1, 2, 7], "social": [1, 3], "media": 1, "account": [0, 1], "act": 1, "appoint": 1, "onlin": 1, "offlin": 1, "represent": 1, "mai": [1, 6, 7], "further": 1, "defin": 1, "abus": 1, "otherwis": [1, 4], "report": [1, 3], "contact": [1, 6, 7], "team": [1, 7], "www": [1, 4, 6, 7], "tech": [1, 4, 6, 7], "unicorn": [1, 6, 7], "develop": [1, 3, 4, 6, 7], "html": [1, 6, 7], "complaint": 1, "review": 1, "investig": 1, "necessari": [1, 6], "circumst": [1, 6], "oblig": 1, "confidenti": 1, "regard": 1, "incid": 1, "detail": [1, 7], "specif": [1, 6], "polici": [1, 3], "separ": 1, "who": 1, "do": [0, 1, 4, 6], "follow": [1, 2, 4, 6, 7], "good": 1, "faith": 1, "face": 1, "temporari": 1, "repercuss": 1, "determin": [1, 6, 7], "": [1, 6], "leadership": 1, "adapt": 1, "1": [1, 3, 8], "4": [1, 3], "avail": [0, 1, 6, 8], "org": [0, 1, 6, 8], "For": [1, 6], "answer": 1, "common": 1, "question": 1, "see": 1, "faq": 1, "repositori": [2, 6], "pleas": [0, 2, 6, 7], "first": 2, "chang": [2, 3], "you": [0, 2, 7], "wish": 2, "owner": 2, "befor": [2, 6], "note": [0, 2], "code": [0, 2, 3, 7], "conduct": [2, 3], "your": [2, 7], "interact": 2, "fork": 2, "fulfil": 2, "confirm": [2, 7], "requir": [0, 2, 6], "trigger": 2, "readm": 3, "get": [3, 8], "instal": [0, 3], "log": 3, "homepag": 3, "receiv": [3, 7, 8], "notif": 3, "bug": 3, "improv": [3, 7], "want": [], "sai": [], "disclaim": 3, "commerci": 3, "0": [3, 6], "13": 3, "dev": 3, "stage": 3, "unreleas": 3, "unstabl": 3, "12": 3, "2": [3, 6], "11": 3, "10": 3, "9": [3, 6], "8": [3, 6], "7": [3, 6], "6": 3, "5": 3, "3": [3, 6], "our": [3, 6, 7], "pledg": 3, "standard": 3, "respons": [3, 6, 7], "enforc": 3, "attribut": 3, "pull": [0, 3, 7], "request": [3, 7], "process": [0, 3, 6, 7], "licens": 3, "secur": [3, 6], "disclosur": 3, "index": 3, "search": 3, "copyright": 4, "c": [0, 4, 6], "2019": 4, "2023": 4, "me": 6, "herebi": 4, "grant": 4, "charg": 4, "obtain": [0, 4], "softwar": 4, "associ": 4, "deal": 4, "restrict": 4, "limit": [4, 6], "modifi": 4, "merg": 4, "distribut": [0, 4], "sublicens": 4, "sell": [4, 6], "permit": 4, "whom": 4, "furnish": 4, "subject": 4, "condit": 4, "abov": [4, 6], "notic": 4, "shall": 4, "substanti": 4, "portion": 4, "THE": 4, "provid": [4, 6], "AS": 4, "warranti": 4, "OF": 4, "OR": 4, "impli": 4, "BUT": 4, "TO": 4, "merchant": 4, "fit": 4, "FOR": 4, "A": 4, "particular": 4, "purpos": [4, 6], "AND": 4, "noninfring": 4, "IN": 4, "NO": 4, "author": 4, "holder": 4, "BE": 4, "liabl": [4, 6], "claim": [4, 6], "damag": [4, 6], "liabil": [4, 6], "whether": [0, 4], "contract": 4, "tort": 4, "aris": 4, "out": 4, "connect": 4, "WITH": 4, "submodul": 5, "binance_coin_futures_websocket": [], "binance_com_futures_websocket": [5, 6, 8], "binance_com_isolated_margin_websocket": [5, 6, 8], "binance_com_margin_websocket": [5, 6, 8], "binance_org_websocket": [5, 6, 8], "is_json": [5, 8], "jex_com_websocket": 0, "set_to_false_if_not_exist": [5, 8], "trbinance_com_websocket": [5, 6, 8], "content": 5, "leav": [], "raw": [6, 8], "data": [6, 8], "crypto": [6, 8], "api": 6, "endpoint": [6, 8], "well": 6, "form": [6, 7], "dictionari": 6, "part": 6, "suit": 6, "import": 6, "received_stream_data_json": 6, "btcusdt": 6, "trade": 6, "1556876873656": 6, "t": [0, 6], "117727701": 6, "p": 6, "5786": 6, "76000000": 6, "q": 6, "03200500": 6, "b": 6, "341831847": 6, "341831876": 6, "1556876873648": 6, "m": 6, "true": [6, 8], "unicorn_fied_stream_data": 6, "print": 6, "output": 6, "stream_typ": 6, "event_typ": 6, "event_tim": 6, "symbol": 6, "trade_id": 6, "price": 6, "quantiti": 6, "buyer_order_id": 6, "seller_order_id": 6, "trade_tim": 6, "is_market_mak": 6, "ignor": 6, "lib": 6, "integr": 6, "can": [0, 6], "activ": 6, "output_default": 6, "binancewebsocketapimanag": 6, "create_stream": 6, "getlogg": 6, "stream_data_json": [6, 8], "stabl": 6, "testnet": [6, 8], "isol": 6, "needs_your_help": 6, "jersei": [], "u": [6, 8], "tr": [6, 8], "dex": 6, "none": 6, "like": 6, "interpret": 6, "offer": 6, "onli": 6, "higher": 6, "current": 6, "depend": 6, "list": 6, "here": 6, "run": 6, "dure": [0, 6], "look": 6, "fy": [6, 7], "updat": 0, "bash": 6, "archiv": 6, "curl": 6, "repo": 6, "grep": 6, "op": 6, "tag_nam": 6, "k": 6, "tar": 6, "gz": 6, "below": 6, "command": 6, "tarbal": 6, "master": 6, "download": 6, "branch": 6, "yml": 6, "pyproject": 6, "toml": 6, "txt": 6, "setup": 6, "py": 6, "gener": [6, 7], "example_log": [], "example_unicorn_fi": [], "example_version_of_this_packag": [], "unicorndev": 6, "vision": 6, "To": 6, "write": 6, "script": 6, "monitor": 6, "servic": 6, "twitter": [], "facebook": 6, "new": [6, 8], "plan": 6, "featur": 6, "click": 6, "need": 6, "one": 6, "them": [0, 6], "try": 6, "still": [6, 7], "exist": [6, 8], "o": 6, "explain": 6, "reproduc": 6, "demo": 6, "appreci": [6, 7], "dont": 6, "find": [6, 7], "relat": 6, "topic": 6, "anyth": [0, 6], "simpl": 6, "fix": [6, 7], "dead": 6, "link": 6, "guid": 6, "hope": [], "enjoi": [], "librari": [], "prove": [], "moment": [], "would": [6, 8], "greatli": [], "googl": [], "should": 6, "constru": 6, "materi": 6, "legal": 6, "tax": 6, "invest": 6, "financi": 6, "advic": 6, "noth": 6, "contain": 6, "herein": 6, "constitut": 6, "solicit": 6, "recommend": 6, "endors": 6, "third": [6, 7], "parti": [6, 7], "bui": 6, "instrument": 6, "jurisdict": 6, "unlaw": 6, "under": [6, 7], "law": 6, "loss": 6, "expens": 6, "cost": 6, "direct": 6, "indirect": 6, "profit": 6, "oper": 6, "consult": 6, "non": [6, 8], "bind": 6, "initi": [6, 7], "outlin": 7, "serious": 7, "effort": 7, "everi": 7, "acknowledg": 7, "lead": 7, "email": 7, "48": 7, "hour": [7, 8], "send": 7, "more": [6, 7], "indic": 7, "next": 7, "step": 7, "after": 7, "repli": 7, "endeavor": 7, "progress": 7, "full": 7, "announc": 7, "ask": 7, "addit": 7, "guidanc": 7, "assign": 7, "primari": 7, "handler": 7, "coordin": 7, "involv": 7, "problem": 7, "affect": 7, "audit": 7, "potenti": 7, "similar": 7, "mainten": 7, "These": 7, "fast": 7, "possibl": [6, 7], "pip": [0, 7], "If": 7, "submit": 7, "class": 8, "fals": 8, "sourc": [0, 8], "object": 8, "unifi": 8, "coin_futur": 8, "je": [], "static": [6, 8], "show_deprecated_warn": 8, "raw_stream_data": 8, "websocket": 8, "str": 8, "bool": 8, "hide": 8, "warn": 8, "incl": 8, "info": 8, "cach": 8, "time": [0, 6, 8], "string": 8, "verifi": 8, "type": [0, 6, 8], "valu": 8, "kei": 8, "some": [0, 6, 8], "var": 8, "empti": 8, "default": 8, "final": 8, "build": [0, 6], "anaconda": 0, "signific": 6, "advantag": 6, "perform": 6, "boost": 6, "program": 6, "supplement": 6, "By": 6, "compil": [0, 6], "significantli": 6, "enhanc": 6, "execut": 6, "speed": 6, "especi": 6, "computation": 6, "intens": 6, "task": 6, "mean": 6, "faster": 6, "runtim": 6, "effici": 6, "user": 6, "altern": 6, "known": 6, "It": 6, "jit": 6, "dramat": 6, "tailor": 6, "compat": 6, "allow": 6, "leverag": 6, "seamlessli": 6, "simpler": 6, "straightforward": 6, "ensur": 6, "optim": 6, "minim": 6, "focu": 6, "rather": 6, "than": 6, "configur": 6, "through": 6, "channel": 6, "config": 6, "add": 6, "meta": 6, "yaml": 6, "medium": 6, "youtub": 6, "linkedin": 6, "x": 6, "multi_assets_mod": 0, "38": 0, "market": 0, "proper": 0, "39": 0, "am": 4, "berg": 4, "391": 4, "3970": 4, "weitra": 4, "also": [0, 6], "64": 6, "osx": 6, "win": 6, "architectur": [0, 6], "help": 6, "assist": [], "gpt": [], "human": [], "employe": [], "ufi": 6, "arm64": 0, "raspberri": [0, 6], "pi": [0, 6], "14": [3, 6], "now": 0, "precompil": 0, "automat": 0, "recognis": 0, "suitabl": 0, "target": [0, 6], "even": 0, "don": 0, "special": 0, "On": 6, "pre": 6, "local": 6, "patient": 6, "sinc": 0, "deliv": 0, "extens": 0, "id": 0, "pycharm": 0, "visual": 0, "cannot": 0, "method": [0, 6], "autocomplet": 0, "intellisens": 0, "function": 0, "As": 0, "solut": 0, "stub": [0, 6], "pyi": 0, "attach": 0, "sdk": 6, "start": 6, "two": 6, "githubact": 6, "gh": 6, "virtual": 6, "mac": 6, "server": 6, "cloud": 6, "preconfigur": 6, "pack": 6, "transpar": 6, "behind": 6, "__version__": 0, "made": 0}, "objects": {"": [[8, 0, 0, "-", "unicorn_fy"]], "unicorn_fy": [[8, 0, 0, "-", "unicorn_fy"]], "unicorn_fy.unicorn_fy": [[8, 1, 1, "", "UnicornFy"]], "unicorn_fy.unicorn_fy.UnicornFy": [[8, 2, 1, "", "binance_com_coin_futures_websocket"], [8, 2, 1, "", "binance_com_futures_websocket"], [8, 2, 1, "", "binance_com_isolated_margin_websocket"], [8, 2, 1, "", "binance_com_margin_websocket"], [8, 2, 1, "", "binance_com_websocket"], [8, 2, 1, "", "binance_futures_websocket"], [8, 2, 1, "", "binance_org_websocket"], [8, 2, 1, "", "binance_us_websocket"], [8, 2, 1, "", "binance_websocket"], [8, 2, 1, "", "get_latest_release_info"], [8, 2, 1, "", "get_latest_version"], [8, 2, 1, "", "get_version"], [8, 2, 1, "", "is_json"], [8, 2, 1, "", "is_update_available"], [8, 2, 1, "", "set_to_false_if_not_exist"], [8, 2, 1, "", "trbinance_com_websocket"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"]}, "titleterms": {"unicorn": 0, "fy": 0, "chang": [0, 6], "log": [0, 6], "0": 0, "13": 0, "dev": [0, 6], "develop": 0, "stage": [0, 6], "unreleas": 0, "unstabl": 0, "ad": 0, "12": 0, "2": 0, "1": 0, "fix": 0, "11": 0, "10": 0, "9": 0, "8": 0, "7": 0, "6": 0, "5": 0, "4": 0, "remov": 0, "3": 0, "depric": 0, "contributor": [1, 6], "coven": 1, "code": [1, 6], "conduct": 1, "our": 1, "pledg": 1, "standard": 1, "respons": 1, "scope": 1, "enforc": 1, "attribut": 1, "contribut": [2, 6], "pull": 2, "request": 2, "process": 2, "welcom": 3, "unicornfi": [3, 6], "": 3, "document": [3, 6], "content": [3, 8], "indic": 3, "tabl": 3, "mit": 4, "licens": 4, "unicorn_fi": [5, 8], "get": 6, "right": 6, "logger": 6, "support": 6, "exchang": 6, "websocket": 6, "rest": 6, "instal": 6, "upgrad": 6, "A": 6, "cython": 6, "binari": 6, "pypi": 6, "sourc": 6, "base": 6, "cpython": 6, "wheel": 6, "latest": 6, "version": 6, "pip": 6, "from": 6, "conda": 6, "packag": [6, 8], "releas": 6, "anaconda": 6, "via": [], "forg": [], "github": 6, "linux": 6, "maco": 6, "window": 6, "environ": 6, "virtualenv": 6, "plain": 6, "python": 6, "exampl": 6, "project": 6, "homepag": 6, "wiki": 6, "social": 6, "receiv": 6, "notif": 6, "how": 6, "report": [6, 7], "bug": [6, 7], "suggest": 6, "improv": 6, "you": 6, "want": [], "sai": [], "thank": [], "disclaim": 6, "If": 6, "intend": 6, "us": 6, "real": 6, "monei": 6, "your": 6, "own": 6, "risk": 6, "commerci": 6, "secur": 7, "polici": 7, "procedur": 7, "disclosur": 7, "comment": 7, "thi": 7, "submodul": 8, "modul": 8, "updat": 6, "14": 0, "ar": 6, "creat": 6, "automat": 6, "action": 6}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"Welcome to UnicornFy\u2019s documentation!": [[3, "welcome-to-unicornfy-s-documentation"]], "Contents:": [[3, null]], "Indices and tables": [[3, "indices-and-tables"]], "unicorn_fy": [[5, "unicorn-fy"]], "unicorn-fy Change Log": [[0, "unicorn-fy-change-log"]], "0.14.2.dev (development stage/unreleased/unstable)": [[0, "dev-development-stage-unreleased-unstable"]], "Added": [[0, "added"], [0, "id2"], [0, "id5"], [0, "id8"], [0, "id16"], [0, "id18"], [0, "id20"], [0, "id22"], [0, "id24"], [0, "id26"], [0, "id29"], [0, "id38"], [0, "id41"]], "Removed": [[0, "removed"], [0, "id32"]], "0.14.2": [[0, "id1"]], "0.14.1": [[0, "id3"]], "0.14.0": [[0, "id4"]], "0.13.1": [[0, "id6"]], "0.13.0": [[0, "id7"]], "0.12.2": [[0, "id9"]], "0.12.1": [[0, "id10"]], "0.12.0": [[0, "id11"]], "Fixed": [[0, "fixed"], [0, "id13"], [0, "id27"], [0, "id31"], [0, "id34"], [0, "id36"], [0, "id49"]], "0.11.1": [[0, "id12"]], "Changed": [[0, "changed"], [0, "id40"]], "0.11.0": [[0, "id14"]], "Adding": [[0, "adding"], [0, "id44"], [0, "id47"]], "0.10.0": [[0, "id15"]], "0.9.0": [[0, "id17"]], "0.8.0": [[0, "id19"]], "0.7.0": [[0, "id21"]], "0.6.0": [[0, "id23"]], "0.5.0": [[0, "id25"]], "0.4.1": [[0, "id28"]], "0.4.0": [[0, "id30"]], "0.3.5": [[0, "id33"]], "0.3.4": [[0, "id35"]], "0.3.3": [[0, "id37"]], "0.3.2": [[0, "id39"]], "0.3.1": [[0, "id42"]], "Changes": [[0, "changes"], [0, "id45"]], "0.3.0": [[0, "id43"]], "0.2.0": [[0, "id46"]], "Depricated": [[0, "depricated"]], "0.1.1": [[0, "id48"]], "0.1.0": [[0, "id50"]], "Contributor Covenant Code of Conduct": [[1, "contributor-covenant-code-of-conduct"]], "Our Pledge": [[1, "our-pledge"]], "Our Standards": [[1, "our-standards"]], "Our Responsibilities": [[1, "our-responsibilities"]], "Scope": [[1, "scope"]], "Enforcement": [[1, "enforcement"]], "Attribution": [[1, "attribution"]], "Contributing": [[2, "contributing"], [6, "contributing"]], "Pull Request Process": [[2, "pull-request-process"]], "MIT License": [[4, "mit-license"]], "UnicornFy": [[6, "unicornfy"]], "Get the right logger:": [[6, "get-the-right-logger"]], "Supported Exchanges": [[6, "supported-exchanges"]], "Websockets": [[6, "websockets"]], "REST": [[6, "rest"]], "Installation and Upgrade": [[6, "installation-and-upgrade"]], "Packages are created automatically with GitHub Actions": [[6, "packages-are-created-automatically-with-github-actions"]], "A Cython binary, PyPy or source code based CPython wheel of the latest version with pip from PyPI": [[6, "a-cython-binary-pypy-or-source-code-based-cpython-wheel-of-the-latest-version-with-pip-from-pypi"]], "Installation": [[6, "installation"], [6, "id1"]], "Update": [[6, "update"], [6, "id2"]], "A Conda Package of the latest version with conda from Anaconda": [[6, "a-conda-package-of-the-latest-version-with-conda-from-anaconda"]], "From source of the latest release with PIP from Github": [[6, "from-source-of-the-latest-release-with-pip-from-github"]], "Linux, macOS, \u2026": [[6, "linux-macos"]], "Windows": [[6, "windows"]], "From the latest source (dev-stage) with PIP from GitHub": [[6, "from-the-latest-source-dev-stage-with-pip-from-github"]], "Conda environment, Virtualenv or plain Python": [[6, "conda-environment-virtualenv-or-plain-python"]], "Change Log": [[6, "change-log"]], "Documentation": [[6, "documentation"]], "Examples": [[6, "examples"]], "Project Homepage": [[6, "project-homepage"]], "Wiki": [[6, "wiki"]], "Social": [[6, "social"]], "Receive Notifications": [[6, "receive-notifications"]], "How to report Bugs or suggest Improvements?": [[6, "how-to-report-bugs-or-suggest-improvements"]], "Contributors": [[6, "contributors"]], "Disclaimer": [[6, "disclaimer"]], "If you intend to use real money, use it at your own risk!": [[6, "if-you-intend-to-use-real-money-use-it-at-your-own-risk"]], "Commercial Support": [[6, "commercial-support"]], "Security Policies and Procedures": [[7, "security-policies-and-procedures"]], "Reporting a Bug": [[7, "reporting-a-bug"]], "Disclosure Policy": [[7, "disclosure-policy"]], "Comments on this Policy": [[7, "comments-on-this-policy"]], "unicorn_fy package": [[8, "unicorn-fy-package"]], "Submodules": [[8, "submodules"]], "unicorn_fy.unicorn_fy module": [[8, "module-unicorn_fy.unicorn_fy"]], "Module contents": [[8, "module-unicorn_fy"]]}, "indexentries": {"unicornfy (class in unicorn_fy.unicorn_fy)": [[8, "unicorn_fy.unicorn_fy.UnicornFy"]], "binance_com_coin_futures_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_com_coin_futures_websocket"]], "binance_com_futures_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_com_futures_websocket"]], "binance_com_isolated_margin_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_com_isolated_margin_websocket"]], "binance_com_margin_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_com_margin_websocket"]], "binance_com_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_com_websocket"]], "binance_futures_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_futures_websocket"]], "binance_org_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_org_websocket"]], "binance_us_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_us_websocket"]], "binance_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.binance_websocket"]], "get_latest_release_info() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.get_latest_release_info"]], "get_latest_version() (unicorn_fy.unicorn_fy.unicornfy method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.get_latest_version"]], "get_version() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.get_version"]], "is_json() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.is_json"]], "is_update_available() (unicorn_fy.unicorn_fy.unicornfy method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.is_update_available"]], "module": [[8, "module-unicorn_fy"], [8, "module-unicorn_fy.unicorn_fy"]], "set_to_false_if_not_exist() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.set_to_false_if_not_exist"]], "trbinance_com_websocket() (unicorn_fy.unicorn_fy.unicornfy static method)": [[8, "unicorn_fy.unicorn_fy.UnicornFy.trbinance_com_websocket"]], "unicorn_fy": [[8, "module-unicorn_fy"]], "unicorn_fy.unicorn_fy": [[8, "module-unicorn_fy.unicorn_fy"]]}}) \ No newline at end of file diff --git a/docs/security.html b/docs/security.html index cfbdba2..d985266 100644 --- a/docs/security.html +++ b/docs/security.html @@ -343,7 +343,7 @@

        Navigation

        Index of all LUCIT Software Documentation
        © Copyright 2023-2023, LUCIT Systems and Development. All Rights Reserved.. See License for more information.
        - Last updated on May 09 2024 at 21:03 (CET). + Last updated on May 13 2024 at 14:24 (CET). Found a bug?
        Created using Sphinx 7.2.6. diff --git a/docs/unicorn_fy.html b/docs/unicorn_fy.html index 19b8d6f..0f2e83c 100644 --- a/docs/unicorn_fy.html +++ b/docs/unicorn_fy.html @@ -68,14 +68,12 @@

        Table of Contents

      • Submodules
      • unicorn_fy.unicorn_fy module