Update documentation style

Author: btschwertfeger

.github/workflows/_codecov.yaml

@@ -25,6 +25,10 @@ on:
         required: true
       SPOT_SECRET_KEY:
         required: true
+      XSTOCKS_API_KEY:
+        required: true
+      XSTOCKS_SECRET_KEY:
+        required: true
       FUTURES_API_KEY:
         required: true
       FUTURES_SECRET_KEY:
@@ -81,6 +85,8 @@ jobs:
         env:
           SPOT_API_KEY: ${{ secrets.SPOT_API_KEY }}
           SPOT_SECRET_KEY: ${{ secrets.SPOT_SECRET_KEY }}
+          XSTOCKS_API_KEY: ${{ secrets.XSTOCKS_API_KEY }}
+          XSTOCKS_SECRET_KEY: ${{ secrets.XSTOCKS_SECRET_KEY }}
           FUTURES_API_KEY: ${{ secrets.FUTURES_API_KEY }}
           FUTURES_SECRET_KEY: ${{ secrets.FUTURES_SECRET_KEY }}
           FUTURES_SANDBOX_KEY: ${{ secrets.FUTURES_SANDBOX_KEY }}

.github/workflows/_test_spot_private.yaml

@@ -27,6 +27,10 @@ on:
         required: true
       SPOT_SECRET_KEY:
         required: true
+      XSTOCKS_API_KEY:
+        required: true
+      XSTOCKS_SECRET_KEY:
+        required: true
 
 permissions:
   contents: read
@@ -94,6 +98,8 @@ jobs:
         env:
           SPOT_API_KEY: ${{ secrets.SPOT_API_KEY }}
           SPOT_SECRET_KEY: ${{ secrets.SPOT_SECRET_KEY }}
+          XSTOCKS_API_KEY: ${{ secrets.XSTOCKS_API_KEY }}
+          XSTOCKS_SECRET_KEY: ${{ secrets.XSTOCKS_SECRET_KEY }}
         run: pytest -vv -m "spot and spot_auth and not spot_websocket" tests
 
       - name: Testing Spot websocket client

.github/workflows/cicd.yaml

@@ -17,6 +17,9 @@
 #             for Spot:
 #               * SPOT_API_KEY
 #               * SPOT_SECRET_KEY
+#             for xStocks (Kraken UAT):
+#               * XSTOCKS_API_KEY
+#               * XSTOCKS_SECRET_KEY
 #             ... see the README for information about how to generate
 #             Spot API keys. Please also make sure to enable the
 #             following API permissions:

Makefile

@@ -10,7 +10,7 @@ UV ?= uv
 PYTHON := python
 PYTEST := $(UV) run pytest
 PYTEST_OPTS := -vv --junit-xml=pytest.xml
-PYTEST_COV_OPTS := $(PYTEST_OPTS) --cov=kraken --cov-report=xml:coverage.xml --cov-report=term
+PYTEST_COV_OPTS := $(PYTEST_OPTS) --cov=kraken --cov-report=xml:coverage.xml --cov-report=term-missing
 TEST_DIR := tests
 
 ## ======= M A K E F I L E - T A R G E T S =====================================

doc/01_introduction.rst

@@ -55,8 +55,8 @@ and documented.
   :class:`kraken.spot.SpotWSClient`.
 
 
-Disclaimer
-----------
+⚠️ Disclaimer
+-------------
 
 There is no guarantee that this software will work flawlessly at this or later
 times. Of course, no responsibility is taken for possible profits or losses.
@@ -66,8 +66,8 @@ investment. By using this software you release the author(s) from any liability
 regarding the use of this software.
 
 
-Features
---------
+🚀 Features
+-----------
 
 General:
 
@@ -92,8 +92,8 @@ Projects using this SDK:
 - https://github.com/btschwertfeger/kraken-rebalance-bot
 - https://github.com/btschwertfeger/python-kraken-sdk/network/dependents
 
-Important Notice
------------------
+📌 Important Notice
+-------------------
 
 **ONLY tagged releases are available at PyPI**. The content of the master branch
 may not match with the content of the latest release. - Please have a look at
@@ -105,8 +105,9 @@ on new releases.
 
 .. _section-troubleshooting:
 
-Troubleshooting
----------------
+💡 Troubleshooting
+------------------
+
 - Check if you downloaded and installed the **latest version** of the
   python-kraken-sdk.
 - Check the **permissions of your API keys** and the required permissions on the
