bitvavo-api-upgraded 1.17.0__py3-none-any.whl → 1.17.2__py3-none-any.whl

bitvavo_api_upgraded/__init__.py

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

bitvavo_api_upgraded/bitvavo.py

@@ -5,6 +5,7 @@ import hashlib
 import hmac
 import json
 import time
+from pathlib import Path
 from threading import Thread
 from typing import Any, Callable
 
@@ -14,7 +15,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()
@@ -158,9 +159,6 @@ def callback_example(response: Any) -> None:
     """
     if isinstance(response, dict):
         # instead of printing, you could save the object to a file:
-        import json
-        from pathlib import Path
-
         HERE = Path.cwd()  # root of your project folder
         filepath = HERE / "your_output.json"
         # a = append; figure out yourself to create multiple callback functions, probably one for each type of call that
@@ -332,7 +330,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 +342,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 +389,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 = {
@@ -591,6 +589,7 @@ class Bitvavo:
           "nonce": 10378032,
           "bids": [["1.1908", "600"], ["1.1902", "4091.359809"], ["1.1898", "7563"]],
           "asks": [["1.1917", "2382.166997"], ["1.1919", "440.7"], ["1.192", "600"]],
+          "timestamp": 1700000000000,
         }
 
         # Notice how each bid and ask is also a list
@@ -1832,7 +1831,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/settings.py

@@ -1,47 +1,70 @@
 import logging
 from pathlib import Path
 
-from decouple import AutoConfig, Choices
+from pydantic import Field, field_validator, model_validator
+from pydantic_settings import BaseSettings, SettingsConfigDict
 
 from bitvavo_api_upgraded.type_aliases import ms
 
-# don't use/import python-decouple's `config`` variable, because the search_path isn't set,
-# which means applications that use a .env file can't override these variables :(
-config = AutoConfig(search_path=Path.cwd())
 
+class BitvavoApiUpgradedSettings(BaseSettings):
+    """
+    These settings provide extra functionality. Originally I wanted to combine
+    then, but I figured that would be a bad idea.
+    """
 
-class _BitvavoApiUpgraded:
-    # default LOG_LEVEL is WARNING, so users don't get their ass spammed.
-    LOG_LEVEL: str = config(
-        "BITVAVO_API_UPGRADED_LOG_LEVEL",
-        default="INFO",
-        cast=Choices(list(logging._nameToLevel.keys())),  # noqa: SLF001
-    )
-    LOG_EXTERNAL_LEVEL: str = config(
-        "BITVAVO_API_UPGRADED_EXTERNAL_LOG_LEVEL",
-        default="WARNING",
-        cast=Choices(list(logging._nameToLevel.keys())),  # noqa: SLF001
+    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",
     )
-    LAG: ms = config("BITVAVO_API_UPGRADED_LAG", default=ms(50), cast=ms)
-    RATE_LIMITING_BUFFER: int = config("BITVAVO_API_UPGRADED_RATE_LIMITING_BUFFER", default=25, cast=int)
 
+    @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 _Bitvavo:
+
+class BitvavoSettings(BaseSettings):
     """
-    Changeable variables are handled by the decouple lib, anything else is just static, because they are based on
-    Bitvavo's documentation and thus should not be able to be set outside of the application.
+    These are the base settings from the original library.
     """
 
-    ACCESSWINDOW: int = config("BITVAVO_ACCESSWINDOW", default=10_000, cast=int)
-    API_RATING_LIMIT_PER_MINUTE: int = 1000
-    API_RATING_LIMIT_PER_SECOND: float = API_RATING_LIMIT_PER_MINUTE / 60
-    APIKEY: str = config("BITVAVO_APIKEY", default="BITVAVO_APIKEY is missing")
-    APISECRET: str = config("BITVAVO_APISECRET", default="BITVAVO_APISECRET is missing")
-    DEBUGGING: bool = config("BITVAVO_DEBUGGING", default=False, cast=bool)
-    RESTURL: str = "https://api.bitvavo.com/v2"
-    WSURL: str = "wss://ws.bitvavo.com/v2/"
+    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
 
 
-# Just import these variables to use the settings :)
-BITVAVO_API_UPGRADED = _BitvavoApiUpgraded()
-BITVAVO = _Bitvavo()
+# 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.dist-info → bitvavo_api_upgraded-1.17.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: bitvavo-api-upgraded
-Version: 1.17.0
+Version: 1.17.2
 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,9 +28,9 @@ 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: structlog==25.*,>=21.5
 Requires-Dist: websocket-client==1.*,>=1.2
 Description-Content-Type: text/markdown
 

bitvavo_api_upgraded-1.17.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+bitvavo_api_upgraded/__init__.py,sha256=CSK4JninN6nxMUqoT-S_Vl9UJc4NOqwfbbZf-Qnvpo4,222
+bitvavo_api_upgraded/bitvavo.py,sha256=s7l-cAl0FteBrm5iF-gnM_U9_-Yds9lpn5pN6f0oaZU,125981
+bitvavo_api_upgraded/helper_funcs.py,sha256=4oBdQ1xB-C2XkQTmN-refzIzWfO-IUowDSWhOSFdCRU,3212
+bitvavo_api_upgraded/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bitvavo_api_upgraded/settings.py,sha256=ZH2sR9iUyOC_lSaqmT50wERngUuobvu8d0TLiYN5nTg,2266
+bitvavo_api_upgraded/type_aliases.py,sha256=NAnMSk5n6SaEIvHFeSMKnXOxfOwnbFuEnRKaAXlcmYw,932
+bitvavo_api_upgraded-1.17.2.dist-info/METADATA,sha256=U_5w2WGTB4xykCwIgh3KtcfsVzsYDS3NZWlHwVRz1Tk,11547
+bitvavo_api_upgraded-1.17.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+bitvavo_api_upgraded-1.17.2.dist-info/licenses/LICENSE.txt,sha256=hiFyor_njVlzVblnb-78mzx1Um3CGvuFxEH3YR735rc,744
+bitvavo_api_upgraded-1.17.2.dist-info/RECORD,,

{bitvavo_api_upgraded-1.17.0.dist-info → bitvavo_api_upgraded-1.17.2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

bitvavo_api_upgraded-1.17.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-bitvavo_api_upgraded/__init__.py,sha256=IS9Ci2orRtYKHyFNXq_9qk9bB6zt4KU4tPbQAxkkCUM,72
-bitvavo_api_upgraded/bitvavo.py,sha256=-AgVq4hXHEsuQhCLEweyjJ_DhAPwbwtCeCPSNeweisA,125942
-bitvavo_api_upgraded/helper_funcs.py,sha256=4oBdQ1xB-C2XkQTmN-refzIzWfO-IUowDSWhOSFdCRU,3212
-bitvavo_api_upgraded/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bitvavo_api_upgraded/settings.py,sha256=MalcO2buJso4NZktDRGGSZ7poF593ceb66zrmX-8dc4,1903
-bitvavo_api_upgraded/type_aliases.py,sha256=NAnMSk5n6SaEIvHFeSMKnXOxfOwnbFuEnRKaAXlcmYw,932
-bitvavo_api_upgraded-1.17.0.dist-info/METADATA,sha256=Csu9ntgiu7tVaEvKXJmBjrFEMAxlVfHhIHRlvYwflIo,11519
-bitvavo_api_upgraded-1.17.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-bitvavo_api_upgraded-1.17.0.dist-info/licenses/LICENSE.txt,sha256=hiFyor_njVlzVblnb-78mzx1Um3CGvuFxEH3YR735rc,744
-bitvavo_api_upgraded-1.17.0.dist-info/RECORD,,