keepa 1.3.7__tar.gz → 1.3.9__tar.gz

{keepa-1.3.7 → keepa-1.3.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: keepa
-Version: 1.3.7
+Version: 1.3.9
 Summary: Interfaces with keepa.com's API.
 Keywords: keepa
 Author-email: Alex Kaszynski <akascap@gmail.com>
@@ -17,9 +17,8 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: numpy >=1.9.3
 Requires-Dist: requests >=2.2
 Requires-Dist: tqdm
-Requires-Dist: aiohttp; python_version!='3.12.*'
-Requires-Dist: aiohttp==3.9.0b0; python_version=='3.12.*'
-Requires-Dist: pandas
+Requires-Dist: aiohttp
+Requires-Dist: pandas <= 3.0
 Requires-Dist: sphinx==6.1.2 ; extra == "doc"
 Requires-Dist: pydata-sphinx-theme==0.14.2 ; extra == "doc"
 Requires-Dist: matplotlib ; extra == "test"
@@ -328,7 +327,6 @@ Unit testing will automatically enforce minimum code coverage standards.
 
 Next, to ensure your code meets minimum code styling standards, run::
 
-  pip install pre-commit
   pre-commit run --all-files
 
 Finally, `create a pull request`_ from your fork and I'll be sure to review it.

{keepa-1.3.7 → keepa-1.3.9}/README.rst

@@ -294,7 +294,6 @@ Unit testing will automatically enforce minimum code coverage standards.
 
 Next, to ensure your code meets minimum code styling standards, run::
 
-  pip install pre-commit
   pre-commit run --all-files
 
 Finally, `create a pull request`_ from your fork and I'll be sure to review it.

{keepa-1.3.7 → keepa-1.3.9}/pyproject.toml

@@ -26,9 +26,8 @@ dependencies = [
     "numpy >=1.9.3",
     "requests >=2.2",
     "tqdm",
-    "aiohttp; python_version!='3.12.*'",
-    "aiohttp==3.9.0b0; python_version=='3.12.*'",  # until aiohttp gets upgraded
-    "pandas",
+    "aiohttp",
+    "pandas <= 3.0",
 ]
 
 [project.urls]
@@ -59,8 +58,7 @@ force_sort_within_sections = true
 # Combines "as" imports on the same line
 combine_as_imports = true
 
-[tool.black]
+[tool.ruff]
 line-length = 100
-skip-string-normalization = true
-target-version = ['py39']
-exclude='\.eggs|\.git|\.mypy_cache|\.tox|\.venv|_build|buck-out|build|dist|node_modules'
+select = ["E", "F", "W", "I001"]  # pyflakes, pycodestyle, isort
+ignore = []

{keepa-1.3.7 → keepa-1.3.9}/src/keepa/__init__.py

@@ -1,12 +1,17 @@
 """Keepaapi module."""
 
-__version__ = "1.3.7"
+__version__ = "1.3.9"
 from keepa.interface import (  # noqa: F401
+    DCODES,
+    KEEPA_ST_ORDINAL,
+    SCODES,
     AsyncKeepa,
     Keepa,
     convert_offer_history,
+    csv_indices,
     format_items,
     keepa_minutes_to_time,
+    parse_csv,
     process_used_buybox,
     run_and_get,
 )

{keepa-1.3.7 → keepa-1.3.9}/src/keepa/interface.py

@@ -1,4 +1,5 @@
 """Interface module to download Amazon product and history data from keepa.com."""
+
 import asyncio
 import datetime
 import json
@@ -43,8 +44,8 @@ SCODES = {
 
 # domain codes
 # Valid values: [ 1: com | 2: co.uk | 3: de | 4: fr | 5:
-#                 co.jp | 6: ca | 7: cn | 8: it | 9: es | 10: in | 11: com.mx ]
-DCODES = ["RESERVED", "US", "GB", "DE", "FR", "JP", "CA", "CN", "IT", "ES", "IN", "MX"]
+#                 co.jp | 6: ca | 7: cn | 8: it | 9: es | 10: in | 11: com.mx | 12: com.br ]
+DCODES = ["RESERVED", "US", "GB", "DE", "FR", "JP", "CA", "CN", "IT", "ES", "IN", "MX", "BR"]
 
 # csv indices. used when parsing csv and stats fields.
 # https://github.com/keepacom/api_backend
@@ -364,28 +365,28 @@ class Keepa:
     Create the api object.
 
     >>> import keepa
-    >>> key = '<REAL_KEEPA_KEY>'
+    >>> key = "<REAL_KEEPA_KEY>"
     >>> api = keepa.Keepa(key)
 
     Request data from two ASINs.
 
-    >>> products = api.query(['0439064872', '1426208081'])
+    >>> products = api.query(["0439064872", "1426208081"])
 
     Print item details.
 
-    >>> print('Item 1')
-    >>> print('\t ASIN: {:s}'.format(products[0]['asin']))
-    >>> print('\t Title: {:s}'.format(products[0]['title']))
+    >>> print("Item 1")
+    >>> print("\t ASIN: {:s}".format(products[0]["asin"]))
+    >>> print("\t Title: {:s}".format(products[0]["title"]))
     Item 1
         ASIN: 0439064872
         Title: Harry Potter and the Chamber of Secrets (2)
 
     Print item price.
 
-    >>> usedprice = products[0]['data']['USED']
-    >>> usedtimes = products[0]['data']['USED_time']
-    >>> print('\t Used price: ${:.2f}'.format(usedprice[-1]))
-    >>> print('\t as of: {:s}'.format(str(usedtimes[-1])))
+    >>> usedprice = products[0]["data"]["USED"]
+    >>> usedtimes = products[0]["data"]["USED_time"]
+    >>> print("\t Used price: ${:.2f}".format(usedprice[-1]))
+    >>> print("\t as of: {:s}".format(str(usedtimes[-1])))
         Used price: $0.52
         as of: 2023-01-03 04:46:00
 
@@ -418,7 +419,7 @@ class Keepa:
         should be 0.0 seconds.
 
         >>> import keepa
-        >>> key = '<REAL_KEEPA_KEY>'
+        >>> key = "<REAL_KEEPA_KEY>"
         >>> api = keepa.Keepa(key)
         >>> api.time_to_refill
         0.0
@@ -505,9 +506,9 @@ class Keepa:
             timestamps (unix epoch time milliseconds) or two date
             strings (ISO8601, with or without time in UTC).
 
-        domain : str, optional
+        domain : str, default: "US"
             One of the following Amazon domains: RESERVED, US, GB, DE,
-            FR, JP, CA, CN, IT, ES, IN, MX Defaults to US.
+            FR, JP, CA, CN, IT, ES, IN, MX, BR.
 
         offers : int, optional
             Adds available offers to product data. Default 0.  Must be between
@@ -738,10 +739,10 @@ class Keepa:
         keepa interface.
 
         >>> import keepa
-        >>> key = '<REAL_KEEPA_KEY>'
+        >>> key = "<REAL_KEEPA_KEY>"
         >>> api = keepa.Keepa(key)
-        >>> response = api.query('B0088PUEPK')
-        >>> response[0]['title']
+        >>> response = api.query("B0088PUEPK")
+        >>> response[0]["title"]
         'Western Digital 1TB WD Blue PC Internal Hard Drive HDD - 7200 RPM,
         SATA 6 Gb/s, 64 MB Cache, 3.5" - WD10EZEX'
 
@@ -751,12 +752,12 @@ class Keepa:
         >>> import asyncio
         >>> import keepa
         >>> async def main():
-        ...     key = '<REAL_KEEPA_KEY>'
+        ...     key = "<REAL_KEEPA_KEY>"
         ...     api = await keepa.AsyncKeepa().create(key)
-        ...     return await api.query('B0088PUEPK')
+        ...     return await api.query("B0088PUEPK")
         ...
         >>> response = asyncio.run(main())
-        >>> response[0]['title']
+        >>> response[0]["title"]
         'Western Digital 1TB WD Blue PC Internal Hard Drive HDD - 7200 RPM,
         SATA 6 Gb/s, 64 MB Cache, 3.5" - WD10EZEX'
 
@@ -764,11 +765,11 @@ class Keepa:
         ``pandas.DataFrame``.
 
         >>> import keepa
-        >>> key = '<REAL_KEEPA_KEY>'
+        >>> key = "<REAL_KEEPA_KEY>"
         >>> api = keepa.Keepa(key)
-        >>> response = api.query('B0088PUEPK', offers=20)
+        >>> response = api.query("B0088PUEPK", offers=20)
         >>> product = response[0]
-        >>> buybox_info = product['buyBoxUsedHistory']
+        >>> buybox_info = product["buyBoxUsedHistory"]
         >>> df = keepa.process_used_buybox(buybox_info)
                        datetime         user_id         condition  isFBA
         0   2022-11-02 16:46:00  A1QUAC68EAM09F   Used - Like New   True
@@ -885,7 +886,7 @@ class Keepa:
 
         domain : str
             One of the following Amazon domains:
-            RESERVED, US, GB, DE, FR, JP, CA, CN, IT, ES, IN, MX
+            RESERVED, US, GB, DE, FR, JP, CA, CN, IT, ES, IN, MX, BR.
 
         offers : bool, optional
             Adds product offers to product data.
@@ -1021,10 +1022,9 @@ class Keepa:
             the best sellers list for. You can find category node ids
             via the category search "search_for_categories".
 
-        domain : str
-            Amazon locale you want to access. Must be one of the following
-            RESERVED, US, GB, DE, FR, JP, CA, CN, IT, ES, IN, MX
-            Default US.
+        domain : str, default: "US"
+            Amazon locale you want to access. Must be one of the following:
+            RESERVED, US, GB, DE, FR, JP, CA, CN, IT, ES, IN, MX, BR.
 
         wait : bool, optional
             Wait available token before doing effective query.
@@ -1040,7 +1040,7 @@ class Keepa:
         Query for the best sellers among the ``"movies"`` category.
 
         >>> import keepa
-        >>> key = '<REAL_KEEPA_KEY>'
+        >>> key = "<REAL_KEEPA_KEY>"
         >>> api = keepa.Keepa(key)
         >>> categories = api.search_for_categories("movies")
         >>> category = list(categories.items())[0][0]
@@ -1060,7 +1060,7 @@ class Keepa:
         >>> import asyncio
         >>> import keepa
         >>> async def main():
-        ...     key = '<REAL_KEEPA_KEY>'
+        ...     key = "<REAL_KEEPA_KEY>"
         ...     api = await keepa.AsyncKeepa().create(key)
         ...     categories = await api.search_for_categories("movies")
         ...     category = list(categories.items())[0][0]
@@ -1077,7 +1077,10 @@ class Keepa:
         ...
 
         """
-        assert domain in DCODES, "Invalid domain code"
+        if domain not in DCODES:
+            raise ValueError(
+                f"Invalid domain code {domain}. Should be one of the following:\n{DCODES}"
+            )
 
         payload = {
             "key": self.accesskey,
@@ -1100,10 +1103,9 @@ class Keepa:
         searchterm : str
             Input search term.
 
-        domain : str, default: 'US'
-            Amazon locale you want to access. Must be one of the following
-            RESERVED, US, GB, DE, FR, JP, CA, CN, IT, ES, IN, MX
-            Default US.
+        domain : str, default: "US"
+            Amazon locale you want to access. Must be one of the following:
+            RESERVED, US, GB, DE, FR, JP, CA, CN, IT, ES, IN, MX, BR.
 
         wait : bool, default: True
             Wait available token before doing effective query.
@@ -1120,11 +1122,11 @@ class Keepa:
         Print all categories from science.
 
         >>> import keepa
-        >>> key = '<REAL_KEEPA_KEY>'
+        >>> key = "<REAL_KEEPA_KEY>"
         >>> api = keepa.Keepa(key)
-        >>> categories = api.search_for_categories('science')
+        >>> categories = api.search_for_categories("science")
         >>> for cat_id in categories:
-        ...     print(cat_id, categories[cat_id]['name'])
+        ...     print(cat_id, categories[cat_id]["name"])
         ...
         9091159011 Behavioral Sciences
         8407535011 Fantasy, Horror & Science Fiction
@@ -1136,7 +1138,10 @@ class Keepa:
         144 Science Fiction & Fantasy
 
         """
-        assert domain in DCODES, "Invalid domain code"
+        if domain not in DCODES:
+            raise ValueError(
+                f"Invalid domain code {domain}. Should be one of the following:\n{DCODES}"
+            )
 
         payload = {
             "key": self.accesskey,
@@ -1162,9 +1167,8 @@ class Keepa:
             categories.
 
         domain : str, default: "US"
-            Amazon locale you want to access. Must be one of the following
-            RESERVED, US, GB, DE, FR, JP, CA, CN, IT, ES, IN, MX
-            Default US
+            Amazon locale you want to access. Must be one of the following:
+            RESERVED, US, GB, DE, FR, JP, CA, CN, IT, ES, IN, MX, BR.
 
         include_parents : bool, default: False
             Include parents.
@@ -1182,7 +1186,7 @@ class Keepa:
         Use 0 to return all root categories.
 
         >>> import keepa
-        >>> key = '<REAL_KEEPA_KEY>'
+        >>> key = "<REAL_KEEPA_KEY>"
         >>> api = keepa.Keepa(key)
         >>> categories = api.category_lookup(0)
 
@@ -1211,7 +1215,9 @@ class Keepa:
 
         """
         if domain not in DCODES:
-            raise ValueError("Invalid domain code")
+            raise ValueError(
+                f"Invalid domain code {domain}. Should be one of the following:\n{DCODES}"
+            )
 
         payload = {
             "key": self.accesskey,
@@ -1300,10 +1306,10 @@ class Keepa:
         Return the information from seller ``'A2L77EE7U53NWQ'``.
 
         >>> import keepa
-        >>> key = '<REAL_KEEPA_KEY>'
+        >>> key = "<REAL_KEEPA_KEY>"
         >>> api = keepa.Keepa(key)
-        >>> seller_info = api.seller_query('A2L77EE7U53NWQ', 'US')
-        >>> seller_info['A2L77EE7U53NWQ']['sellerName']
+        >>> seller_info = api.seller_query("A2L77EE7U53NWQ", "US")
+        >>> seller_info["A2L77EE7U53NWQ"]["sellerName"]
         'Amazon Warehouse'
 
         Notes
@@ -2376,10 +2382,10 @@ class Keepa:
         ``keepa.Keepa`` class. Sort by current sales.
 
         >>> import keepa
-        >>> api = keepa.Keepa('<ENTER_ACTUAL_KEY_HERE>')
+        >>> api = keepa.Keepa("<ENTER_ACTUAL_KEY_HERE>")
         >>> product_parms = {
-        ...     'author': 'jim butcher',
-        ...     'sort': ["current_SALES", "asc"],
+        ...     "author": "jim butcher",
+        ...     "sort": ["current_SALES", "asc"],
         ... }
         >>> asins = api.product_finder(product_parms, n_products=100)
         >>> asins
@@ -2396,9 +2402,9 @@ class Keepa:
 
         >>> import asyncio
         >>> import keepa
-        >>> product_parms = {'author': 'jim butcher'}
+        >>> product_parms = {"author": "jim butcher"}
         >>> async def main():
-        ...     key = '<REAL_KEEPA_KEY>'
+        ...     key = "<REAL_KEEPA_KEY>"
         ...     api = await keepa.AsyncKeepa().create(key)
         ...     return await api.product_finder(product_parms)
         ...
@@ -2425,7 +2431,7 @@ class Keepa:
         payload = {
             "key": self.accesskey,
             "domain": DCODES.index(domain),
-            "selection": json.dumps({**product_parms, **{'perPage': n_products}}),
+            "selection": json.dumps({**product_parms, **{"perPage": n_products}}),
         }
 
         response = self._request("query", payload, wait=wait)
@@ -2496,7 +2502,7 @@ class Keepa:
         ``keepa.Keepa`` class
 
         >>> import keepa
-        >>> key = '<REAL_KEEPA_KEY>'
+        >>> key = "<REAL_KEEPA_KEY>"
         >>> api = keepa.Keepa(key)
         >>> deal_parms = {
         ...     "page": 0,
@@ -2508,7 +2514,7 @@ class Keepa:
 
         Get the title of the first deal.
 
-        >>> deals['dr'][0]['title']
+        >>> deals["dr"][0]["title"]
         'Orange Cream Rooibos, Tea Bags - Vanilla, Orange | Caffeine-Free,
         Antioxidant-rich, Hot & Iced | The Spice Hut, First Sip Of Tea'
 
@@ -2524,7 +2530,7 @@ class Keepa:
         ...     "includeCategories": [16310101],
         ... }
         >>> async def main():
-        ...     key = '<REAL_KEEPA_KEY>'
+        ...     key = "<REAL_KEEPA_KEY>"
         ...     api = await keepa.AsyncKeepa().create(key)
         ...     categories = await api.search_for_categories("movies")
         ...     return await api.deals(deal_parms)
@@ -2630,9 +2636,9 @@ class AsyncKeepa:
 
     >>> import asyncio
     >>> import keepa
-    >>> product_parms = {'author': 'jim butcher'}
+    >>> product_parms = {"author": "jim butcher"}
     >>> async def main():
-    ...     key = '<REAL_KEEPA_KEY>'
+    ...     key = "<REAL_KEEPA_KEY>"
     ...     api = await keepa.AsyncKeepa().create(key)
     ...     return await api.product_finder(product_parms)
     ...
@@ -2652,12 +2658,12 @@ class AsyncKeepa:
     >>> import asyncio
     >>> import keepa
     >>> async def main():
-    ...     key = '<REAL_KEEPA_KEY>'
+    ...     key = "<REAL_KEEPA_KEY>"
     ...     api = await keepa.AsyncKeepa().create(key)
-    ...     return await api.query('B0088PUEPK')
+    ...     return await api.query("B0088PUEPK")
     ...
     >>> response = asyncio.run(main())
-    >>> response[0]['title']
+    >>> response[0]["title"]
     'Western Digital 1TB WD Blue PC Internal Hard Drive HDD - 7200 RPM,
     SATA 6 Gb/s, 64 MB Cache, 3.5" - WD10EZEX'
 
@@ -2884,7 +2890,10 @@ class AsyncKeepa:
     @is_documented_by(Keepa.best_sellers_query)
     async def best_sellers_query(self, category, rank_avg_range=0, domain="US", wait=True):
         """Documented by Keepa.best_sellers_query."""
-        assert domain in DCODES, "Invalid domain code"
+        if domain not in DCODES:
+            raise ValueError(
+                f"Invalid domain code {domain}. Should be one of the following:\n{DCODES}"
+            )
 
         payload = {
             "key": self.accesskey,
@@ -2902,7 +2911,10 @@ class AsyncKeepa:
     @is_documented_by(Keepa.search_for_categories)
     async def search_for_categories(self, searchterm, domain="US", wait=True):
         """Documented by Keepa.search_for_categories."""
-        assert domain in DCODES, "Invalid domain code"
+        if domain not in DCODES:
+            raise ValueError(
+                f"Invalid domain code {domain}. Should be one of the following:\n{DCODES}"
+            )
 
         payload = {
             "key": self.accesskey,
@@ -2922,7 +2934,10 @@ class AsyncKeepa:
     @is_documented_by(Keepa.category_lookup)
     async def category_lookup(self, category_id, domain="US", include_parents=0, wait=True):
         """Documented by Keepa.category_lookup."""
-        assert domain in DCODES, "Invalid domain code"
+        if domain not in DCODES:
+            raise ValueError(
+                f"Invalid domain code {domain}. Should be one of the following:\n{DCODES}"
+            )
 
         payload = {
             "key": self.accesskey,
@@ -3115,11 +3130,11 @@ def process_used_buybox(buybox_info: List[str]) -> pd.DataFrame:
     ``pandas.DataFrame``.
 
     >>> import keepa
-    >>> key = '<REAL_KEEPA_KEY>'
+    >>> key = "<REAL_KEEPA_KEY>"
     >>> api = keepa.Keepa(key)
-    >>> response = api.query('B0088PUEPK', offers=20)
+    >>> response = api.query("B0088PUEPK", offers=20)
     >>> product = response[0]
-    >>> buybox_info = product['buyBoxUsedHistory']
+    >>> buybox_info = product["buyBoxUsedHistory"]
     >>> df = keepa.process_used_buybox(buybox_info)
                    datetime         user_id         condition  isFBA
     0   2022-11-02 16:46:00  A1QUAC68EAM09F   Used - Like New   True
@@ -3156,10 +3171,10 @@ def process_used_buybox(buybox_info: List[str]) -> pd.DataFrame:
 
     df = pd.DataFrame(
         {
-            'datetime': datetime_arr,
-            'user_id': user_id_arr,
-            'condition': condition_arr,
-            'isFBA': isFBA_arr,
+            "datetime": datetime_arr,
+            "user_id": user_id_arr,
+            "condition": condition_arr,
+            "isFBA": isFBA_arr,
         }
     )
 

{keepa-1.3.7 → keepa-1.3.9}/src/keepa/plotting.py

@@ -1,4 +1,5 @@
 """Plotting module product data returned from keepa interface module."""
+
 import numpy as np
 
 from keepa.interface import keepa_minutes_to_time, parse_csv