@@ -123,8 +124,8 @@ Troubleshooting
 - The xStocks feature is not available globally. Please checkout Kraken's
   documentation to get to know the availability zones.
 
-References
-----------
+📜 References
+-------------
 
 - https://python-kraken-sdk.readthedocs.io/en/stable
 - https://docs.kraken.com/api/

doc/conf.py

@@ -82,11 +82,25 @@ def setup(app: Any) -> None:  # noqa: ARG001,ANN401
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "sphinx_rtd_theme"
-# html_static_path = ["_static"]
+html_theme = "furo"  # "sphinx_book_theme"  # "sphinx_rtd_theme"
+# html_static_path = ["_static"] # for images
 html_context = {
     "display_github": True,
     "github_user": "btschwertfeger",
     "github_repo": "python-kraken-sdk",
     "github_version": "master/doc/",
 }
+html_theme_options = {
+    # "sidebar_hide_name": True,
+    "light_css_variables": {
+        "color-brand-primary": "#336790",
+        "color-brand-content": "#336790",
+    },
+    "dark_css_variables": {
+        "color-brand-primary": "#E5B62F",
+        "color-brand-content": "#E5B62F",
+    },
+    "source_repository": "https://github.com/btschwertfeger/python-kraken-sdk/",
+    "source_branch": "master",
+    "source_directory": "doc/",
+}

doc/requirements.txt

@@ -1,13 +1,14 @@
+# sphinx-rtd-theme
 aiohttp
 asyncio>=3.4
 click~=8.1
 cloup~=3.0
+furo
 ipython
 nbsphinx
 orjson
 requests~=2.32
 setuptools_scm
 sphinx<8.2.0 # doesn't work with nbsphinx
 sphinx-click
-sphinx-rtd-theme
 websockets>=14.1

examples/xstocks_examples.py

@@ -40,7 +40,7 @@ def list_all_xstocks() -> None:
         CLIENT.request(
             "GET",
             "/0/public/AssetPairs",
-            params={"aclass_base": "tokenized_asset"},
+            params={"aclass_base": "tokenized_asset"},  # <- important!
             auth=False,
         ),
     )
@@ -59,7 +59,7 @@ def create_xstock_order() -> None:
                 "pair": "AAPLxUSD",
                 "price": "100.0",
                 "validate": True,
-                "asset_class": "tokenized_asset",
+                "asset_class": "tokenized_asset",  # <- important
             },
         ),
     )

tests/spot/test_xstocks_basic.py

@@ -11,6 +11,7 @@
 
 import pytest
 
+from kraken.exceptions import KrakenPermissionDeniedError
 from kraken.spot import Market, SpotClient, Trade
 
 
@@ -63,29 +64,30 @@ def test_create_order_trade_client(
         self: Self,
         xstocks_trade_client: Trade,
     ) -> None:
-        """
-        Checks if the response of the ``create_order`` is of type dict which
-        mean that the request was successful.
-        """
-        result = xstocks_trade_client.create_order(
-            **self.SAVE_ORDER,
-            side="buy",
-            extra_params={"asset_class": "tokenized_asset"},
-        )
-        assert "AAPLxUSD" in result.get("descr", {}).get("order", "")
+        """Checks if the endpoint is basically available."""
+        with pytest.raises(
+            KrakenPermissionDeniedError,
+            match=r".*API key doesn't have permission to make this request.*",
+        ):
+            xstocks_trade_client.create_order(
+                **self.SAVE_ORDER,
+                side="buy",
+                extra_params={"asset_class": "tokenized_asset"},
+            )
 
     @pytest.mark.spot_auth
     def test_create_order_spot_client(
         self: Self,
         xstocks_client: SpotClient,
     ) -> None:
-        """
-        Checks if the response of the ``create_order`` is of type dict which
-        mean that the request was successful.
-        """
-        result = xstocks_client.request(
-            "POST",
-            "/0/private/AddOrder",
-            params={"type": "buy", "asset_class": "tokenized_asset"} | self.SAVE_ORDER,
-        )
-        assert "AAPLxUSD" in result.get("descr", {}).get("order", "")
+        """Checks if the endpoint is basically available."""
+        with pytest.raises(
+            KrakenPermissionDeniedError,
+            match=r".*API key doesn't have permission to make this request.*",
+        ):
+            xstocks_client.request(
+                "POST",
+                "/0/private/AddOrder",
+                params={"type": "buy", "asset_class": "tokenized_asset"}
+                | self.SAVE_ORDER,
+            )