pyaterochka-api 0.1.0__tar.gz

pyaterochka_api-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Open Inflation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyaterochka_api-0.1.0/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.1
+Name: pyaterochka_api
+Version: 0.1.0
+Summary: A Python API client for Pyaterochka store catalog
+Home-page: https://github.com/Open-Inflation/pyaterochka_api
+Author: Miskler
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Pyaterochka API *(not official / не официальный)*
+
+Pyaterochka (Пятёрочка) - https://5ka.ru/
+
+### Usage / Использование:
+```py
+import pyaterochka_api
+import asyncio
+
+
+async def main():
+    # RUS: Выводит список всех категорий на сайте
+    # ENG: Outputs a list of all categories on the site
+    catalog = await pyaterochka_api.categories_list(subcategories=True)
+    print(f"Categories list output: {catalog!s:.100s}...\n")
+
+    # RUS: Выводит список всех товаров выбранной категории (ограничение 100 элементов, если превышает - запрашивайте через дополнительные страницы)
+    # ENG: Outputs a list of all items in the selected category (limiting to 100 elements, if exceeds - request through additional pages)
+    # Страниц не сущетвует, использовать желаемый лимит (до 499) / Pages do not exist, use the desired limit (up to 499)
+    print(f"Items list output: {await pyaterochka_api.products_list(catalog[0]['id'], limit=5)!s:.100s}...\n")
+
+    # RUS: Выводит основной конфиг сайта (очень долгая функция, рекомендую сохранять в файл и переиспользовать)
+    # ENG: Outputs the main config of the site (large function, recommend to save in a file and re-use it)
+    # RUS: Если требуется, можно настроить вывод логов в консоль
+    # ENG: If required, you can configure the output of logs in the console
+    print(f"Main config: {await pyaterochka_api.get_config(debug=True)!s:.100s}...\n")
+
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+### Report / Обратная связь
+
+If you have any problems using it /suggestions, do not hesitate to write to the [project's GitHub](https://github.com/Open-Inflation/pyaterochka_api/issues)!
+
+Если у вас возникнут проблемы в использовании / пожелания, не стесняйтесь писать на [GitHub проекта](https://github.com/Open-Inflation/pyaterochka_api/issues)!
+
+

pyaterochka_api-0.1.0/README.md

@@ -0,0 +1,37 @@
+# Pyaterochka API *(not official / не официальный)*
+
+Pyaterochka (Пятёрочка) - https://5ka.ru/
+
+### Usage / Использование:
+```py
+import pyaterochka_api
+import asyncio
+
+
+async def main():
+    # RUS: Выводит список всех категорий на сайте
+    # ENG: Outputs a list of all categories on the site
+    catalog = await pyaterochka_api.categories_list(subcategories=True)
+    print(f"Categories list output: {catalog!s:.100s}...\n")
+
+    # RUS: Выводит список всех товаров выбранной категории (ограничение 100 элементов, если превышает - запрашивайте через дополнительные страницы)
+    # ENG: Outputs a list of all items in the selected category (limiting to 100 elements, if exceeds - request through additional pages)
+    # Страниц не сущетвует, использовать желаемый лимит (до 499) / Pages do not exist, use the desired limit (up to 499)
+    print(f"Items list output: {await pyaterochka_api.products_list(catalog[0]['id'], limit=5)!s:.100s}...\n")
+
+    # RUS: Выводит основной конфиг сайта (очень долгая функция, рекомендую сохранять в файл и переиспользовать)
+    # ENG: Outputs the main config of the site (large function, recommend to save in a file and re-use it)
+    # RUS: Если требуется, можно настроить вывод логов в консоль
+    # ENG: If required, you can configure the output of logs in the console
+    print(f"Main config: {await pyaterochka_api.get_config(debug=True)!s:.100s}...\n")
+
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+### Report / Обратная связь
+
+If you have any problems using it /suggestions, do not hesitate to write to the [project's GitHub](https://github.com/Open-Inflation/pyaterochka_api/issues)!
+
+Если у вас возникнут проблемы в использовании / пожелания, не стесняйтесь писать на [GitHub проекта](https://github.com/Open-Inflation/pyaterochka_api/issues)!

pyaterochka_api-0.1.0/pyaterochka_api/__init__.py

@@ -0,0 +1,3 @@
+from .manager import PurchaseMode, categories_list, products_list, get_config
+
+__all__ = ['PurchaseMode', 'categories_list', 'products_list', 'get_config']

pyaterochka_api-0.1.0/pyaterochka_api/api.py

@@ -0,0 +1,116 @@
+import aiohttp
+from fake_useragent import UserAgent
+from enum import Enum
+import re
+from tqdm.asyncio import tqdm
+
+
+class Patterns(Enum):
+    JS = r'\s*let\s+n\s*=\s*({.*});\s*'
+    STR = r'(\w+)\s*:\s*"([^"\\]*(?:\\.[^"\\]*)*)"'
+    DICT = r'(\w+)\s*:\s*{(.*?)}'
+    LIST = r'(\w+)\s*:\s*\[([^\[\]]*(?:\[.*?\])*)\]'
+    FIND = r'\{.*?\}|\[.*?\]'
+
+
+
+async def main_fetch(url: str, debug: bool = False, is_json: bool = True) -> tuple[bool, dict | None]:
+    async with aiohttp.ClientSession() as session:
+        if debug:
+            print(f"Requesting \"{url}\"...", flush=True)
+
+        async with session.get(
+                url=url,
+                headers={"User-Agent": UserAgent().random},
+        ) as response:
+            if debug:
+                print(f"Response status: {response.status}", flush=True)
+
+            if response.status == 200: # 200 OK
+                if debug:
+                    print("Correct response", flush=True)
+                return True, await response.json() if is_json else await response.text()
+            elif response.status == 403: # 403 Forbidden (сервер воспринял как бота)
+                if debug:
+                    print("Anti-bot protection. Use Russia IP address and try again.", flush=True)
+                return False, None
+            else:
+                if debug:
+                    print(f"Please, create issue on GitHub", flush=True)
+                raise Exception(f"Response status: {response.status} (unknown error/status code)")
+
+async def download_hardcode_config(config_url: str, debug: bool = False) -> dict | None:
+    is_success, js_code = await main_fetch(url=config_url, debug=debug, is_json=False)
+
+    if not is_success:
+        if debug:
+            print("Failed to fetch JS code")
+        return None
+    elif debug:
+        print("JS code fetched successfully")
+
+    # Регулярное выражение для извлечения определения переменной n
+    matches = re.finditer(Patterns.JS.value, js_code)
+
+    match_list = list(matches)
+    if debug:
+        print(f"Found matches {len(match_list)}")
+
+    if debug:
+        progress_bar = tqdm(total=33, desc="Parsing JS", position=0) # примерно 33 операции
+
+    async def parse_match(match: str) -> dict:
+        result = {}
+
+        if debug:
+            # Обновление описания прогресса
+            progress_bar.set_description("Parsing strings")
+
+        # Парсинг строк
+        string_matches = re.finditer(Patterns.STR.value, match)
+        for m in string_matches:
+            key, value = m.group(1), m.group(2)
+            result[key] = value.replace('\"', '"').replace('\\\\', '\\')
+
+        if debug:
+            progress_bar.update(1)
+            # Обновление описания прогресса
+            progress_bar.set_description("Parsing dictionaries")
+
+        # Парсинг словарей
+        dict_matches = re.finditer(Patterns.DICT.value, match)
+        for m in dict_matches:
+            key, value = m.group(1), m.group(2)
+            if not re.search(Patterns.STR.value, value):
+                result[key] = await parse_match(value)
+
+        if debug:
+            progress_bar.update(1)
+            # Обновление описания прогресса
+            progress_bar.set_description("Parsing lists")
+
+        # Парсинг списков
+        list_matches = re.finditer(Patterns.LIST.value, match)
+        for m in list_matches:
+            key, value = m.group(1), m.group(2)
+            if not re.search(Patterns.STR.value, value):
+                result[key] = [await parse_match(item.group(0)) for item in re.finditer(Patterns.FIND.value, value)]
+
+        if debug:
+            # Обновление прогресса
+            progress_bar.update(1)
+
+        return result
+
+    if match_list and len(match_list) >= 1:  # нужная переменная идет второй из трех
+        if debug:
+            print("Starting to parse match")
+        result = await parse_match(match_list[1].group(0))
+        if debug:
+            progress_bar.close()
+        return result
+    else:
+        if debug:
+            progress_bar.close()
+        raise Exception("N variable in JS code not found")
+

pyaterochka_api-0.1.0/pyaterochka_api/manager.py

@@ -0,0 +1,82 @@
+from .api import main_fetch, download_hardcode_config
+from enum import Enum
+
+CATALOG_URL = "https://5d.5ka.ru/api/catalog/v2/stores"
+HARDCODE_JS_CONFIG = "https://prod-cdn.5ka.ru/scripts/main.a0c039ea81eb8cf69492.js" # TODO сделать не хардкодным имя файла
+
+class PurchaseMode(Enum):
+    STORE = "store"
+    DELIVERY = "delivery"
+
+
+async def categories_list(
+        subcategories: bool = False,
+        mode: PurchaseMode = PurchaseMode.STORE,
+        sap_code_store_id: str = "Y232",
+        debug: bool = False
+) -> dict | None:
+    """
+    Asynchronously retrieves a list of categories from the Pyaterochka API.
+
+    Args:
+        subcategories (bool, optional): Whether to include subcategories in the response. Defaults to False.
+        mode (PurchaseMode, optional): The purchase mode to use. Defaults to PurchaseMode.STORE.
+        sap_code_store_id (str, optional): The store ID (official name in API is "sap_code") to use. Defaults to "Y232". This lib not support search ID stores.
+        debug (bool, optional): Whether to print debug information. Defaults to False.
+
+    Returns:
+        dict | None: A dictionary representing the categories list if the request is successful, None otherwise.
+
+    Raises:
+        Exception: If the response status is not 200 (OK) or 403 (Forbidden / Anti-bot).
+    """
+
+    request_url = f"{CATALOG_URL}/{sap_code_store_id}/categories?mode={mode.value}&include_subcategories={1 if subcategories else 0}"
+    is_success, response = await main_fetch(url=request_url, debug=debug)
+    return response
+
+
+async def products_list(
+        category_id: int,
+        mode: PurchaseMode = PurchaseMode.STORE,
+        sap_code_store_id: str = "Y232",
+        limit: int = 30,
+        debug: bool = False
+) -> dict | None:
+    """
+    Asynchronously retrieves a list of products from the Pyaterochka API for a given category.
+
+    Args:
+        category_id (int): The ID of the category.
+        mode (PurchaseMode, optional): The purchase mode to use. Defaults to PurchaseMode.STORE.
+        sap_code_store_id (str, optional): The store ID (official name in API is "sap_code") to use. Defaults to "Y232". This lib not support search ID stores.
+        limit (int, optional): The maximum number of products to retrieve. Defaults to 30. Must be between 1 and 499.
+
+    Returns:
+        dict | None: A dictionary representing the products list if the request is successful, None otherwise.
+
+    Raises:
+        ValueError: If the limit is not between 1 and 499.
+        Exception: If the response status is not 200 (OK) or 403 (Forbidden / Anti-bot).
+    """
+
+    if limit < 1 or limit >= 500:
+        raise ValueError("Limit must be between 1 and 499")
+
+    request_url = f"{CATALOG_URL}/{sap_code_store_id}/categories/{category_id}/products?mode={mode.value}&limit={limit}"
+    is_success, response = await main_fetch(url=request_url, debug=debug)
+    return response
+
+
+async def get_config(debug: bool = False) -> list | None:
+    """
+    Asynchronously retrieves the configuration from the hardcoded JavaScript file.
+
+    Args:
+        debug (bool, optional): Whether to print debug information. Defaults to False.
+
+    Returns:
+        list | None: A list representing the configuration if the request is successful, None otherwise.
+    """
+
+    return await download_hardcode_config(config_url=HARDCODE_JS_CONFIG, debug=debug)

pyaterochka_api-0.1.0/pyaterochka_api.egg-info/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.1
+Name: pyaterochka-api
+Version: 0.1.0
+Summary: A Python API client for Pyaterochka store catalog
+Home-page: https://github.com/Open-Inflation/pyaterochka_api
+Author: Miskler
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Pyaterochka API *(not official / не официальный)*
+
+Pyaterochka (Пятёрочка) - https://5ka.ru/
+
+### Usage / Использование:
+```py
+import pyaterochka_api
+import asyncio
+
+
+async def main():
+    # RUS: Выводит список всех категорий на сайте
+    # ENG: Outputs a list of all categories on the site
+    catalog = await pyaterochka_api.categories_list(subcategories=True)
+    print(f"Categories list output: {catalog!s:.100s}...\n")
+
+    # RUS: Выводит список всех товаров выбранной категории (ограничение 100 элементов, если превышает - запрашивайте через дополнительные страницы)
+    # ENG: Outputs a list of all items in the selected category (limiting to 100 elements, if exceeds - request through additional pages)
+    # Страниц не сущетвует, использовать желаемый лимит (до 499) / Pages do not exist, use the desired limit (up to 499)
+    print(f"Items list output: {await pyaterochka_api.products_list(catalog[0]['id'], limit=5)!s:.100s}...\n")
+
+    # RUS: Выводит основной конфиг сайта (очень долгая функция, рекомендую сохранять в файл и переиспользовать)
+    # ENG: Outputs the main config of the site (large function, recommend to save in a file and re-use it)
+    # RUS: Если требуется, можно настроить вывод логов в консоль
+    # ENG: If required, you can configure the output of logs in the console
+    print(f"Main config: {await pyaterochka_api.get_config(debug=True)!s:.100s}...\n")
+
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+### Report / Обратная связь
+
+If you have any problems using it /suggestions, do not hesitate to write to the [project's GitHub](https://github.com/Open-Inflation/pyaterochka_api/issues)!
+
+Если у вас возникнут проблемы в использовании / пожелания, не стесняйтесь писать на [GitHub проекта](https://github.com/Open-Inflation/pyaterochka_api/issues)!
+
+

pyaterochka_api-0.1.0/pyaterochka_api.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+setup.py
+pyaterochka_api/__init__.py
+pyaterochka_api/api.py
+pyaterochka_api/manager.py
+pyaterochka_api.egg-info/PKG-INFO
+pyaterochka_api.egg-info/SOURCES.txt
+pyaterochka_api.egg-info/dependency_links.txt
+pyaterochka_api.egg-info/requires.txt
+pyaterochka_api.egg-info/top_level.txt

pyaterochka_api-0.1.0/pyaterochka_api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyaterochka_api-0.1.0/pyaterochka_api.egg-info/requires.txt

@@ -0,0 +1,4 @@
+aiohttp
+enum
+fake-useragent
+tqdm

pyaterochka_api-0.1.0/pyaterochka_api.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyaterochka_api

pyaterochka_api-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyaterochka_api-0.1.0/setup.py

@@ -0,0 +1,24 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='pyaterochka_api',
+    version='0.1.0',
+    packages=find_packages(),
+    install_requires=[
+        'aiohttp',
+        'fake-useragent',
+        'enum',
+        'tqdm'
+    ],
+    author='Miskler',
+    description='A Python API client for Pyaterochka store catalog',
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
+    url='https://github.com/Open-Inflation/pyaterochka_api',
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+    ],
+    python_requires='>=3.10',
+)