Let REST and websocket clients be used as context manager (#83)

# Summary
All clients can now be used as context manager. The documentation and
examples were extended.

Author: btschwertfeger

README.md

@@ -42,11 +42,14 @@ General:
 - access both public and private endpoints
 - responsive error handling, custom exceptions and logging
 - extensive example scripts (see `/examples`)
+- clients can be used as context manager
+- coding standards like snake case are not always followed to maintain the parameter naming convention of the Kraken API
+- ...
 
 Documentation:
 
 - Stable: [https://python-kraken-sdk.readthedocs.io/en/stable](https://python-kraken-sdk.readthedocs.io/en/stable)
-- Latest: [https://python-kraken-sdk.readthedocs.io/en/katest](https://python-kraken-sdk.readthedocs.io/en/latest)
+- Latest: [https://python-kraken-sdk.readthedocs.io/en/latest](https://python-kraken-sdk.readthedocs.io/en/latest)
 
 ---
 

docs/src/introduction.rst

@@ -46,6 +46,7 @@ General:
 - access both public and private endpoints
 - responsive error handling, custom exceptions and logging
 - extensive examples
+- all clients can be used as context manager
 - coding standards like snake case are not always followed to maintain the parameter naming convention of the Kraken API
 
 Important Notice

examples/futures_examples.py

@@ -190,11 +190,10 @@ def funding_examples() -> None:
 
 
 def main() -> None:
-    """Main"""
-    # user_examples()
+    user_examples()
     market_examples()
-    # trade_examples()
-    # funding_examples()
+    trade_examples()
+    funding_examples()
 
 
 if __name__ == "__main__":

examples/futures_ws_examples.py

@@ -56,7 +56,7 @@ async def on_message(self, event) -> Coroutine:
     # unsubscribe from a websocket feed
     time.sleep(2)  # in case subscribe is not done yet
     # await bot.unsubscribe(feed='ticker', products=['PI_XBTUSD'])
-    await bot.unsubscribe(feed="ticker", products=["PF_SOLUSD"])
+    await bot.unsubscribe(feed="ticker", products=["PF_XBTUSD"])
     await bot.unsubscribe(feed="book", products=products)
     # ....
 
@@ -100,3 +100,28 @@ async def on_message(self, event) -> Coroutine:
         pass
     finally:
         loop.close()
+
+# ============================================================
+# Alternative - as ContextManager:
+
+# from kraken.futures import KrakenFuturesWSClient
+# import asyncio
+
+# async def on_message(msg):
+#     print(msg)
+
+# async def main() -> None:
+#     async with KrakenFuturesWSClient(callback=on_message) as session:
+#         await session.subscribe(feed="ticker", products=["PF_XBTUSD"])
+#     while True:
+#         await asyncio.sleep(6)
+
+# if __name__ == "__main__":
+#     loop = asyncio.new_event_loop()
+#     asyncio.set_event_loop(loop)
+#     try:
+#         asyncio.run(main())
+#     except KeyboardInterrupt:
+#         pass
+#     finally:
+#         loop.close()

examples/spot_examples.py

@@ -128,7 +128,7 @@ def trade_examples() -> None:
                     },
                 ],
                 pair="BTC/USD",
-                validate=False,
+                validate=True,
             )
         )
 
@@ -195,7 +195,6 @@ def staking_examples() -> None:
 
 
 def main() -> None:
-    """Main"""
     user_examples()
     market_examples()
     trade_examples()

examples/spot_ws_examples.py

@@ -103,3 +103,29 @@ async def on_message(self, event) -> Coroutine:
         # so you can handle the behaviour/next actions individually within you bot
     finally:
         loop.close()
+
+# ============================================================
+# Alternative - as ContextManager:
+
+# from kraken.spot import KrakenSpotWSClient
+# import asyncio
+
+# async def on_message(msg):
+#     print(msg)
+
+# async def main() -> None:
+#     async with KrakenSpotWSClient(callback=on_message) as session:
+#         await session.subscribe(subscription={"name": "ticker"}, pair=["XBT/USD"])
+
+#     while True:
+#         await asyncio.sleep(6)
+
+# if __name__ == "__main__":
+#     loop = asyncio.new_event_loop()
+#     asyncio.set_event_loop(loop)
+#     try:
+#         asyncio.run(main())
+#     except KeyboardInterrupt:
+#         pass
+#     finally:
+#         loop.close()

kraken/base_api/__init__.py

@@ -74,12 +74,12 @@ def check_send_status(self, data: dict) -> dict:
             return data
         return data
 
-    def check_batch_status(self, data: List[dict]) -> dict:
+    def check_batch_status(self, data: dict) -> dict:
         """
         Used to check the Futures batch order responses for errors
 
         :param data: The response as dict to check for an error
-        :type data: List[dict]
+        :type data: dict
         :raise kraken.exceptions.KrakenException.*: raises a KrakenError if the response contains an error
         :return: The response as List[dict]
         :rtype: List[dict]
@@ -308,6 +308,12 @@ def _to_str_list(self, value: Union[str, list]) -> str:
             return ",".join(value)
         raise ValueError("a must be type of str or list of strings")
 
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *exc) -> None:
+        pass
+
 
 class KrakenBaseFuturesAPI:
     """
@@ -532,3 +538,9 @@ def __check_response_data(
         raise Exception(
             f"{response.status_code} - {response.text}"
         )  # pylint: disable=W0719
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *exc) -> None:
+        pass

kraken/futures/funding/__init__.py

@@ -33,6 +33,14 @@ class Funding(KrakenBaseFuturesAPI):
         >>> from kraken.futures import Funding
         >>> funding = Funding() # unauthenticated
         >>> funding = Funding(key="api-key", secret="secret-key") # authenticated
+
+    .. code-block:: python
+        :linenos:
+        :caption: Futures Funding: Create the funding client as context manager
+
+        >>> from kraken.futures import Funding
+        >>> with Funding(key="api-key", secret="secret-key") as funding:
+        ...     print(funding.get_historical_funding_rates(symbol="PI_XBTUSD"))
     """
 
     def __init__(

kraken/futures/market/__init__.py

@@ -31,8 +31,16 @@ class Market(KrakenBaseFuturesAPI):
         :caption: Futures Market: Create the market client
 
         >>> from kraken.futures import Market
-        >>> marker = Market() # unauthenticated
-        >>> marker = Market(key="api-key", secret="secret-key") # authenticated
+        >>> market = Market() # unauthenticated
+        >>> market = Market(key="api-key", secret="secret-key") # authenticated
+
+    .. code-block:: python
+        :linenos:
+        :caption: Futures Market: Create the market client as context manager
+
+        >>> from kraken.futures import Market
+        >>> with Market() as market:
+        ...     print(market.get_tick_types())
     """
 
     def __init__(

kraken/futures/trade/__init__.py

@@ -33,6 +33,14 @@ class Trade(KrakenBaseFuturesAPI):
         >>> from kraken.futures import Trade
         >>> trade = Trade() # unauthenticated
         >>> trade = Trade(key="api-key", secret="secret-key") # authenticated
+
+    .. code-block:: python
+        :linenos:
+        :caption: Futures Trade: Create the trade client as context manager
+
+        >>> from kraken.futures import Trade
+        >>> with Trade(key="api-key", secret="secret-key") as trade:
+        ...     print(trade.get_fills())
     """
 
     def __init__(