keepa 1.4.2__tar.gz → 1.4.4__tar.gz

{keepa-1.4.2 → keepa-1.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: keepa
-Version: 1.4.2
+Version: 1.4.4
 Summary: Interfaces with keepa.com's API.
 Keywords: keepa
 Author-email: Alex Kaszynski <akascap@gmail.com>
@@ -22,9 +22,9 @@ Requires-Dist: tqdm
 Requires-Dist: aiohttp
 Requires-Dist: pandas <= 3.0
 Requires-Dist: pydantic
-Requires-Dist: sphinx==7.3.7 ; extra == "doc"
-Requires-Dist: pydata-sphinx-theme==0.15.4 ; extra == "doc"
-Requires-Dist: numpydoc==1.7.0 ; extra == "doc"
+Requires-Dist: sphinx==9.1.0 ; extra == "doc"
+Requires-Dist: pydata-sphinx-theme==0.16.1 ; extra == "doc"
+Requires-Dist: numpydoc==1.10.0 ; extra == "doc"
 Requires-Dist: matplotlib ; extra == "test"
 Requires-Dist: pandas ; extra == "test"
 Requires-Dist: pytest-asyncio ; extra == "test"
@@ -52,14 +52,10 @@ Python keepa Client Library
 .. image:: https://codecov.io/gh/akaszynski/keepa/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/akaszynski/keepa
 
-.. image:: https://app.codacy.com/project/badge/Grade/9452f99f297c4a6eac14e2d21189ab6f
-  :target: https://www.codacy.com/gh/akaszynski/keepa/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=akaszynski/keepa&amp;utm_campaign=Badge_Grade
-
 
 This Python library allows you to interface with the API at `Keepa
-<https://keepa.com/>`_ to query for Amazon product information and
-history. It also contains a plotting module to allow for plotting of
-a product.
+<https://keepa.com/>`_ to query for Amazon product information and history. It
+also contains a plotting module to allow for plotting of a product.
 
 Sign up for `Keepa Data Access <https://get.keepa.com/d7vrq>`_.
 
@@ -346,8 +342,8 @@ found at `keepacom/api_backend <https://github.com/keepacom/api_backend/>`_.
 
 License
 -------
-Apache License, please see license file. Work is credited to both Alex
-Kaszynski and Marius Johann.
+Apache License, please see license file. Work is credited to both Alex Kaszynski
+and Marius Johann.
 
 
 .. _create a pull request: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request

{keepa-1.4.2 → keepa-1.4.4}/README.rst

@@ -14,14 +14,10 @@ Python keepa Client Library
 .. image:: https://codecov.io/gh/akaszynski/keepa/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/akaszynski/keepa
 
-.. image:: https://app.codacy.com/project/badge/Grade/9452f99f297c4a6eac14e2d21189ab6f
-  :target: https://www.codacy.com/gh/akaszynski/keepa/dashboard?utm_source=github.com&utm_medium=referral&utm_content=akaszynski/keepa&utm_campaign=Badge_Grade
-
 
 This Python library allows you to interface with the API at `Keepa
-<https://keepa.com/>`_ to query for Amazon product information and
-history. It also contains a plotting module to allow for plotting of
-a product.
+<https://keepa.com/>`_ to query for Amazon product information and history. It
+also contains a plotting module to allow for plotting of a product.
 
 Sign up for `Keepa Data Access <https://get.keepa.com/d7vrq>`_.
 
@@ -308,8 +304,8 @@ found at `keepacom/api_backend <https://github.com/keepacom/api_backend/>`_.
 
 License
 -------
-Apache License, please see license file. Work is credited to both Alex
-Kaszynski and Marius Johann.
+Apache License, please see license file. Work is credited to both Alex Kaszynski
+and Marius Johann.
 
 
 .. _create a pull request: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request

{keepa-1.4.2 → keepa-1.4.4}/pyproject.toml

@@ -2,9 +2,6 @@
 build-backend = "flit_core.buildapi"
 requires = ["flit_core >=3,<4"]
 
-[mypy]
-plugins = "pydantic.mypy"
-
 [project]
 authors = [
   {name = "Alex Kaszynski", email = "akascap@gmail.com"}
@@ -33,13 +30,13 @@ keywords = ["keepa"]
 name = "keepa"
 readme = "README.rst"
 requires-python = ">=3.10"
-version = "1.4.2"
+version = "1.4.4"
 
 [project.optional-dependencies]
 doc = [
-  "sphinx==7.3.7",
-  "pydata-sphinx-theme==0.15.4",
-  "numpydoc==1.7.0"
+  "sphinx==9.1.0",
+  "pydata-sphinx-theme==0.16.1",
+  "numpydoc==1.10.0"
 ]
 test = [
   "matplotlib",
@@ -54,6 +51,9 @@ test = [
 Documentation = "https://keepaapi.readthedocs.io/en/latest/"
 Source = "https://github.com/akaszynski/keepa"
 
+[tool.mypy]
+plugins = "pydantic.mypy"
+
 [tool.pytest.ini_options]
 addopts = "--cov=keepa --cov-fail-under=85"
 asyncio_default_fixture_loop_scope = "function"

{keepa-1.4.2 → keepa-1.4.4}/src/keepa/keepa_async.py

@@ -130,7 +130,7 @@ class AsyncKeepa:
 
     async def update_status(self) -> None:
         """Update available tokens."""
-        self.status = await self._request("token", {"key": self.accesskey}, wait=False)
+        await self._request("token", {"key": self.accesskey}, wait=False)
 
     async def wait_for_tokens(self) -> None:
         """Check if there are any remaining tokens and waits if none are available."""

{keepa-1.4.2 → keepa-1.4.4}/src/keepa/keepa_sync.py

@@ -40,9 +40,14 @@ class Keepa:
         server has not issued a response for timeout seconds. Setting this to
         0.0 disables the timeout, but will cause any request to hang
         indefiantly should keepa.com be down
-    logging_level: string, default: "DEBUG"
+    logging_level: str, default: "DEBUG"
         Logging level to use. Default is "DEBUG". Other options are "INFO",
         "WARNING", "ERROR", and "CRITICAL".
+    check_key : bool, default: True
+        Check the keepa key on initialization and update the number of
+        available tokens. This is a free check and does not cost any tokens,
+        but does slow down the time to initialize. Disable this to speed up
+        init at the risk of using an invalid key when querying for a product.
 
     Examples
     --------
@@ -81,7 +86,13 @@ class Keepa:
     status: Status
     _timeout: float
 
-    def __init__(self, accesskey: str, timeout: float = 10.0, logging_level: str = "DEBUG") -> None:
+    def __init__(
+        self,
+        accesskey: str,
+        timeout: float = 10.0,
+        logging_level: str = "DEBUG",
+        check_key: bool = False,
+    ) -> None:
         """Initialize server connection."""
         self.accesskey = accesskey
         self.tokens_left = 0
@@ -93,9 +104,11 @@ class Keepa:
             raise TypeError("logging_level must be one of: " + ", ".join(levels))
         log.setLevel(logging_level)
 
-        # Don't check available tokens on init
+        # Check available tokens on init
         log.info("Using key ending in %s", accesskey[-6:])
         self.status = Status()
+        if check_key:
+            self.update_status()
 
     @property
     def time_to_refill(self) -> float:
@@ -114,6 +127,20 @@ class Keepa:
         0.0
 
         """
+        if (
+            self.status.refillRate is None
+            or self.status.refillIn is None
+            or self.status.timestamp is None
+        ):
+            self.update_status()
+
+        if (
+            self.status.refillRate is None
+            or self.status.refillIn is None
+            or self.status.timestamp is None
+        ):
+            raise RuntimeError("Failed to update status")
+
         # Get current timestamp in milliseconds from UNIX epoch
         now = int(time.time() * 1000)
         time_at_refill = self.status.timestamp + self.status.refillIn
@@ -130,11 +157,10 @@ class Keepa:
         # Return value in seconds
         return time_to_refill / 1000.0
 
-    def update_status(self) -> dict[str, Any]:
+    def update_status(self) -> None:
         """Update available tokens."""
-        status = self._request("token", {"key": self.accesskey}, wait=False)
-        self.status = status
-        return status
+        # number of available tokens is always returned
+        self._request("token", {"key": self.accesskey}, wait=False)
 
     def wait_for_tokens(self) -> None:
         """Check if there are any remaining tokens and waits if none are available."""
@@ -143,7 +169,7 @@ class Keepa:
         # Wait if no tokens available
         if self.tokens_left <= 0:
             tdelay = self.time_to_refill
-            log.warning("Waiting %.0f seconds for additional tokens" % tdelay)
+            log.warning("Waiting %.0f seconds for additional tokens", tdelay)
             time.sleep(tdelay)
             self.update_status()
 
@@ -632,6 +658,11 @@ class Keepa:
             if offers > 100 or offers < 20:
                 raise ValueError('Parameter "offers" must be between 20 and 100')
 
+        if self.status.refillRate is None or self.status.refillIn is None:
+            self.update_status()
+        if self.status.refillRate is None or self.status.refillIn is None:
+            raise RuntimeError("Failed to update status")
+
         # Report time to completion
         if self.status.refillRate is not None:
             tcomplete = (
@@ -797,7 +828,7 @@ class Keepa:
         to_datetime = kwargs.pop("to_datetime", True)
 
         # Query and replace csv with parsed data if history enabled
-        wait = kwargs.get("wait")
+        wait = bool(kwargs.get("wait"))
         kwargs.pop("wait", None)
         raw_response = kwargs.pop("raw", False)
         response = self._request("product", kwargs, wait=wait, raw_response=raw_response)
@@ -956,7 +987,7 @@ class Keepa:
 
     def search_for_categories(
         self, searchterm: str, domain: str | Domain = "US", wait: bool = True
-    ) -> list:
+    ) -> dict[str, Any]:
         """
         Search for categories from Amazon.