bitvavo-api-upgraded 1.17.0__tar.gz → 1.17.1__tar.gz

{bitvavo_api_upgraded-1.17.0 → bitvavo_api_upgraded-1.17.1}/.gitignore

@@ -1,6 +1,7 @@
 /*
 
 # dirs
+!.vscode/
 !.github/
 !requirements/
 !scripts/

bitvavo_api_upgraded-1.17.1/.python-version

@@ -0,0 +1,5 @@
+3.9.21
+3.10.16
+3.11.11
+3.12.8
+3.13.1

bitvavo_api_upgraded-1.17.1/.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

{bitvavo_api_upgraded-1.17.0 → bitvavo_api_upgraded-1.17.1}/CHANGELOG.md

@@ -1,5 +1,49 @@
 # Changelog
 
+v1.17.1 - 2024-12-24
+
+Turns out the settings weren't working as expected, so I switched
+`python-decouple` out from `pydantic-settings`, which (once setup) works a lot
+smoother. Keywords being "once setup", because holy smokes is it a paint to do
+the initial setup - figure out how the hell you need to validate values before
+or after, etc.
+
+Just don't forget to create a local `.env` with `BITVAVO_APIKEY` and
+`BITVAVO_APISECRET` keys.
+
+### Added
+
+- `pydantic-settings`: a powerful and modern way of loading your settings.
+  - we're using `.env` here, but it can be setup for `.json` or `.yaml` -
+    whatever you fancy.
+  - because of `pydantic-settings` you can now also do
+    `Bitvavo(bitvavo_settings.model_dump())`, and import bitvavo_settings from
+    `settings.py`
+- add pydantic plugin for mypy, so mypy stops complaining about pydantic.
+- vscode settings to disable `pytest-cov` during debugging. If you do not
+  disable `pytest-cov` during debugging, it still silently break your debugging
+  system...
+- you can now import BitvavoApiUpgradedSettings and BitvavoSettings directly
+  from `bitvavo_api_upgraded`
+
+### Changed
+
+- `python-decouple` replaced by `pydantic-settings` - see Added and Removed
+- `pytest-cov` relegated to enable coverage via vscode - friendship with
+  `pytest-cov` ended. `coverage.py` is my best friend.
+  - reason for this is because `pytest-cov` fucked with the ability to debug
+    within vscode.
+- bump minor Python versions
+
+### Removed
+
+- `python-decouple` - this lacked type hinting since forever, not to mention it
+  didn't throw errors if missing...
+
+### Fixed
+
+- a bunch of tests that have VERY flaky output from the API >:(
+
 ## v1.17.0 - 2024-11-24
 
 Integrate all changes from Bitvavo's `v1.1.1` to `v1.4.2` lib versions,

{bitvavo_api_upgraded-1.17.0 → bitvavo_api_upgraded-1.17.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: bitvavo-api-upgraded
-Version: 1.17.0
+Version: 1.17.1
 Summary: A unit-tested fork of the Bitvavo API
 Project-URL: homepage, https://github.com/Thaumatorium/bitvavo-api-upgraded
 Project-URL: repository, https://github.com/Thaumatorium/bitvavo-api-upgraded
@@ -9,6 +9,7 @@ Author: Bitvavo BV (original code)
 Author-email: NostraDavid <55331731+NostraDavid@users.noreply.github.com>
 Maintainer-email: NostraDavid <55331731+NostraDavid@users.noreply.github.com>
 License: ISC License
+License-File: LICENSE.txt
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Framework :: Pytest
@@ -27,7 +28,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: >=3.9
-Requires-Dist: python-decouple==3.*,>=3.5
+Requires-Dist: pydantic-settings==2.*,>=2.6
 Requires-Dist: requests==2.*,>=2.26
 Requires-Dist: structlog==24.*,>=21.5
 Requires-Dist: websocket-client==1.*,>=1.2

{bitvavo_api_upgraded-1.17.0 → bitvavo_api_upgraded-1.17.1}/README.pypi.md

@@ -41,6 +41,10 @@ some handy settings there.
 Here is an example list of the settings for this lib:
 
 ```ini
+# needed for the private part of the API
+BITVAVO_APIKEY=
+BITVAVO_APISECRET=
+
 BITVAVO_API_UPGRADED_LOG_LEVEL=INFO  # Set the lib's log level
 BITVAVO_API_UPGRADED_LOG_EXTERNAL_LEVEL=WARNING  # Set the libs that are used by *this* lib's log level
 BITVAVO_API_UPGRADED_LAG=50  # the time difference between the server and your local time (you'll have to calculate this yourself - tip: use the bitvavo.time() functionality in a separate script)

{bitvavo_api_upgraded-1.17.0 → bitvavo_api_upgraded-1.17.1}/pyproject.toml

@@ -1,7 +1,7 @@
 # https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
 [project]
 name = "bitvavo-api-upgraded"
-version = "1.17.0"
+version = "1.17.1"
 description = "A unit-tested fork of the Bitvavo API"
 readme = "README.md"
 requires-python = ">=3.9"
@@ -33,10 +33,10 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "python-decouple==3.*, >=3.5",  # to handle sematic versioning
-    "requests==2.*, >=2.26",        # to make http requests
-    "structlog==24.*, >=21.5",      # for logging
-    "websocket-client==1.*, >=1.2", # something something websocket
+    "pydantic-settings==2.*, >=2.6", # to handle settings
+    "requests==2.*, >=2.26",         # to make http requests
+    "structlog==24.*, >=21.5",       # for logging
+    "websocket-client==1.*, >=1.2",  # something something websocket
 ]
 
 [project.urls]
@@ -44,18 +44,16 @@ homepage = "https://github.com/Thaumatorium/bitvavo-api-upgraded"
 repository = "https://github.com/Thaumatorium/bitvavo-api-upgraded"
 changelog = "https://github.com/Thaumatorium/bitvavo-api-upgraded/blob/master/CHANGELOG.md"
 
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[dependency-groups]
-dev = [
+# https://docs.astral.sh/uv/
+[tool.uv]
+dev-dependencies = [
     "bump-my-version>=0.28.1",   # for version management of the lib
     "mdformat>=0.7.11",          # for formatting markdown (.md) documents
     "mkdocs>=1.2.3",             # for markdown documentation
     "mypy>=1.13",                # amazing linter
     "pre-commit>=2.15.0",        # for running hooks before committing code
-    "pytest-cov>=1",             # vscode has native coverage, but when using pytest, vscode will presume you'll use pytest-cov
+    "coverage[toml]>=7.6.9",     # for checking coverage; use this in tox vs pytest-cov, since pytest-cov does NOT play well with vscode
+    "pytest-cov>=1",             # though this was the initial choice over coverage.py, turns out it fucks with vscode debugging, so now it only exists so we can still run tests with coverage within vscode
     "pytest-integration>=0.2.2", # for @mark additions
     "pytest-mock>=3.6.1",        # for the `mocker` MockerFixture fixture
     "pytest>=6.2.4",             # you can run `pytest` to run the unit tests; will also be run by `tox` :)
@@ -65,8 +63,12 @@ dev = [
     "types-requests>=2.26.2",    # typing for mypy
 ]
 
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
 [tool.bumpversion]
-current_version = "1.17.0"
+current_version = "1.17.1"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"
@@ -96,7 +98,31 @@ filename = "CHANGELOG.md"
 search = "$UNRELEASED"
 replace = "v{new_version} - {now:%Y-%m-%d}"
 
-# https://mypy.readthedocs.io/en/stable/config_file.html#confval-exclude
+[tool.coverage.run]
+branch = true
+source = ["src"]
+parallel = true
+relative_files = true
+
+[tool.coverage.paths]
+source = ["src/bitvavo_api_upgraded"]
+omit = [
+    "*/tests/*",     # Omit test files
+    "*/__init__.py", # Optionally omit __init__ files
+]
+[tool.coverage.report]
+fail_under = 50
+precision = 0
+show_missing = true
+skip_covered = true
+skip_empty = true
+sort = "Cover"
+exclude_lines = [
+    "pragma: no cover",           # Common usage for excluding lines from coverage
+    "if __name__ == .__main__.:", # Skip lines commonly used in scripts
+]
+
+# https://mypy.readthedocs.io/en/stable/config_file.html
 [tool.mypy]
 # created for mypy 1.13
 
