small fixes

Author: oliver-zehentleitner

CHANGELOG.md

@@ -10,21 +10,27 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 [How to upgrade to the latest version!](https://unicorn-binance-websocket-api.docs.lucit.tech/readme.html#installation-and-upgrade)
 
 ## 2.7.0.dev (development stage/unreleased/unstable)
+### Changed
+- Improved text of `MaximumSubscriptionsExceeded` exception.
+- Updated description text in all files.
+### Fixed
+- Import in `licensing_manager.py`.
+- Type of global `logger` and `connect` variable.
 
 ## 2.7.0
 ### Added
-- Exception `MaximumSubscriptionsExceeded` thrown by `subscribe_to_stream()`
+- Exception `MaximumSubscriptionsExceeded` thrown by `subscribe_to_stream()`.
 - `print_summary()` and `print_stream_info()` now display `binance_api_status_code` in color! Green at 200 otherwise red.
 ### Changed
 - `subscribe_to_stream()` now throws the exception `MaximumSubscriptionsExceeded` instand of returning `False` if  
   the number of allowed subscriptions per stream is exceeded.
 ### Fixed
-- Typing of `create_stream()` parameters
-- Type of parameter `stream_label` in `get_stream_id_by_label()`
-- Type of first return variable in `restclient.get_listen_key()`
-- Typo in `is_update_availabe_unicorn_fy()` to `is_update_available_unicorn_fy()` 
-- Typo in `is_update_availabe_check_command()` to `is_update_available_check_command()`
-- A couple of small text typos
+- Typing of `create_stream()` parameters.
+- Type of parameter `stream_label` in `get_stream_id_by_label()`.
+- Type of first return variable in `restclient.get_listen_key()`.
+- Typo in `is_update_availabe_unicorn_fy()` to `is_update_available_unicorn_fy()`.
+- Typo in `is_update_availabe_check_command()` to `is_update_available_check_command()`.
+- A couple of small text typos.
 
 ## 2.6.0
 ### Added

README.md

@@ -33,7 +33,7 @@
 
 A Python SDK by [LUCIT](https://www.lucit.tech) to use the Binance Websocket API`s (com+testnet, com-margin+testnet, 
 com-isolated_margin+testnet, com-futures+testnet, com-coin_futures, us, tr, dex/chain+testnet) 
-in a easy, fast, flexible, robust and fully-featured way. 
+in a simple, fast, flexible, robust and fully-featured way. 
 
 Part of '[UNICORN Binance Suite](https://www.lucit.tech/unicorn-binance-suite.html)'.
 
@@ -123,8 +123,8 @@ with BinanceWebSocketApiManager(exchange='binance.com') as ubwa:
         asyncio.run(main())
     except KeyboardInterrupt:
         print("\r\nGracefully stopping ...")
-    except Exception as error_msg:
-        print(f"\r\nERROR: {error_msg}\r\nGracefully stopping ...")
+    except Exception as e:
+        print(f"\r\nERROR: {e}\r\nGracefully stopping ...")
 ```
 
 Basically that's it, but there are more options.

meta.yaml

@@ -75,7 +75,7 @@ about:
   summary: | 
     A Python SDK by [LUCIT](https://www.lucit.tech) to use the Binance Websocket API`s (com+testnet, com-margin+testnet, 
     com-isolated_margin+testnet, com-futures+testnet, com-coin_futures, us, tr, dex/chain+testnet) 
-    in a easy, fast, flexible, robust and fully-featured way.
+    in a simple, fast, flexible, robust and fully-featured way.
   description: |
     [![Get a UNICORN Binance Suite License](https://raw.githubusercontent.com/LUCIT-Systems-and-Development/unicorn-binance-suite/master/images/logo/LUCIT-UBS-License-Offer.png)](https://shop.lucit.services)
     [![GitHub Release](https://img.shields.io/github/release/LUCIT-Systems-and-Development/unicorn-binance-websocket-api.svg?label=github)](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/releases)

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "unicorn-binance-websocket-api"
 version = "2.7.0"
-description = "A Python SDK by LUCIT to use the Binance Websocket API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, com-coin_futures, us, tr, dex/chain+testnet) in a easy, fast, flexible, robust and fully-featured way."
+description = "A Python SDK by LUCIT to use the Binance Websocket API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, com-coin_futures, us, tr, dex/chain+testnet) in a simple, fast, flexible, robust and fully-featured way."
 authors = ["LUCIT Systems and Development <[email protected]>"]
 license = "LSOSL - LUCIT Synergetic Open Source License"
 readme = "README.md"

setup.py

@@ -62,7 +62,7 @@
     url="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api",
     description="A Python SDK by LUCIT to use the Binance Websocket API`s (com+testnet, "
                 "com-margin+testnet, com-isolated_margin+testnet, com-futures+testnet, com-coin_futures, us, tr, "
-                "dex/chain+testnet) in a easy, fast, flexible, robust and fully-featured way.",
+                "dex/chain+testnet) in a simple, fast, flexible, robust and fully-featured way.",
     long_description=long_description,
     long_description_content_type="text/markdown",
     license='LSOSL - LUCIT Synergetic Open Source License',

unicorn_binance_websocket_api/api.py

@@ -29,7 +29,7 @@
 import threading
 
 
-logger = logging.getLogger("unicorn_binance_websocket_api")
+logger: logging.getLogger = logging.getLogger("unicorn_binance_websocket_api")
 
 
 class BinanceWebSocketApiApi(object):

unicorn_binance_websocket_api/connection.py

@@ -27,8 +27,8 @@
 import sys
 import websockets
 
-connect = websockets.connect
-logger = logging.getLogger("unicorn_binance_websocket_api")
+connect:  websockets.connect = websockets.connect
+logger: logging.getLogger = logging.getLogger("unicorn_binance_websocket_api")
 
 
 class BinanceWebSocketApiConnection(object):

unicorn_binance_websocket_api/exceptions.py

@@ -20,10 +20,13 @@
 
 class MaximumSubscriptionsExceeded(Exception):
     """
-    Exception if the maximum number of subscriptions has been exceeded!
+    Exception if the maximum number of subscriptions per stream has been exceeded!
     """
-    def __init__(self, max_subscriptions=None):
-        self.message = f"The maximum number of {max_subscriptions} subscriptions per stream has been exceeded!"
+    def __init__(self, exchange: str = None, max_subscriptions_per_stream: int = None):
+        self.message = (f"The maximum number of {max_subscriptions_per_stream} subscriptions per stream for exchange "
+                        f"'{exchange}' has been exceeded! For detailed information please have a look at our wiki: "
+                        f"https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/Binance-"
+                        f"websocket-endpoint-configuration-overview")
         super().__init__(self.message)
 
 

unicorn_binance_websocket_api/licensing_manager.py

@@ -35,11 +35,11 @@
 from simplejson.errors import JSONDecodeError
 from typing import Optional, Callable
 try:
-    from licensing_exceptions import NoValidatedLucitLicense
+    from .licensing_exceptions import NoValidatedLucitLicense
 except ModuleNotFoundError:
     from unicorn_binance_websocket_api.licensing_exceptions import NoValidatedLucitLicense
 
-logger = logging.getLogger("lucit_licensing_python")
+logger: logging.getLogger = logging.getLogger("lucit_licensing_python")
 
 
 class LucitLicensingManager(threading.Thread):

unicorn_binance_websocket_api/manager.py

@@ -63,14 +63,14 @@
 __app_name__: str = "unicorn-binance-websocket-api"
 __version__: str = "2.7.0.dev"
 
-logger = logging.getLogger("unicorn_binance_websocket_api")
+logger: logging.getLogger = logging.getLogger("unicorn_binance_websocket_api")
 
 
 class BinanceWebSocketApiManager(threading.Thread):
     """
-    An unofficial Python API to use the Binance Websocket API`s (com+testnet, com-margin+testnet,
-    com-isolated_margin+testnet, com-futures+testnet, us, dex/chain+testnet) in an easy, fast, flexible,
-    robust and fully-featured way.
+    A Python SDK by LUCIT to use the Binance Websocket API`s (com+testnet, com-margin+testnet,
+    com-isolated_margin+testnet, com-futures+testnet, com-coin_futures, us, tr, dex/chain+testnet) in a simple, fast,
+    flexible, robust and fully-featured way.
 
     This library supports two different kind of websocket endpoints:
 
@@ -4632,12 +4632,13 @@ def subscribe_to_stream(self, stream_id: str = None, channels=None, markets=None
         if self.stream_list[stream_id]['subscriptions'] > self.max_subscriptions_per_stream:
             error_msg = (f"The limit of {str(self.max_subscriptions_per_stream)} subscriptions per stream has been "
                          f"exceeded!")
-            logger.error(f"BinanceWebSocketApiManager.subscribe_to_stream({str(stream_id)}) - error_msg: {str(error_msg)}")
-            # self._crash_stream(stream_id, error_msg=error_msg)
-            #return False
-            raise MaximumSubscriptionsExceeded(max_subscriptions=str(self.max_subscriptions_per_stream))
+            logger.error(f"BinanceWebSocketApiManager.subscribe_to_stream({str(stream_id)}) - error_msg: "
+                         f"{str(error_msg)}")
+            raise MaximumSubscriptionsExceeded(exchange=self.get_exchange(),
+                                               max_subscriptions_per_stream=self.max_subscriptions_per_stream)
         if payload is None:
-            logger.error(f"BinanceWebSocketApiManager.subscribe_to_stream({str(stream_id)}) - error_msg: Payload is None!")
+            logger.error(f"BinanceWebSocketApiManager.subscribe_to_stream({str(stream_id)}) - error_msg: Payload is "
+                         f"None!")
             return False
         try:
             for item in payload:

unicorn_binance_websocket_api/restclient.py

@@ -25,7 +25,7 @@
 import threading
 import time
 
-logger = logging.getLogger("unicorn_binance_websocket_api")
+logger: logging.getLogger = logging.getLogger("unicorn_binance_websocket_api")
 
 
 class BinanceWebSocketApiRestclient(object):

unicorn_binance_websocket_api/restserver.py

@@ -21,7 +21,7 @@
 from flask_restful import Resource
 import logging
 
-logger = logging.getLogger("unicorn_binance_websocket_api")
+logger: logging.getLogger = logging.getLogger("unicorn_binance_websocket_api")
 
 
 class BinanceWebSocketApiRestServer(Resource):

unicorn_binance_websocket_api/sockets.py

@@ -26,7 +26,7 @@
 import ujson as json
 import logging
 
-logger = logging.getLogger("unicorn_binance_websocket_api")
+logger: logging.getLogger = logging.getLogger("unicorn_binance_websocket_api")
 
 
 class BinanceWebSocketApiSocket(object):