python-picnic-api2 1.1.0__tar.gz

python_picnic_api2-1.1.0/LICENSE.md

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

python_picnic_api2-1.1.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.3
+Name: python-picnic-api2
+Version: 1.1.0
+Summary: 
+License: Apache-2.0
+Author: Mike Brink
+Author-email: mjh.brink@icloud.com
+Requires-Python: >=3.6,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: requests (>=2.24.0,<3.0.0)
+Project-URL: Repository, https://github.com/codesalatdev/python-picnic-api
+Description-Content-Type: text/x-rst
+
+"""""""""""""""""
+Python-Picnic-API
+"""""""""""""""""
+
+.. image:: https://camo.githubusercontent.com/cd005dca0ef55d7725912ec03a936d3a7c8de5b5/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6275792532306d6525323061253230636f666665652d646f6e6174652d79656c6c6f772e737667
+    :target: https://www.buymeacoffee.com/MikeBrink
+    :alt: Buy me a coffee
+
+Unofficial Python wrapper for the Picnic_ API. While not all API methods have been implemented yet, you'll find most of what you need to build a working application are available. 
+
+This library is not affiliated with Picnic and retrieves data from the endpoints of the mobile application. Use at your own risk.
+
+.. _Picnic: https://picnic.app/nl/
+
+===============
+Getting started
+===============
+The easiest way to install is directly from pip::
+
+    $ pip install python-picnic-api
+
+
+-----
+Usage
+-----
+I'll go over a few common operations here you'll most likely use in applications. 
+To login:
+
+.. code-block:: python
+
+    from python_picnic_api import PicnicAPI
+
+    picnic = PicnicAPI(username='username', password='password', country_code="NL")
+
+The country_code parameter defaults to NL, but you have to change it if you live in a different country than the Netherlands (Germany: DE, Belgium: BE).
+You can also store your credentials by setting the store value to true, this will store your credentials and country_code in /config/app.yaml. 
+
+Searching for a product
+-----------------------
+.. code-block:: python
+
+    >>> picnic.search('coffee')
+    [{'type': 'CATEGORY', 'id': 'coffee', 'links': [{'type': 'SEARCH', 'href': 'https://storefront-prod.nl.picnicinternational.com/api/15/search?search_term=coffee'}], 'name': 'coffee', 'items': [{'type': 'SINGLE_ARTICLE', 'id': '10511523', 'decorators': [{'type': 'UNIT_QUANTITY', 'unit_quantity_text': '500 gram'}], 'name': 'Lavazza espresso koffiebonen', 'display_price': 599, 'price': 599, 'image_id': 'd3fb2888fc41514bc06dfd6b52f8622cc222d017d2651501f227a537915fcc4f', 'max_count': 50, 'unit_quantity': '500 gram', 'unit_quantity_sub': '€11.98/kg', 'tags': []}, ... 
+
+Check cart
+----------
+.. code-block:: python
+
+    >>> picnic.get_cart()
+    {'type': 'ORDER', 'id': 'shopping_cart', 'items': [], 'delivery_slots': [...
+
+
+Manipulating your cart
+----------------------
+All of these methods will return the shopping cart.
+
+.. code-block:: python
+
+    # adding 2 'Lavazza espresso koffiebonen' to cart
+    picnic.add_product('10511523', count=2)
+
+    # removing 1 'Lavazza espresso koffiebonen' from cart
+    picnic.remove_product('10511523')
+
+    # clearing the cart
+    picnic.clear_cart()
+
+See upcoming deliveries
+------------------------
+.. code-block:: python
+
+    >>> picnic.get_current_deliveries()
+    []
+
+
+See available delivery slots
+----------------------------
+.. code-block:: python
+
+    >>> picnic.get_delivery_slots()
+
+

python_picnic_api2-1.1.0/README.rst

@@ -0,0 +1,81 @@
+"""""""""""""""""
+Python-Picnic-API
+"""""""""""""""""
+
+.. image:: https://camo.githubusercontent.com/cd005dca0ef55d7725912ec03a936d3a7c8de5b5/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6275792532306d6525323061253230636f666665652d646f6e6174652d79656c6c6f772e737667
+    :target: https://www.buymeacoffee.com/MikeBrink
+    :alt: Buy me a coffee
+
+Unofficial Python wrapper for the Picnic_ API. While not all API methods have been implemented yet, you'll find most of what you need to build a working application are available. 
+
+This library is not affiliated with Picnic and retrieves data from the endpoints of the mobile application. Use at your own risk.
+
+.. _Picnic: https://picnic.app/nl/
+
+===============
+Getting started
+===============
+The easiest way to install is directly from pip::
+
+    $ pip install python-picnic-api
+
+
+-----
+Usage
+-----
+I'll go over a few common operations here you'll most likely use in applications. 
+To login:
+
+.. code-block:: python
+
+    from python_picnic_api import PicnicAPI
+
+    picnic = PicnicAPI(username='username', password='password', country_code="NL")
+
+The country_code parameter defaults to NL, but you have to change it if you live in a different country than the Netherlands (Germany: DE, Belgium: BE).
+You can also store your credentials by setting the store value to true, this will store your credentials and country_code in /config/app.yaml. 
+
+Searching for a product
+-----------------------
+.. code-block:: python
+
+    >>> picnic.search('coffee')
+    [{'type': 'CATEGORY', 'id': 'coffee', 'links': [{'type': 'SEARCH', 'href': 'https://storefront-prod.nl.picnicinternational.com/api/15/search?search_term=coffee'}], 'name': 'coffee', 'items': [{'type': 'SINGLE_ARTICLE', 'id': '10511523', 'decorators': [{'type': 'UNIT_QUANTITY', 'unit_quantity_text': '500 gram'}], 'name': 'Lavazza espresso koffiebonen', 'display_price': 599, 'price': 599, 'image_id': 'd3fb2888fc41514bc06dfd6b52f8622cc222d017d2651501f227a537915fcc4f', 'max_count': 50, 'unit_quantity': '500 gram', 'unit_quantity_sub': '€11.98/kg', 'tags': []}, ... 
+
+Check cart
+----------
+.. code-block:: python
+
+    >>> picnic.get_cart()
+    {'type': 'ORDER', 'id': 'shopping_cart', 'items': [], 'delivery_slots': [...
+
+
+Manipulating your cart
+----------------------
+All of these methods will return the shopping cart.
+
+.. code-block:: python
+
+    # adding 2 'Lavazza espresso koffiebonen' to cart
+    picnic.add_product('10511523', count=2)
+
+    # removing 1 'Lavazza espresso koffiebonen' from cart
+    picnic.remove_product('10511523')
+
+    # clearing the cart
+    picnic.clear_cart()
+
+See upcoming deliveries
+------------------------
+.. code-block:: python
+
+    >>> picnic.get_current_deliveries()
+    []
+
+
+See available delivery slots
+----------------------------
+.. code-block:: python
+
+    >>> picnic.get_delivery_slots()
+

python_picnic_api2-1.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[tool.poetry]
+name = "python-picnic-api2"
+version = "1.1.0"
+description = ""
+license = "Apache-2.0"
+authors = ["Mike Brink <mjh.brink@icloud.com>", "Noah Groß <pypi@codesalat.dev>"]
+readme = "README.rst"
+repository = "https://github.com/codesalatdev/python-picnic-api"
+
+[tool.poetry.dependencies]
+python = "^3.6"
+requests = "^2.24.0"
+
+[tool.poetry.dev-dependencies]
+pytest = "^5.2"
+flake8 = "^3.8.3"
+black = {version = "^19.10b0", allow-prereleases = true}
+python-dotenv = "^0.15.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

python_picnic_api2-1.1.0/python_picnic_api2/__init__.py

@@ -0,0 +1,6 @@
+from .client import PicnicAPI
+
+__all__ = ["PicnicAPI"]
+__title__ = "python-picnic-api"
+__version__ = "1.1.0"
+__author__ = "Mike Brink"

python_picnic_api2-1.1.0/python_picnic_api2/client.py

@@ -0,0 +1,164 @@
+from hashlib import md5
+
+from .helper import _tree_generator, _url_generator, _get_category_name, _extract_search_results
+from .session import PicnicAPISession, PicnicAuthError
+
+DEFAULT_URL = "https://storefront-prod.{}.picnicinternational.com/api/{}"
+GLOBAL_GATEWAY_URL = "https://gateway-prod.global.picnicinternational.com"
+DEFAULT_COUNTRY_CODE = "NL"
+DEFAULT_API_VERSION = "15"
+
+
+class PicnicAPI:
+    def __init__(
+        self, username: str = None, password: str = None,
+        country_code: str = DEFAULT_COUNTRY_CODE, auth_token: str = None
+    ):
+        self._country_code = country_code
+        self._base_url = _url_generator(
+            DEFAULT_URL, self._country_code, DEFAULT_API_VERSION
+        )
+
+        self.session = PicnicAPISession(auth_token=auth_token)
+
+        # Login if not authenticated
+        if not self.session.authenticated and username and password:
+            self.login(username, password)
+
+        self.high_level_categories = None
+
+    def initialize_high_level_categories(self):
+        """Initialize high-level categories once to avoid multiple requests."""
+        if not self.high_level_categories:
+            self.high_level_categories = self.get_categories(depth=1)
+
+    def _get(self, path: str, add_picnic_headers=False):
+        url = self._base_url + path
+
+        # Make the request, add special picnic headers if needed
+        headers = {
+            "x-picnic-agent": "30100;1.15.272-15295;",
+            "x-picnic-did": "3C417201548B2E3B"
+        } if add_picnic_headers else None
+        response = self.session.get(url, headers=headers).json()
+
+        if self._contains_auth_error(response):
+            raise PicnicAuthError("Picnic authentication error")
+
+        return response
+
+    def _post(self, path: str, data=None, base_url_override=None):
+        url = (self._base_url if not base_url_override else base_url_override) + path
+        response = self.session.post(url, json=data).json()
+
+        if self._contains_auth_error(response):
+            raise PicnicAuthError(f"Picnic authentication error: {response['error'].get('message')}")
+
+        return response
+
+    @staticmethod
+    def _contains_auth_error(response):
+        if not isinstance(response, dict):
+            return False
+
+        error_code = response.setdefault("error", {}).get("code")
+        return error_code == "AUTH_ERROR" or error_code == "AUTH_INVALID_CRED"
+
+    def login(self, username: str, password: str):
+        path = "/user/login"
+        secret = md5(password.encode("utf-8")).hexdigest()
+        data = {"key": username, "secret": secret, "client_id": 30100}
+
+        return self._post(path, data)
+
+    def logged_in(self):
+        return self.session.authenticated
+
+    def get_user(self):
+        return self._get("/user")
+
+    def search(self, term: str):
+        path = f"/pages/search-page-results?search_term={term}"
+        raw_results = self._get(path, add_picnic_headers=True)
+        return _extract_search_results(raw_results)
+
+    def get_lists(self, list_id: str = None):
+        if list_id:
+            path = "/lists/" + list_id
+        else:
+            path = "/lists"
+        return self._get(path)
+
+    def get_sublist(self, list_id: str, sublist_id: str) -> list:
+        """Get sublist.
+
+        Args:
+            list_id (str): ID of list, corresponding to requested sublist.
+            sublist_id (str): ID of sublist.
+
+        Returns:
+            list: Sublist result.
+        """
+        return self._get(f"/lists/{list_id}?sublist={sublist_id}")
+
+    def get_cart(self):
+        return self._get("/cart")
+
+    def get_article(self, article_id: str, add_category_name=False):
+        path = "/articles/" + article_id
+        article = self._get(path)
+        if add_category_name and "category_link" in article:
+            self.initialize_high_level_categories()
+            article.update(
+                category_name=_get_category_name(article['category_link'], self.high_level_categories)
+            )
+        return article
+
+    def get_article_category(self, article_id: str):
+        path = "/articles/" + article_id + "/category"
+        return self._get(path)
+
+    def add_product(self, product_id: str, count: int = 1):
+        data = {"product_id": product_id, "count": count}
+        return self._post("/cart/add_product", data)
+
+    def remove_product(self, product_id: str, count: int = 1):
+        data = {"product_id": product_id, "count": count}
+        return self._post("/cart/remove_product", data)
+
+    def clear_cart(self):
+        return self._post("/cart/clear")
+
+    def get_delivery_slots(self):
+        return self._get("/cart/delivery_slots")
+
+    def get_delivery(self, delivery_id: str):
+        path = "/deliveries/" + delivery_id
+        return self._get(path)
+
+    def get_delivery_scenario(self, delivery_id: str):
+        path = "/deliveries/" + delivery_id + "/scenario"
+        return self._get(path, add_picnic_headers=True)
+
+    def get_delivery_position(self, delivery_id: str):
+        path = "/deliveries/" + delivery_id + "/position"
+        return self._get(path, add_picnic_headers=True)
+
+    def get_deliveries(self, summary: bool = False, data=None):
+        data = [] if data is None else data
+        if summary:
+            return self._post("/deliveries/summary", data=data)
+        return self._post("/deliveries", data=data)
+
+    def get_current_deliveries(self):
+        return self.get_deliveries(data=["CURRENT"])
+
+    def get_categories(self, depth: int = 0):
+        return self._get(f"/my_store?depth={depth}")["catalog"]
+
+    def print_categories(self, depth: int = 0):
+        tree = "\n".join(_tree_generator(self.get_categories(depth=depth)))
+        print(tree)
+
+
+__all__ = ["PicnicAPI"]

python_picnic_api2-1.1.0/python_picnic_api2/helper.py

@@ -0,0 +1,111 @@
+import json
+import re
+from typing import List, Dict, Any, Optional
+
+# prefix components:
+space = "    "
+branch = "│   "
+# pointers:
+tee = "├── "
+last = "└── "
+
+IMAGE_SIZES = ["small", "medium", "regular", "large", "extra-large"]
+IMAGE_BASE_URL = "https://storefront-prod.nl.picnicinternational.com/static/images"
+
+SOLE_ARTICLE_ID_PATTERN = re.compile(r'"sole_article_id":"(\w+)"')
+
+
+def _tree_generator(response: list, prefix: str = ""):
+    """A recursive tree generator,
+    will yield a visual tree structure line by line
+    with each line prefixed by the same characters
+    """
+    # response each get pointers that are ├── with a final └── :
+    pointers = [tee] * (len(response) - 1) + [last]
+    for pointer, item in zip(pointers, response):
+        if "name" in item:  # print the item
+            pre = ""
+            if "unit_quantity" in item.keys():
+                pre = f"{item['unit_quantity']} "
+            after = ""
+            if "display_price" in item.keys():
+                after = f" €{int(item['display_price'])/100.0:.2f}"
+
+            yield prefix + pointer + pre + item["name"] + after
+        if "items" in item:  # extend the prefix and recurse:
+            extension = branch if pointer == tee else space
+            # i.e. space because last, └── , above so no more |
+            yield from _tree_generator(item["items"], prefix=prefix + extension)
+
+
+def _url_generator(url: str, country_code: str, api_version: str):
+    return url.format(country_code.lower(), api_version)
+
+
+def _get_category_id_from_link(category_link: str) -> Optional[str]:
+    pattern = r"categories/(\d+)"
+    first_number = re.search(pattern, category_link)
+    if first_number:
+        result = str(first_number.group(1))
+        return result
+    else:
+        return None
+
+
+def _get_category_name(category_link: str, categories: list) -> Optional[str]:
+    category_id = _get_category_id_from_link(category_link)
+    if category_id:
+        category = next(
+            (item for item in categories if item["id"] == category_id), None
+        )
+        if category:
+            return category["name"]
+        else:
+            return None
+    else:
+        return None
+
+
+def get_recipe_image(id: str, size="regular"):
+    sizes = IMAGE_SIZES + ["1250x1250"]
+    assert size in sizes, "size must be one of: " + ", ".join(sizes)
+    return f"{IMAGE_BASE_URL}/recipes/{id}/{size}.png"
+
+
+def get_image(id: str, size="regular", suffix="webp"):
+    assert (
+        "tile" in size if suffix == "webp" else True
+    ), "webp format only supports tile sizes"
+    assert suffix in ["webp", "png"], "suffix must be webp or png"
+    sizes = IMAGE_SIZES + [f"tile-{size}" for size in IMAGE_SIZES]
+
+    assert size in sizes, "size must be one of: " + ", ".join(sizes)
+    return f"{IMAGE_BASE_URL}/{id}/{size}.{suffix}"
+
+def _extract_search_results(raw_results, max_items: int = 10):
+    """Extract search results from the nested dictionary structure returned by Picnic search.
+    Number of max items can be defined to reduce excessive nested search"""
+    search_results = []
+    
+    def find_articles(node):
+        if len(search_results) >= max_items:
+            return
+        
+        content = node.get("content", {})
+        if content.get("type") == "SELLING_UNIT_TILE" and "sellingUnit" in content:
+            selling_unit = content["sellingUnit"]
+            sole_article_ids = SOLE_ARTICLE_ID_PATTERN.findall(json.dumps(node))
+            sole_article_id = sole_article_ids[0] if sole_article_ids else None
+            result_entry = {
+                **selling_unit,
+                "sole_article_id": sole_article_id,
+            }
+            search_results.append(result_entry)
+        
+        for child in node.get("children", []):
+            find_articles(child)
+
+    body = raw_results.get("body", {})
+    find_articles(body.get("child", {}))
+    
+    return [{"items": search_results}]

python_picnic_api2-1.1.0/python_picnic_api2/session.py

@@ -0,0 +1,54 @@
+from requests import Response, Session
+
+
+class PicnicAuthError(Exception):
+    """Indicates an error when authenticating to the Picnic API."""
+
+
+class PicnicAPISession(Session):
+    AUTH_HEADER = "x-picnic-auth"
+
+    def __init__(self, auth_token: str = None):
+        super().__init__()
+        self._auth_token = auth_token
+
+        self.headers.update(
+            {
+                "User-Agent": "okhttp/3.9.0",
+                "Content-Type": "application/json; charset=UTF-8",
+                self.AUTH_HEADER: self._auth_token
+            }
+        )
+
+    @property
+    def authenticated(self):
+        """Returns whether the user is authenticated by checking if the authentication token is set."""
+        return bool(self._auth_token)
+
+    @property
+    def auth_token(self):
+        """Returns the auth token."""
+        return self._auth_token
+
+    def _update_auth_token(self, auth_token):
+        """Update the auth token if not None and changed."""
+        if auth_token and auth_token != self._auth_token:
+            self._auth_token = auth_token
+            self.headers.update({self.AUTH_HEADER: self._auth_token})
+
+    def get(self, url, **kwargs) -> Response:
+        """Do a GET request and update the auth token if set."""
+        response = super(PicnicAPISession, self).get(url, **kwargs)
+        self._update_auth_token(response.headers.get(self.AUTH_HEADER))
+
+        return response
+
+    def post(self, url, data=None, json=None, **kwargs) -> Response:
+        """Do a POST request and update the auth token if set."""
+        response = super(PicnicAPISession, self).post(url, data, json, **kwargs)
+        self._update_auth_token(response.headers.get(self.AUTH_HEADER))
+
+        return response
+
+
+__all__ = ["PicnicAuthError", "PicnicAPISession"]