@@ -188,7 +214,7 @@ skip_version_check = false
 skip_cache_mtime_checks = false
 
 # Advanced options
-plugins = []
+plugins = ["pydantic.mypy"]
 pdb = false
 show_traceback = false
 raise_exceptions = false
@@ -228,31 +254,6 @@ verbosity = 0
 # ]
 # ignore_missing_imports = true
 
-# PROGRAM SETTINGS
-[tool.coverage.run]
-branch = true
-source = ["bitvavo_api_upgraded"]
-parallel = true
-relative_files = true
-
-[tool.coverage.paths]
-source = [
-    "src/bitvavo_api_upgraded",
-    ".tox/py3*/lib/python3.*/site-packages/bitvavo_api_upgraded",
-]
-
-[tool.coverage.report]
-fail_under = 50
-precision = 0
-show_missing = true
-skip_covered = true
-skip_empty = true
-sort = "Cover"
-exclude_lines = [
-    "pragma: no cover",           # Common usage for excluding lines from coverage
-    "if __name__ == .__main__.:", # Skip lines commonly used in scripts
-]
-
 [tool.black]
 line-length = 120
 include = "(src|tests)/.*.py"
@@ -263,19 +264,16 @@ profile = "black"
 src_paths = ["src", "tests"]
 
 [tool.pytest.ini_options]
