Integrate and apply ruff (#142)

Author: btschwertfeger

.gitignore

@@ -53,6 +53,7 @@ htmlcov/
 .coverage
 .coverage.*
 .cache
+.ruff_cache
 nosetests.xml
 coverage.xml
 pytest.xml

.pre-commit-config.yaml

@@ -49,16 +49,13 @@ repos:
           - --select=E9,F63,F7,F82
           - --show-source
           - --statistics
-  - repo: https://github.com/pycqa/pylint
-    rev: v2.17.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.282
     hooks:
-      - id: pylint
-        name: pylint
-        types: [python]
-        exclude: ^examples/|^tests/|^setup.py$
+      - id: ruff
         args:
-          - --rcfile=pyproject.toml
-          - -d=R0801 # ignore duplicate code
+          - --fix
+          - --exit-non-zero-on-fix
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.2.0
     hooks:

CHANGELOG.md

@@ -4,6 +4,12 @@
 
 [Full Changelog](https://github.com/btschwertfeger/python-kraken-sdk/compare/v1.5.0...HEAD)
 
+**Breaking changes:**
+
+- Integrate Websockets API v2 [\#130](https://github.com/btschwertfeger/python-kraken-sdk/issues/130)
+- Let `kraken.spot.OrderbookClient` use Spot Websocket API v2 [\#139](https://github.com/btschwertfeger/python-kraken-sdk/pull/139) ([btschwertfeger](https://github.com/btschwertfeger))
+- Integrate Kraken Websockets API v2; add `kraken.spot.KrakenSpotWebsocketClientV2`; internals [\#131](https://github.com/btschwertfeger/python-kraken-sdk/pull/131) ([btschwertfeger](https://github.com/btschwertfeger))
+
 **Implemented enhancements:**
 
 - Add `/private/AccountTransfer` endpoint to `kraken.spot.User` [\#128](https://github.com/btschwertfeger/python-kraken-sdk/issues/128)

Makefile

@@ -9,7 +9,7 @@ PYTEST_OPTS := -vv --junit-xml=pytest.xml
 PYTEST_COV_OPTS := $(PYTEST_OPTS) --cov --cov-report=xml:coverage.xml --cov-report=term
 TEST_DIR := tests
 
-.PHONY := help build rebuild doc install dev test tests test-wip coverage doctest pre-commit changelog clean
+.PHONY := help build rebuild doc install dev test tests test-wip coverage doctest pre-commit ruff ruff-fix changelog clean
 
 help:
 	@grep "^##" Makefile | sed -e "s/##//"
@@ -71,6 +71,14 @@ doctest:
 pre-commit:
 	@pre-commit run -a
 
+## ruff 	Run ruff without fix
+ruff:
+	ruff check .
+
+## ruff-fix 	Run ruff with fix
+ruff-fix:
+	ruff check . --fix
+
 ## changelog	Generate the changelog
 ##
 changelog:
@@ -92,7 +100,9 @@ clean:
 		python_kraken_sdk.egg-info \
 		docs/_build \
 		.vscode \
-		.mypy_cache
+		.cache \
+		.mypy_cache \
+		.ruff_cache
 
 	rm -f .coverage coverage.xml pytest.xml mypy.xml \
 		kraken/_version.py \

README.md

@@ -7,6 +7,7 @@
 [![Generic badge](https://img.shields.io/badge/python-3.7_|_3.8_|_3.9_|_3.10_|_3.11-blue.svg)](https://shields.io/)
 [![Downloads](https://static.pepy.tech/personalized-badge/python-kraken-sdk?period=total&units=abbreviation&left_color=grey&right_color=orange&left_text=downloads)](https://pepy.tech/project/python-kraken-sdk)
 
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Typing](https://img.shields.io/badge/typing-mypy-informational)](https://mypy-lang.org/)
 [![CodeQL](https://github.com/btschwertfeger/python-kraken-sdk/actions/workflows/codeql.yaml/badge.svg?branch=master)](https://github.com/btschwertfeger/python-kraken-sdk/actions/workflows/codeql.yaml)
 [![CI/CD](https://github.com/btschwertfeger/python-kraken-sdk/actions/workflows/cicd.yaml/badge.svg?branch=master)](https://github.com/btschwertfeger/python-kraken-sdk/actions/workflows/cicd.yaml)
@@ -90,13 +91,13 @@ release specific READMEs and changelogs.
 
 # 🛠 Installation and setup
 
-### 1. Install the Python module:
+### 1. Install the package into the desired environment
 
 ```bash
 python3 -m pip install python-kraken-sdk
 ```
 
-### 2. Register at Kraken and generate API Keys:
+### 2. Register at [Kraken](https://www.kraken.com) and generate API keys
 
 - Spot Trading: https://www.kraken.com/u/security/api
 - Futures Trading: https://futures.kraken.com/trade/settings/api (see _[help](https://docs.futures.kraken.com/#introduction-generate-api-keys)_)
@@ -146,12 +147,12 @@ def main():
     user = User(key=key, secret=secret)
     print(user.get_account_balance())
     print(user.get_open_orders())
-    # ...
+    # …
 
     # ____MARKET____
     market = Market()
     print(market.get_ticker(pair="BTCUSD"))
-    # ...
+    # …
 
     # ____TRADE_________________________
     trade = Trade(key=key, secret=secret)
@@ -162,7 +163,7 @@ def main():
          pair="BTC/EUR",
          price=20000
     ))
-    # ...
+    # …
 
     # ____FUNDING___________________________
     funding = Funding(key=key, secret=secret)
@@ -172,7 +173,7 @@ def main():
         )
     )
     print(funding.cancel_withdraw(asset="DOT", refid="<some id>"))
-    # ...
+    # …
 
     # ____STAKING___________________________
     staking = Staking(key=key, secret=secret)
@@ -182,7 +183,7 @@ def main():
             asset="DOT", amount=20, method="polkadot-staked"
         )
     )
-    # ...
+    # …
 
 if __name__ == "__main__":
     main()
@@ -227,7 +228,7 @@ async def main():
 
             print(message)
             # here we can access lots of methods, for example to create an order:
-            # if self._is_auth:  # only if the client is authenticated …
+            # if self.is_auth:  # only if the client is authenticated …
             #     await self.send_message(
             #         message={
             #             "method": "add_order",
@@ -242,7 +243,7 @@ async def main():
             #             },
             #         }
             #     )
-            # ... it is also possible to call regular REST endpoints
+            # … it is also possible to call regular REST endpoints
             # but using the websocket messages is more efficient.
             # You can also un-/subscribe here using self.subscribe/self.unsubscribe.
 
@@ -255,13 +256,13 @@ async def main():
     await client.subscribe(
         params={"channel": "book", "depth": 25, "symbol": ["BTC/USD"]}
     )
-    # wait because unsubscribing is faster than unsubscribing ... (just for that example)
+    # wait because unsubscribing is faster than unsubscribing … (just for that example)
     await asyncio.sleep(3)
-    # print(client.active_public_subscriptions) # … to list active subscriptions
+    # print(client.active_public_subscriptions) # to list active subscriptions
     await client.unsubscribe(
         params={"channel": "ticker", "symbol": ["BTC/USD", "DOT/USD"]}
     )
-    # ...
+    # …
 
     # Per default, the authenticated client starts two websocket connections,
     # one for authenticated and one for public messages. If there is no need
@@ -325,7 +326,7 @@ def main():
     print(user.get_open_orders())
     print(user.get_open_positions())
     print(user.get_subaccounts())
-    # ...
+    # …
 
     # ____MARKET____
     market = Market()
@@ -334,7 +335,7 @@ def main():
     priv_market = Market(key=key, secret=secret)
     print(priv_market.get_fee_schedules_vol())
     print(priv_market.get_execution_events())
-    # ...
+    # …
 
     # ____TRADE_________________________
     trade = Trade(key=key, secret=secret)
@@ -376,11 +377,11 @@ def main():
             symbol="pf_bchusd"
         )
     )
-    # ...
+    # …
 
     # ____FUNDING___________________________
     funding = Funding(key=key, secret=secret)
-    # ...
+    # …
 
 if __name__ == "__main__":
     main()
@@ -420,7 +421,7 @@ async def main():
     # subscribe to a public websocket feed
     await client.subscribe(feed="ticker", products=products)
     # await client.subscribe(feed="book", products=products)
-    # ...
+    # …
 
     # unsubscribe from a public websocket feed
     # await client.unsubscribe(feed="ticker", products=products)
@@ -433,7 +434,7 @@ async def main():
     await client_auth.subscribe(feed="fills")
     await client_auth.subscribe(feed="open_positions")
     await client_auth.subscribe(feed="open_orders")
-    # ...
+    # …
 
     # unsubscribe from a private/authenticated websocket feed
     await client_auth.unsubscribe(feed="fills")
@@ -445,7 +446,7 @@ if __name__ == "__main__":
     try:
         asyncio.run(main())
     except KeyboardInterrupt:
-        # do some exception handling ...
+        # do some exception handling …
         pass
 ```
 

docs/conf.py

@@ -17,13 +17,12 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "python-kraken-sdk"
-copyright = "2023, Benjamin Thomas Schwertfeger"  # pylint: disable=redefined-builtin
+copyright = "2023, Benjamin Thomas Schwertfeger"  # noqa: A001
 author = "Benjamin Thomas Schwertfeger"
 
 # to import the package
 sys.path.insert(0, os.path.abspath(".."))
 
-# import links
 rst_epilog = ""
 # Read link all targets from file
 with open("links.rst", encoding="utf-8") as f:
@@ -44,11 +43,6 @@
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "links.rst"]
 
-
-def setup(app):
-    """Run during the Sphinx building process"""
-
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 

examples/futures_examples.py

@@ -21,8 +21,8 @@
 logging.getLogger("requests").setLevel(logging.WARNING)
 logging.getLogger("urllib3").setLevel(logging.WARNING)
 
-key = os.getenv("Futures_SANDBOX_KEY")
-secret = os.getenv("Futures_SANDBOX_SECRET")
+key = os.getenv("FUTURES_SANDBOX_KEY")
+secret = os.getenv("FUTURES_SANDBOX_SECRET")
 
 #  _   _  ___ _____ _____
 # | \ | |/ _ \_   _| ____|_
@@ -93,7 +93,7 @@ def user_examples() -> None:
 def trade_examples() -> None:
     """Example Trade client usage"""
     raise ValueError(
-        "Attention: Please check if you really want to test the trade endpoints!"
+        "Attention: Please check if you really want to test the trade endpoints!",
     )
     trade = Trade(key=key, secret=secret, sandbox=True)
     print(trade.get_fills())
@@ -129,7 +129,7 @@ def trade_examples() -> None:
                     "cliOrdId": 123456789,
                 },
             ],
-        )
+        ),
     )
     print(trade.cancel_all_orders())
     print(trade.cancel_all_orders(symbol="pi_xbtusd"))
@@ -138,8 +138,11 @@ def trade_examples() -> None:
     print(trade.cancel_order(order_id="some order id"))
     print(
         trade.edit_order(
-            orderId="some order id", size=300, limitPrice=401, stopPrice=350
-        )
+            orderId="some order id",
+            size=300,
+            limitPrice=401,
+            stopPrice=350,
+        ),
     )
     print(trade.get_orders_status(orderIds=["orderid1", "orderid2"]))
     print(
@@ -149,7 +152,7 @@ def trade_examples() -> None:
             size=1,
             limitPrice=4,
             symbol="pf_bchusd",
-        )
+        ),
     )
     print(
         trade.create_order(
@@ -159,7 +162,7 @@ def trade_examples() -> None:
             symbol="pf_bchusd",
             stopPrice=100,
             triggerSignal="mark",
-        )
+        ),
     )
 
 

examples/futures_trading_bot_template.py

@@ -55,7 +55,8 @@ class TradingBot(KrakenFuturesWSClient):
 
     def __init__(self: TradingBot, config: dict) -> None:
         super().__init__(  # initialize the KrakenFuturesWSClient
-            key=config["key"], secret=config["secret"]
+            key=config["key"],
+            secret=config["secret"],
         )
         self.__config: dict = config
 
@@ -90,7 +91,10 @@ async def on_message(self: TradingBot, msg: Union[list, dict]) -> None:
 
     def save_exit(self: TradingBot, reason: Optional[str] = "") -> None:
         """Controlled shutdown of the strategy"""
-        logging.warning(f"Save exit triggered, reason: {reason}")
+        logging.warning(
+            "Save exit triggered, reason: {reason}",
+            extra={"reason": reason},
+        )
         # some ideas:
         #   * save the bots data
         #   * maybe close trades
@@ -143,10 +147,12 @@ async def __main(self: ManagedBot) -> None:
         self.__trading_strategy = TradingBot(config=self.__config)
 
         await self.__trading_strategy.subscribe(
-            feed="ticker", products=self.__config["products"]
+            feed="ticker",
+            products=self.__config["products"],
         )
         await self.__trading_strategy.subscribe(
-            feed="book", products=self.__config["products"]
+            feed="book",
+            products=self.__config["products"],
         )
 
         await self.__trading_strategy.subscribe(feed="fills")
@@ -168,9 +174,8 @@ async def __main(self: ManagedBot) -> None:
 
             await asyncio.sleep(6)
         self.__trading_strategy.save_exit(
-            reason="Left main loop because of exception in strategy."
+            reason="Left main loop because of exception in strategy.",
         )
-        return
 
     def __check_credentials(self: ManagedBot) -> bool:
         """Checks the user credentials and the connection to Kraken"""
@@ -205,14 +210,14 @@ def main() -> None:
             "key": os.getenv("FUTURES_API_KEY"),
             "secret": os.getenv("FUTURES_SECRET_KEY"),
             "products": ["PI_XBTUSD", "PF_SOLUSD"],
-        }
+        },
     )
 
     try:
         managed_bot.run()
     except Exception:
         managed_bot.save_exit(
-            reason=f"manageBot.run() has ended: {traceback.format_exc()}"
+            reason=f"manageBot.run() has ended: {traceback.format_exc()}",
         )