Project Housekeeping (#184)

btschwertfeger · Jan 21, 2024 · 66f1bda · 66f1bda
1 parent 24b3e60
commit 66f1bda
Show file tree

Hide file tree

Showing 42 changed files with 129 additions and 117 deletions.
diff --git a/.github/workflows/_build_doc.yaml b/.github/workflows/_build_doc.yaml
@@ -32,7 +32,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -r docs/requirements.txt
+          python -m pip install -r doc/requirements.txt
 
       - name: Build the documentation
-        run: cd docs && make html
+        run: cd doc && make html
diff --git a/.github/workflows/cicd.yaml b/.github/workflows/cicd.yaml
@@ -47,6 +47,8 @@ on:
   push:
     branches:
       - "**"
+  schedule:
+    - cron: "24 7 */7 * *"
 
 concurrency:
   group: CICD-${{ github.ref }}

diff --git a/.gitignore b/.gitignore
@@ -36,16 +36,6 @@ share/python-wheels/
 *.whl
 MANIFEST
 
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
 # Unit test / coverage reports
 htmlcov/
 .tox/
@@ -66,19 +56,6 @@ pytest.xml
 *.mo
 *.pot
 
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
 # Sphinx documentation
 docs/_build/
 
@@ -88,30 +65,6 @@ target/
 # Jupyter Notebook
 .ipynb_checkpoints
 
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-.python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
 # Environments
 .env
 .venv
@@ -121,13 +74,6 @@ ENV/
 env.bak/
 venv.bak/
 
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
 # mkdocs documentation
 /site
 
@@ -137,9 +83,6 @@ venv.bak/
 dmypy.json
 mypy.xml
 
-# Pyre type checker
-.pyre/
-
 # misc
 del*.py
 del/

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -5,7 +5,7 @@
 
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.7
+    rev: v0.1.13
     hooks:
       - id: ruff
         args:
@@ -21,7 +21,7 @@ repos:
           - --show-source
           - --statistics
   - repo: https://github.com/pycqa/pylint
-    rev: v3.0.1
+    rev: v3.0.2
     hooks:
       - id: pylint
         name: pylint
@@ -31,16 +31,16 @@ repos:
           - --rcfile=pyproject.toml
           - -d=R0801 # ignore duplicate code
           - -j=4
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.7.1
-    hooks:
-      - id: mypy
-        name: mypy
-        additional_dependencies: ["types-requests"]
-        pass_filenames: false
-        args:
-          - --config-file=pyproject.toml
-          - kraken
+  # - repo: https://github.com/pre-commit/mirrors-mypy # FIXME
+  #   rev: v1.8.0
+  #   hooks:
+  #     - id: mypy
+  #       name: mypy
+  #       additional_dependencies: ["types-requests"]
+  #       pass_filenames: false
+  #       args:
+  #         - --config-file=pyproject.toml
+  #         - kraken
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -13,7 +13,7 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: docs/conf.py
+  configuration: doc/conf.py
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
 # formats:
@@ -22,4 +22,4 @@ sphinx:
 # Optionally declare the Python requirements required to build your docs
 python:
   install:
-    - requirements: docs/requirements.txt
+    - requirements: doc/requirements.txt
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,26 @@
 # Changelog
 
+## [Unreleased](https://github.com/btschwertfeger/python-kraken-sdk/tree/HEAD)
+
+[Full Changelog](https://github.com/btschwertfeger/python-kraken-sdk/compare/v2.1.1...HEAD)
+
+**Fixed bugs:**
+
+- Futures re-subscribe to authenticated feed doesn't work [\#179](https://github.com/btschwertfeger/python-kraken-sdk/issues/179)
+
+## [v2.1.1](https://github.com/btschwertfeger/python-kraken-sdk/tree/v2.1.1) (2023-12-18)
+
+[Full Changelog](https://github.com/btschwertfeger/python-kraken-sdk/compare/v2.1.0...v2.1.1)
+
+**Fixed bugs:**
+
+- Futures re-subscribe to authenticated feed doesn't work [\#179](https://github.com/btschwertfeger/python-kraken-sdk/issues/179)
+- Fix "Futures re-subscribe to authenticated feed doesn't work" [\#180](https://github.com/btschwertfeger/python-kraken-sdk/pull/180) ([btschwertfeger](https://github.com/btschwertfeger))
+
+**Closed issues:**
+
+- Add support for trailing-stop and trailing-stop-limit order types for Spot REST [\#181](https://github.com/btschwertfeger/python-kraken-sdk/issues/181)
+
 ## [v2.1.0](https://github.com/btschwertfeger/python-kraken-sdk/tree/v2.1.0) (2023-12-07)
 
 [Full Changelog](https://github.com/btschwertfeger/python-kraken-sdk/compare/v2.0.0...v2.1.0)

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -2,4 +2,11 @@
 # Copyright (C) 2023 Benjamin Thomas Schwertfeger
 # GitHub: https://github.com/btschwertfeger
 #
+
 include README.md LICENSE pyproject.toml
+
+graft kraken
+
+prune doc
+prune examples
+prune tests
diff --git a/Makefile b/Makefile
@@ -2,6 +2,7 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2023 Benjamin Thomas Schwertfeger
 # GitHub: https://github.com/btschwertfeger
+#
 
 PYTHON := venv/bin/python
 PYTEST := $(PYTHON) -m pytest
@@ -27,7 +28,7 @@ rebuild: clean build
 ##
 .PHONY: doc
 doc:
-	cd docs && make html
+	cd doc && make html
 
 ## ======= I N S T A L L A T I O N =======
 ## install	Install the package
@@ -47,7 +48,7 @@ dev:
 ##
 .PHONY: test
 test:
-	@rm *.log || true
+	@rm .cache/tests/*.log || true
 	$(PYTEST) $(PYTEST_OPTS) $(TEST_DIR)
 
 .PHONY: tests
@@ -57,14 +58,14 @@ tests: test
 ##
 .PHONY: wip
 wip:
-	@rm *.log || true
+	@rm .cache/tests/*.log || true
 	$(PYTEST) -m "wip" -vv $(TEST_DIR)
 
 ## coverage		Run all tests and generate the coverage report
 ##
 .PHONY: coverage
 coverage:
-	@rm *.log || true
+	@rm .cache/tests/*.log || true
 	$(PYTEST) $(PYTEST_COV_OPTS) $(TEST_DIR)
 
 ## doctest	Run the documentation related tests
@@ -110,17 +111,23 @@ changelog:
 ##
 .PHONY: clean
 clean:
-	rm -rf build/ dist/ \
-		python_kraken_sdk.egg-info \
-		docs/_build \
+	rm -rf .cache \
 		.vscode \
-		.cache
+		dist/ \
+		doc/_build \
+		python_kraken_sdk.egg-info \
+	    build/
 
-	rm -f .coverage coverage.xml pytest.xml mypy.xml \
+	rm -f .coverage \
+		*.csv \
+		*.log \
+		*.zip \
+		coverage.xml \
 		kraken/_version.py \
-		*.log *.csv *.zip \
-		tests/*.zip tests/.csv \
-		python_kraken_sdk-*.whl
+		mypy.xml \
+		pytest.xml \
+		python_kraken_sdk-*.whl \
+		tests/*.zip
 
 	find tests -name "__pycache__" | xargs rm -rf
 	find kraken -name "__pycache__" | xargs rm -rf

diff --git a/README.md b/README.md
@@ -463,7 +463,16 @@ if __name__ == "__main__":
 
 # 🆕 Contributions
 
-… are welcome! - Please have a look at [CONTRIBUTION.md](./CONTRIBUTING.md).
+… are welcome - but:
+
+- First check if there is an existing issue or PR that addresses your
+  problem/solution. If not - create one first - before creating a PR.
+- Typo fixes, project configuration, CI, documentation or style/formatting PRs
+  will be rejected. Please create an issue for that.
+- PRs must provide a reasonable, easy to understand and maintain solution for an
+  existing problem. You may want to propose a solution when creating the issue
+  to discuss the approach before creating a PR.
+- Please have a look at [CONTRIBUTION.md](./CONTRIBUTING.md).
 
 ---
 
@@ -490,12 +499,11 @@ if __name__ == "__main__":
 
 - The version scheme is `<Major>.<Minor>.<Service Level>` where:
 
-  - **Major** will affect everything and there will be breaking changes in any
-    case. This could be for example a change to Python 3.11+ only.
+  - **Major** will affect everything and there will be breaking changes.
   - **Minor** introduces features and enhancements which may bring breaking
     changes in some cases. These breaking changes could be renaming or addition
     of parameters, change in order of parameters or even renaming a function.
-  - **Service Level** includes bug fixes, documentation or CI related changes.
+  - **Service Level** includes bug fixes, documentation and CI related changes.
 
 - Coding standards are not always followed to make arguments and function names
   as similar as possible to those of the Kraken API documentations.

diff --git a/docs/Makefile → doc/Makefile b/docs/Makefile → doc/Makefile
diff --git a/docs/conf.py → doc/conf.py b/docs/conf.py → doc/conf.py
diff --git a/docs/index.rst → doc/index.rst b/docs/index.rst → doc/index.rst
diff --git a/docs/links.rst → doc/links.rst b/docs/links.rst → doc/links.rst
diff --git a/docs/make.bat → doc/make.bat b/docs/make.bat → doc/make.bat
diff --git a/docs/requirements.txt → doc/requirements.txt b/docs/requirements.txt → doc/requirements.txt
diff --git a/docs/src/about/license.rst → doc/src/about/license.rst b/docs/src/about/license.rst → doc/src/about/license.rst
diff --git a/docs/src/base_api/base_api.rst → doc/src/base_api/base_api.rst b/docs/src/base_api/base_api.rst → doc/src/base_api/base_api.rst
diff --git a/docs/src/examples/rest_example_usage.rst → doc/src/examples/rest_example_usage.rst b/docs/src/examples/rest_example_usage.rst → doc/src/examples/rest_example_usage.rst
diff --git a/...rest_ws_samples/futures_rest_examples.rst → ...rest_ws_samples/futures_rest_examples.rst b/...rest_ws_samples/futures_rest_examples.rst → ...rest_ws_samples/futures_rest_examples.rst
diff --git a/...s/rest_ws_samples/futures_ws_examples.rst → ...s/rest_ws_samples/futures_ws_examples.rst b/...s/rest_ws_samples/futures_ws_examples.rst → ...s/rest_ws_samples/futures_ws_examples.rst
diff --git a/...es/rest_ws_samples/spot_rest_examples.rst → ...es/rest_ws_samples/spot_rest_examples.rst b/...es/rest_ws_samples/spot_rest_examples.rst → ...es/rest_ws_samples/spot_rest_examples.rst
diff --git a/...ples/rest_ws_samples/spot_ws_examples.rst → ...ples/rest_ws_samples/spot_ws_examples.rst b/...ples/rest_ws_samples/spot_ws_examples.rst → ...ples/rest_ws_samples/spot_ws_examples.rst
diff --git a/docs/src/examples/trading_bot_templates.rst → doc/src/examples/trading_bot_templates.rst b/docs/src/examples/trading_bot_templates.rst → doc/src/examples/trading_bot_templates.rst
diff --git a/...ng_bot_templates/futures_bot_template.rst → ...ng_bot_templates/futures_bot_template.rst b/...ng_bot_templates/futures_bot_template.rst → ...ng_bot_templates/futures_bot_template.rst
diff --git a/...ding_bot_templates/spot_bot_templates.rst → ...ding_bot_templates/spot_bot_templates.rst b/...ding_bot_templates/spot_bot_templates.rst → ...ding_bot_templates/spot_bot_templates.rst
diff --git a/.../trading_bot_templates/spot_orderbook.rst → .../trading_bot_templates/spot_orderbook.rst b/.../trading_bot_templates/spot_orderbook.rst → .../trading_bot_templates/spot_orderbook.rst
diff --git a/docs/src/exceptions/exceptions.rst → doc/src/exceptions/exceptions.rst b/docs/src/exceptions/exceptions.rst → doc/src/exceptions/exceptions.rst
diff --git a/docs/src/futures/rest.rst → doc/src/futures/rest.rst b/docs/src/futures/rest.rst → doc/src/futures/rest.rst
diff --git a/docs/src/futures/websockets.rst → doc/src/futures/websockets.rst b/docs/src/futures/websockets.rst → doc/src/futures/websockets.rst
diff --git a/docs/src/getting_started/getting_started.rst → doc/src/getting_started/getting_started.rst b/docs/src/getting_started/getting_started.rst → doc/src/getting_started/getting_started.rst
diff --git a/docs/src/introduction.rst → doc/src/introduction.rst b/docs/src/introduction.rst → doc/src/introduction.rst
diff --git a/docs/src/issues.rst → doc/src/issues.rst b/docs/src/issues.rst → doc/src/issues.rst
diff --git a/docs/src/spot/rest.rst → doc/src/spot/rest.rst b/docs/src/spot/rest.rst → doc/src/spot/rest.rst
diff --git a/docs/src/spot/websockets.rst → doc/src/spot/websockets.rst b/docs/src/spot/websockets.rst → doc/src/spot/websockets.rst
diff --git a/kraken/futures/user.py b/kraken/futures/user.py
@@ -789,9 +789,9 @@ def get_open_positions(
             :linenos:
             :caption: Futures Trade: Get the user's open positions
 
-            >>> from kraken.futures import Trade
-            >>> trade = Trade(key="api-key", secret="secret-key")
-            >>> trade.get_open_positions()
+            >>> from kraken.futures import User
+            >>> user = User(key="api-key", secret="secret-key")
+            >>> user.get_open_positions()
             {
                 'result': 'success',
                 'openPositions': [
@@ -834,9 +834,9 @@ def get_open_orders(
             :linenos:
             :caption: Futures Trade: Get open orders
 
-            >>> from kraken.futures import Trade
-            >>> trade = Trade(key="api-key", secret="secret-key")
-            >>> trade.get_open_orders()
+            >>> from kraken.futures import User
+            >>> user = User(key="api-key", secret="secret-key")
+            >>> user.get_open_orders()
             {
                 'result': 'success',
                 'openOrders': [{

diff --git a/pyproject.toml b/pyproject.toml
@@ -118,7 +118,7 @@ python_version = "3.11"
 
 # junit_xml = "mypy.xml"
 files = ["kraken/**/*.py"]
-exclude = ["tests/*/*.py"]
+exclude = ["tests/**/*.py"]
 
 cache_dir = ".cache/mypy"
 sqlite_cache = true
@@ -221,10 +221,10 @@ select = [
   "FBT",   # boolean trap
   "PTH",   # flake8-use-pathlib
   "FURB",  # refurb
-  # "ERA",   # eradicate # commented-out code
+  # "ERA", # eradicate # commented-out code
   # "FIX", # flake8-fixme
   # "TD",  # flake8-todos
-  # "TRY",  # tryceratops # specify exception messages in class; not important
+  # "TRY", # tryceratops # specify exception messages in class; not important
 ]
 fixable = [
   "I",

diff --git a/tests/futures/helper.py b/tests/futures/helper.py
@@ -14,6 +14,9 @@
 
 from kraken.futures import KrakenFuturesWSClient
 
+CACHE_DIR: Path = Path(__file__).resolve().parent.parent.parent / ".cache" / "tests"
+CACHE_DIR.mkdir(parents=True, exist_ok=True)
+
 
 def is_success(value: Any) -> bool:
     """
@@ -66,10 +69,16 @@ async def on_message(
 
         log: str = ""
         try:
-            with Path("futures_ws.log").open("r", encoding="utf-8") as logfile:
+            with Path(CACHE_DIR / "futures_ws.log").open(
+                mode="r",
+                encoding="utf-8",
+            ) as logfile:
                 log = logfile.read()
         except FileNotFoundError:
             pass
 
-        with Path("futures_ws.log").open("w", encoding="utf-8") as logfile:
+        with Path(CACHE_DIR / "futures_ws.log").open(
+            mode="w",
+            encoding="utf-8",
+        ) as logfile:
             logfile.write(f"{log}\n{message}")