-addopts = """
-    --cov=bitvavo_api_upgraded
-    --cov-branch
-    --cov-report=term
-    --cov-report=html
-    --durations-min=1
-    --verbosity=2
-    --no-header
-    --show-capture=all
-"""
-# addopts = "--durations-min=1 --stepwise --verbosity=2 --no-header --show-capture=all"
-# addopts = "--durations=10 --durations-min=1 --stepwise --verbosity=1 --no-header"
+minversion = "8.0"
+addopts = [
+    "--durations-min=1",
+    "--verbosity=2",
+    "--no-header",
+    "--show-capture=all",
+]
+
 testpaths = ["tests"]
+pythonpath = ["src"]
 markers = ["no_cover: some pytest-integration default mark that's not known?."]
 python_classes = "Test*"
 python_files = "test_*.py"

bitvavo_api_upgraded-1.17.1/src/bitvavo_api_upgraded/__init__.py

@@ -0,0 +1,8 @@
+from bitvavo_api_upgraded.bitvavo import Bitvavo
+from bitvavo_api_upgraded.settings import BitvavoApiUpgradedSettings, BitvavoSettings
+
+__all__ = [
+    "Bitvavo",
+    "BitvavoApiUpgradedSettings",
+    "BitvavoSettings",
+]

{bitvavo_api_upgraded-1.17.0 → bitvavo_api_upgraded-1.17.1}/src/bitvavo_api_upgraded/bitvavo.py

@@ -14,7 +14,7 @@ from structlog.stdlib import get_logger
 from websocket import WebSocketApp  # missing stubs for WebSocketApp
 
 from bitvavo_api_upgraded.helper_funcs import configure_loggers, time_ms, time_to_wait
-from bitvavo_api_upgraded.settings import BITVAVO_API_UPGRADED
+from bitvavo_api_upgraded.settings import bitvavo_upgraded_settings
 from bitvavo_api_upgraded.type_aliases import anydict, errordict, intdict, ms, s_f, strdict, strintdict
 
 configure_loggers()
