Update the documentation (#339)

Author: btschwertfeger

.github/codecov.yml

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 coverage:
   ##    Status checks in PR
   ##

.github/dependabot.yaml

@@ -1,12 +1,7 @@
+# -*- coding: utf-8 -*-
 version: 2
 updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "weekly"
-  - package-ecosystem: "pip"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-    ignore:
-      - dependency-name: "ruff"

.github/self-review.md

@@ -8,8 +8,8 @@ must be addressed before a PR will be accepted.
       [python-kraken-sdk](https://github.com/btschwertfeger/python-kraken-sdk).
       Most issues will be resolve through the pre-commit hooks.
 - [ ] Also take care to follow the community guidelines and the [Code of
-      Conduct](./.github/CODE_OF_CONDUCT.md).
-- [ ] Self-review your changes to detect typos, syntax errors and any kind of
+      Conduct](./CODE_OF_CONDUCT.md).
+- [ ] Self-review your changes to detect typos, syntax errors, and any kind of
       unwanted behavior.
 - [ ] If you changed the source code you have to **ensure that all unit tests
       run through**. If you added a new function you also have to **write a
@@ -20,9 +20,8 @@ must be addressed before a PR will be accepted.
 - [ ] Take your time to prepare your code before creating a PR. A good PR will
       save a lot of time for everyone.
 - [ ] There are several workflows/actions within this repository. Relevant
-      workflows must be run successfully within your fork. In the following
-      these workflows are listed, but **please also read the respective workflow
-      files to get further information**. Actions must be enabled within the
-      fork, so that workflows can run within the context of a PR.
-  - CI/CD (`cicd.yaml`): Can be used to run all actions at once - but requires
-    having API keys for Spot, Futures and the Futures demo environment.
+      workflows must be run successfully within your fork. Actions must be
+      enabled within the fork, so that workflows can run within the context of a
+      PR. [cicd.yaml](./workflows/cicd.yaml) can be used to run all actions at
+      once - but requires having API keys for Spot, Futures and the Futures demo
+      environment.

.github/workflows/_codeql.yaml

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # For most projects, this workflow file will not need changing; you simply need
 # to commit it to your repository.
 #

.github/workflows/cicd.yaml

@@ -1,5 +1,5 @@
-# -*- coding: utf-8 -*- Copyright (C)
-# 2023 Benjamin Thomas Schwertfeger
+# -*- coding: utf-8 -*-
+# Copyright (C) 2023 Benjamin Thomas Schwertfeger
 # GitHub: https://github.com/btschwertfeger
 #
 # Workflow to apply pre-commit, build, test and upload the package to the test
@@ -55,7 +55,7 @@ on:
     types: [opened, synchronize, reopened]
     branches: ["**"]
 
-# only run once due to API rate limits
+# Only run once due to API rate limits
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true

.github/workflows/scorecard.yml

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # This workflow uses actions that are not certified by GitHub. They are provided
 # by a third-party and are governed by separate terms of service, privacy
 # policy, and support documentation.

CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## [Unreleased](https://github.com/btschwertfeger/python-kraken-sdk/tree/HEAD)
+
+[Full Changelog](https://github.com/btschwertfeger/python-kraken-sdk/compare/v3.1.3...HEAD)
+
+Uncategorized merged pull requests:
+
+- Bump step-security/harden-runner from 2.10.2 to 2.10.3 [\#337](https://github.com/btschwertfeger/python-kraken-sdk/pull/337) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump github/codeql-action from 3.28.0 to 3.28.1 [\#336](https://github.com/btschwertfeger/python-kraken-sdk/pull/336) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+## [v3.1.3](https://github.com/btschwertfeger/python-kraken-sdk/tree/v3.1.3) (2025-01-05)
+
+[Full Changelog](https://github.com/btschwertfeger/python-kraken-sdk/compare/v3.1.2...v3.1.3)
+
+**Fixed bugs:**
+
+- Resolve "Long lasting REST sessions get terminated" [\#334](https://github.com/btschwertfeger/python-kraken-sdk/pull/334) ([btschwertfeger](https://github.com/btschwertfeger))
+
+Uncategorized merged pull requests:
+
+- Bump codecov/codecov-action from 5.1.1 to 5.1.2 [\#332](https://github.com/btschwertfeger/python-kraken-sdk/pull/332) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump github/codeql-action from 3.27.9 to 3.28.0 [\#331](https://github.com/btschwertfeger/python-kraken-sdk/pull/331) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump astral-sh/setup-uv from 4 to 5 [\#330](https://github.com/btschwertfeger/python-kraken-sdk/pull/330) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump github/codeql-action from 3.27.7 to 3.27.9 [\#329](https://github.com/btschwertfeger/python-kraken-sdk/pull/329) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump pypa/gh-action-pypi-publish from 1.12.2 to 1.12.3 [\#328](https://github.com/btschwertfeger/python-kraken-sdk/pull/328) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump github/codeql-action from 3.27.5 to 3.27.7 [\#327](https://github.com/btschwertfeger/python-kraken-sdk/pull/327) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump codecov/codecov-action from 5.0.7 to 5.1.1 [\#323](https://github.com/btschwertfeger/python-kraken-sdk/pull/323) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Update egress policy in CI [\#326](https://github.com/btschwertfeger/python-kraken-sdk/pull/326) ([btschwertfeger](https://github.com/btschwertfeger))
+- Update egress rules in CI [\#322](https://github.com/btschwertfeger/python-kraken-sdk/pull/322) ([btschwertfeger](https://github.com/btschwertfeger))
+
 ## [v3.1.2](https://github.com/btschwertfeger/python-kraken-sdk/tree/v3.1.2) (2024-11-26)
 
 [Full Changelog](https://github.com/btschwertfeger/python-kraken-sdk/compare/v3.1.1...v3.1.2)

README.md

@@ -67,6 +67,11 @@ Documentation:
 - [https://python-kraken-sdk.readthedocs.io/en/stable](https://python-kraken-sdk.readthedocs.io/en/stable)
 - [https://python-kraken-sdk.readthedocs.io/en/latest](https://python-kraken-sdk.readthedocs.io/en/latest)
 
+Projects using this SDK:
+
+- https://github.com/btschwertfeger/kraken-infinity-grid
+- https://github.com/btschwertfeger/kraken-rebalance-bot
+
 ---
 
 ## ❗️ Attention

doc/conf.py

@@ -74,6 +74,6 @@ def setup(app: Any) -> None:  # noqa: ARG001,ANN401
     "display_github": True,
     "github_user": "btschwertfeger",
     "github_repo": "python-kraken-sdk",
-    "github_version": "master/docs/",
+    "github_version": "master/doc/",
 }
 # html_theme_options = {"rightsidebar": "true", "relbarbgcolor": "black"}

doc/examples/rest_example_usage.rst

@@ -16,6 +16,11 @@ The repository of the `python-kraken-sdk`_ provides some example scripts that
 demonstrate some of the implemented methods. Please see the sections listed
 below.
 
+Projects that use the SDK are listed below:
+
+* https://github.com/btschwertfeger/kraken-infinity-grid
+* https://github.com/btschwertfeger/kraken-rebalance-bot
+
 .. toctree::
     :maxdepth: 2
 
@@ -24,7 +29,3 @@ below.
     market_client_example.ipynb
     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