Apply hints suggested by the ruff linter (#165)

Author: btschwertfeger

.github/workflows/cicd.yaml

@@ -115,7 +115,7 @@ jobs:
       max-parallel: 1 # to avoid failing tests because of API Rate limits
       fail-fast: false
       matrix:
-        os: [ubuntu-latest] # only ubuntu since this takes to much time ATM
+        os: [ubuntu-latest, windows-latest]
         python-version: ["3.11"]
     with:
       os: ${{ matrix.os }}

.pre-commit-config.yaml

@@ -40,12 +40,24 @@ repos:
     rev: 23.7.0
     hooks:
       - id: black
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.0.2
+    hooks:
+      - id: prettier
   - repo: https://github.com/PyCQA/isort
     rev: 5.12.0
     hooks:
       - id: isort
         args:
           - --profile=black
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.1
+    hooks:
+      - id: ruff
+        args:
+          - --preview
+          - --fix
+          - --exit-non-zero-on-fix
   - repo: https://github.com/pycqa/flake8
     rev: 6.1.0
     hooks:
@@ -64,13 +76,6 @@ repos:
         args:
           - --rcfile=pyproject.toml
           - -d=R0801 # ignore duplicate code
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.0.287
-    hooks:
-      - id: ruff
-        args:
-          - --fix
-          - --exit-non-zero-on-fix
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.5.1
     hooks:
@@ -81,7 +86,3 @@ repos:
         args:
           - --config-file=pyproject.toml
           - kraken
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.0.2
-    hooks:
-      - id: prettier

Makefile

@@ -83,13 +83,13 @@ pre-commit:
 ## ruff 	Run ruff without fix
 .PHONY: ruff
 ruff:
-	ruff check .
+	ruff check --preview .
 
 ## ruff-fix 	Run ruff with fix
 ##
 .PHONY: ruff-fix
 ruff-fix:
-	ruff check . --fix
+	ruff check --fix --preview .
 
 ## changelog	Generate the changelog
 ##

README.md

@@ -4,7 +4,7 @@
 
 [![GitHub](https://badgen.net/badge/icon/github?icon=github&label)](https://github.com/btschwertfeger/python-kraken-sdk)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-orange.svg)](https://www.gnu.org/licenses/gpl-3.0)
-[![Generic badge](https://img.shields.io/badge/python-3.11-blue.svg)](https://shields.io/)
+[![Generic badge](https://img.shields.io/badge/python-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)
@@ -22,18 +22,21 @@
 
 > ⚠️ This is an unofficial collection of REST and websocket clients for Spot and
 > Futures trading on the Kraken cryptocurrency exchange using Python. Payward
-> Ltd. and Kraken are in no way associated with the authors of this module and
+> Ltd. and Kraken are in no way associated with the authors of this package and
 > documentation.
-
----
+>
+> Please note that this project is independent and not endorsed by Kraken or
+> Payward Ltd. Users should be aware that they are using third-party software,
+> and the authors of this project are not responsible for any issues, losses, or
+> risks associated with its usage.
 
 ## 📌 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.
 This software probably has some errors in it, so use it at your own risk. Also
 no one should be motivated or tempted to invest assets in speculative forms of
-investment. By using this software you release the authors from any liability
+investment. By using this software you release the author(s) from any liability
 regarding the use of this software.
 
 ---
@@ -44,7 +47,7 @@ Available Clients:
 
 - Spot REST Clients
 - Spot Websocket Clients (Websocket API v1 and v2)
-- Spot Orderbook Client (Websocket API v1 and v2)
+- Spot Orderbook Clients (Websocket API v1 and v2)
 - Futures REST Clients
 - Futures Websocket Client
 

docs/conf.py

@@ -8,10 +8,12 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 # pylint: disable=invalid-name
 
-"""This module is the configuration for the Sphinx documentation building process"""
+"""
+This module is the configuration for the Sphinx documentation building process.
+"""
 
-import os
 import sys
+from pathlib import Path
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
@@ -21,11 +23,12 @@
 author = "Benjamin Thomas Schwertfeger"
 
 # to import the package
-sys.path.insert(0, os.path.abspath(".."))
+parent_directory: Path = Path("..").resolve()
+sys.path.insert(0, str(parent_directory))
 
 rst_epilog = ""
 # Read link all targets from file
-with open("links.rst", encoding="utf-8") as f:
+with Path("links.rst").open(encoding="utf-8") as f:
     rst_epilog += f.read()
 
 # -- General configuration ---------------------------------------------------

docs/index.rst

@@ -21,14 +21,15 @@ Welcome to Python Kraken SDK's documentation!
 
    src/introduction.rst
    src/getting_started/getting_started.rst
+   src/examples/rest_example_usage.rst
    src/examples/trading_bot_templates.rst
-   src/issues.rst
    src/spot/rest.rst
    src/spot/websockets.rst
    src/futures/rest.rst
    src/futures/websockets.rst
    src/base_api/base_api.rst
-   src/krakenexceptions/krakenexceptions.rst
+   src/exceptions/exceptions.rst
+   src/issues.rst
    src/about/license.rst
 
 Indices and tables

docs/links.rst

@@ -1,7 +1,7 @@
 .. -*- coding: utf-8 -*-
 .. Copyright (C) 2023 Benjamin Thomas Schwertfeger
 .. GitHub: https://github.com/btschwertfeger
-
+..
 .. LINKS
 
 .. _Kraken:                            https://kraken.com
@@ -17,7 +17,7 @@
 .. |License badge|             image:: https://img.shields.io/badge/License-GPLv3-orange.svg
                               :target: https://www.gnu.org/licenses/gpl-3.0
                               :alt:    License
-.. |PyVersions badge|          image:: https://img.shields.io/badge/python-3.11-blue.svg
+.. |PyVersions badge|          image:: https://img.shields.io/badge/python-3.11+-blue.svg
                               :target: https://github.com/btschwertfeger/python-kraken-sdk
                               :alt:    Supported Python Versions
 .. |Downloads badge|           image:: https://static.pepy.tech/personalized-badge/python-kraken-sdk?period=total&units=abbreviation&left_color=grey&right_color=orange&left_text=downloads

docs/src/base_api/base_api.rst

@@ -6,7 +6,7 @@ The Base Clients and Internals
 ==============================
 
 The following classes and data structures are listed for completeness. Please
-avoid using them, since these are internals and may change without any warning.
+avoid using them since these are internals and may change without any warning.
 
 They are the base classes for Spot and Futures REST and websocket clients.
 

docs/src/examples/rest_example_usage.rst

@@ -0,0 +1,24 @@
+.. -*- coding: utf-8 -*-
+.. Copyright (C) 2023 Benjamin Thomas Schwertfeger
+.. GitHub: https://github.com/btschwertfeger
+
+.. _section-examples:
+
+Usage Examples
+==============
+
+The repository of the `python-kraken-sdk`_ provides some example scripts that
+demonstrate some of the implemented methods. Please see the sections listed
+below.
+
+.. toctree::
+    :maxdepth: 2
+
+    rest_ws_samples/spot_rest_examples.rst
+    rest_ws_samples/spot_ws_examples.rst
+    rest_ws_samples/futures_ws_examples.rst
+    rest_ws_samples/futures_rest_examples.rst
+
+Third-party projects that use the SDK are listed below.
+
+* https://github.com/btschwertfeger/kraken-rebalance-bot

docs/src/examples/rest_ws_samples/futures_rest_examples.rst

@@ -0,0 +1,22 @@
+
+.. -*- coding: utf-8 -*-
+.. Copyright (C) 2023 Benjamin Thomas Schwertfeger
+.. GitHub: https://github.com/btschwertfeger
+
+Futures Rest
+------------
+
+The examples presented below serve to demonstrate the usage of the Futures
+REST clients provided by `python-kraken-sdk`_ to access `Kraken`_'s REST API.
+
+For questions, feedback, additions, suggestions for improvement or problems
+`python-kraken-sdk/discussions`_ or `python-kraken-sdk/issues`_ may be helpful.
+
+These examples are not maintained on a regular basis. They serve only for
+demonstration purposes - make sure to checkout the documentation of the
+individual functions.
+
+.. literalinclude:: ../../../../examples/futures_examples.py
+   :language: python
+   :linenos:
+   :caption: Example usages of the REST clients