@@ -332,7 +332,7 @@ class Bitvavo:
         list[list[str]]
         ```
         """
-        if (self.rateLimitRemaining - rateLimitingWeight) <= BITVAVO_API_UPGRADED.RATE_LIMITING_BUFFER:
+        if (self.rateLimitRemaining - rateLimitingWeight) <= bitvavo_upgraded_settings.RATE_LIMITING_BUFFER:
             self.sleep_until_can_continue()
         if self.debugging:
             logger.debug(
@@ -344,7 +344,7 @@ class Bitvavo:
                 },
             )
         if self.APIKEY != "":
-            now = time_ms() + BITVAVO_API_UPGRADED.LAG
+            now = time_ms() + bitvavo_upgraded_settings.LAG
             sig = createSignature(now, "GET", url.replace(self.base, ""), None, self.APISECRET)
             headers = {
                 "bitvavo-access-key": self.APIKEY,
@@ -391,10 +391,10 @@ class Bitvavo:
         list[list[str]]
         ```
         """
-        if (self.rateLimitRemaining - rateLimitingWeight) <= BITVAVO_API_UPGRADED.RATE_LIMITING_BUFFER:
+        if (self.rateLimitRemaining - rateLimitingWeight) <= bitvavo_upgraded_settings.RATE_LIMITING_BUFFER:
             self.sleep_until_can_continue()
         # if this method breaks: add `= {}` after `body: dict`
-        now = time_ms() + BITVAVO_API_UPGRADED.LAG
+        now = time_ms() + bitvavo_upgraded_settings.LAG
         sig = createSignature(now, method, (endpoint + postfix), body, self.APISECRET)
         url = self.base + endpoint + postfix
         headers = {
@@ -1832,7 +1832,7 @@ class Bitvavo:
                     self.subscriptionBook(market, self.callbacks["subscriptionBookUser"][market])
 
         def on_open(self, ws: Any) -> None:  # noqa: ARG002
-            now = time_ms() + BITVAVO_API_UPGRADED.LAG
+            now = time_ms() + bitvavo_upgraded_settings.LAG
             self.open = True
             self.reconnectTimer = 0.5
             if self.APIKEY != "":

bitvavo_api_upgraded-1.17.1/src/bitvavo_api_upgraded/settings.py

@@ -0,0 +1,70 @@
+import logging
+from pathlib import Path
+
+from pydantic import Field, field_validator, model_validator
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+from bitvavo_api_upgraded.type_aliases import ms
+
+
+class BitvavoApiUpgradedSettings(BaseSettings):
+    """
+    These settings provide extra functionality. Originally I wanted to combine
+    then, but I figured that would be a bad idea.
+    """
+
+    LOG_LEVEL: str = Field("INFO")
+    LOG_EXTERNAL_LEVEL: str = Field("WARNING")
+    LAG: ms = Field(ms(50))
+    RATE_LIMITING_BUFFER: int = Field(25)
+
+    # Configuration for Pydantic Settings
+    model_config = SettingsConfigDict(
+        env_file=Path.cwd() / ".env",
+        env_file_encoding="utf-8",
+        env_prefix="BITVAVO_API_UPGRADED_",
+        extra="ignore",
+    )
+
+    @classmethod
+    @field_validator("LOG_LEVEL", "LOG_EXTERNAL_LEVEL", mode="before")
+    def validate_log_level(cls, v: str) -> str:
+        if v not in logging._nameToLevel:  # noqa: SLF001
+            msg = f"Invalid log level: {v}"
+            raise ValueError(msg)
+        return v
+
+
+class BitvavoSettings(BaseSettings):
+    """
+    These are the base settings from the original library.
+    """
+
+    ACCESSWINDOW: int = Field(10_000)
+    API_RATING_LIMIT_PER_MINUTE: int = Field(default=1000)
+    API_RATING_LIMIT_PER_SECOND: int = Field(default=1000)
+    APIKEY: str = Field(default="BITVAVO_APIKEY is missing")
+    APISECRET: str = Field(default="BITVAVO_APISECRET is missing")
+    DEBUGGING: bool = Field(default=False)
+    RESTURL: str = Field(default="https://api.bitvavo.com/v2")
+    WSURL: str = Field(default="wss://ws.bitvavo.com/v2/")
+
+    # Configuration for Pydantic Settings
+    model_config = SettingsConfigDict(
+        env_file=Path.cwd() / ".env",
+        env_file_encoding="utf-8",
+        env_prefix="BITVAVO_",
+        extra="ignore",
+    )
+
+    @model_validator(mode="after")
+    def set_api_rating_limit_per_second(self) -> "BitvavoSettings":
+        self.API_RATING_LIMIT_PER_SECOND = self.API_RATING_LIMIT_PER_SECOND // 60
+        return self
+
+
+# Initialize the settings
+bitvavo_upgraded_settings = BitvavoApiUpgradedSettings()
+BITVAVO_API_UPGRADED = bitvavo_upgraded_settings
+bitvavo_settings = BitvavoSettings()
+BITVAVO = bitvavo_settings

{bitvavo_api_upgraded-1.17.0 → bitvavo_api_upgraded-1.17.1}/tests/conftest.py

@@ -8,24 +8,14 @@ from typing import Any
 import pytest
 
 from bitvavo_api_upgraded.bitvavo import Bitvavo
-from bitvavo_api_upgraded.settings import BITVAVO
+from bitvavo_api_upgraded.settings import bitvavo_settings
 
 logger = logging.getLogger("conftest")
 
 
 @pytest.fixture(scope="session")
 def bitvavo() -> Bitvavo:
-    return Bitvavo(
-        {
-            # create a file called .env and put the keys there
-            "APIKEY": BITVAVO.APIKEY,
-            "APISECRET": BITVAVO.APISECRET,
-            "RESTURL": BITVAVO.RESTURL,
-            "WSURL": BITVAVO.WSURL,
-            "ACCESSWINDOW": BITVAVO.ACCESSWINDOW,
-            "DEBUGGING": BITVAVO.DEBUGGING,
-        },
-    )
+    return Bitvavo(bitvavo_settings.model_dump())
 
 
 @pytest.fixture(scope="session")
@@ -34,17 +24,7 @@ def websocket(bitvavo: Bitvavo) -> Bitvavo.WebSocketAppFacade:
         msg = f"Error callback: {error}"
         logger.error(msg)
 
-    bitvavo = Bitvavo(
-        {
-            # create a file called .env and put the keys there
-            "APIKEY": BITVAVO.APIKEY,
-            "APISECRET": BITVAVO.APISECRET,
-            "RESTURL": BITVAVO.RESTURL,
-            "WSURL": BITVAVO.WSURL,
-            "ACCESSWINDOW": BITVAVO.ACCESSWINDOW,
-            "DEBUGGING": BITVAVO.DEBUGGING,
-        },
-    )
+    bitvavo = Bitvavo(bitvavo_settings.model_dump())
 
     websocket: Bitvavo.WebSocketAppFacade = bitvavo.newWebsocket()
     websocket.setErrorCallback(errorCallback)
@@ -58,18 +38,13 @@ def wrap_public_request(monkeypatch: pytest.MonkeyPatch, bitvavo: Bitvavo) -> No
     bit and is now generating output that doesn't conform to my tests, but since
     I presume that this output does not matter - typically it contains markets
     that are not in use anymore - I can remove them.
+
+    2024-12-24: I kinda fixed the tests, so this may not be necessary anymore.
+    Maybe.
     """
     # Market exceptions to remove, as of 2024-11-11
     market_exceptions = [
-        "BABYDOGE-EUR",
-        "PEAQ-EUR",
-        "UXLINK-EUR",
-        "KLAY-EUR",
-        "ORN-EUR",
-        "DEGEN-EUR",
-        "EUROC-USDC",
-        "PNUT-EUR",
-        "SYS-EUR",
+        "BABYDOGE-EUR",  # left as example
     ]
     original_public_request = bitvavo.publicRequest