python-picnic-api2 1.2.4__tar.gz → 1.3.1__tar.gz

{python_picnic_api2-1.2.4 → python_picnic_api2-1.3.1}/.github/dependabot.yml

@@ -10,3 +10,11 @@ updates:
    directory: "/"
    schedule:
      interval: weekly
+ - package-ecosystem: "github-actions"
+   directory: "/"
+   schedule:
+     interval: "weekly"
+ - package-ecosystem: "pip"
+   directory: "/"
+   schedule:
+     interval: "weekly"

{python_picnic_api2-1.2.4 → python_picnic_api2-1.3.1}/.github/workflows/ci.yaml

@@ -17,10 +17,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 

{python_picnic_api2-1.2.4 → python_picnic_api2-1.3.1}/.github/workflows/it.yaml

@@ -11,10 +11,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: Set up Python 3.12
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: 3.12
 

{python_picnic_api2-1.2.4 → python_picnic_api2-1.3.1}/.github/workflows/release.yml

@@ -4,10 +4,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
   
     - name: Set up Python 3.11
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: 3.11
   

{python_picnic_api2-1.2.4 → python_picnic_api2-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-picnic-api2
-Version: 1.2.4
+Version: 1.3.1
 Project-URL: homepage, https://github.com/codesalatdev/python-picnic-api
 Project-URL: repository, https://github.com/codesalatdev/python-picnic-api
 Author-email: Mike Brink <mjh.brink@icloud.com>, CodeSalat <pypi@codesalat.dev>

python_picnic_api2-1.3.1/README.md

@@ -0,0 +1,102 @@
+# Python-Picnic-API
+
+**This library is undergoing rapid changes as is the Picnic API itself. It is mainly intended for use within Home Assistant, but there are integration tests running regularly checking for failures in features not used bu the Home Assistant integration**
+
+Fork of the Unofficial Python wrapper for the [Picnic](https://picnic.app) 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.**
+
+## Credits
+
+A big thanks to @MikeBrink for building the first versions of this library.
+
+@maartenpaul and @thijmen-j continously provided fixes that were then merged into this fork.
+
+## Getting started
+
+The easiest way to install is directly from pip:
+
+```bash
+$ pip install python-picnic-api2
+```
+
+Then create a new instance of `PicnicAPI` and login using your credentials:
+
+```python
+from python_picnic_api2 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 (ISO 3166-1 Alpha-2). This obviously only works for countries that picnic services.
+
+## Searching for an article
+
+```python
+picnic.search('coffee')
+```
+
+```python
+[{'items': [{'id': 's1019822', 'name': 'Lavazza Caffè Crema e Aroma Bohnen', 'decorators': [], 'display_price': 1799, 'image_id': 'aecbf7d3b018025ec78daf5a1099b6842a860a2e3faeceec777c13d708ce442c', 'max_count': 99, 'unit_quantity': '1kg', 'sole_article_id': None}, ... ]}]
+```
+
+## Get article by ID
+
+```python
+picnic.get_article("s1019822")
+```
+```python
+{'name': 'Lavazza Caffè Crema e Aroma Bohnen', 'id': 's1019822'}
+```
+
+## Get article by GTIN (EAN)
+```python
+picnic.get_article_by_gtin("8000070025400")
+```
+```python
+{'name': 'Lavazza Caffè Crema e Aroma Bohnen', 'id': 's1019822'}
+```
+
+## Check cart
+
+```python
+picnic.get_cart()
+```
+
+```python
+{'type': 'ORDER', 'id': 'shopping_cart', 'items': [{'type': 'ORDER_LINE', 'id': '1470', 'items': [{'type': 'ORDER_ARTICLE', 'id': 's1019822', 'name': 'Lavazza Caffè Crema e Aroma Bohnen',...
+```
+
+## Manipulating your cart
+All of these methods will return the shopping cart.
+
+```python
+# Add product with ID "s1019822" 2x
+picnic.add_product("s1019822", 2)
+
+# Remove product with ID "s1019822" 1x
+picnic.remove_product("s1019822")
+
+# Clear your cart
+picnic.clear_cart()
+```
+
+## See upcoming deliveries
+
+```python
+picnic.get_current_deliveries()
+```
+
+```python
+[{'delivery_id': 'XXYYZZ', 'creation_time': '2025-04-28T08:08:41.666+02:00', 'slot': {'slot_id': 'XXYYZZ', 'hub_id': '...
+```
+
+## See available delivery slots
+
+```python
+picnic.get_delivery_slots()
+```
+
+```python
+{'delivery_slots': [{'slot_id': 'XXYYZZ', 'hub_id': 'YYY', 'fc_id': 'FCX', 'window_start': '2025-04-29T17:15:00.000+02:00', 'window_end': '2025-04-29T19:15:00.000+02:00'...
+```

{python_picnic_api2-1.2.4 → python_picnic_api2-1.3.1}/integration_tests/test_client.py

@@ -56,6 +56,17 @@ def test_get_article_with_category_name():
         picnic.get_article("s1018620", add_category_name=True)
 
 
+def test_get_article_by_gtin():
+    response = picnic.get_article_by_gtin("4311501044209")
+    assert response["id"] == "s1018620"
+    assert response["name"] == "Gut&Günstig H-Milch 3,5%"
+
+
+def test_get_article_by_gtin_unknown():
+    response = picnic.get_article_by_gtin("4311501040000")
+    assert response is None
+
+
 def test_get_cart():
     response = picnic.get_cart()
     assert isinstance(response, dict)

{python_picnic_api2-1.2.4 → python_picnic_api2-1.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-picnic-api2"
-version = "1.2.4"
+version = "1.3.1"
 description = ""
 readme = "README.rst"
 license = {text = "Apache-2.0"}

{python_picnic_api2-1.2.4 → python_picnic_api2-1.3.1}/src/python_picnic_api2/client.py

@@ -15,6 +15,10 @@ 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"
+_HEADERS = {
+    "x-picnic-agent": "30100;1.15.272-15295;",
+    "x-picnic-did": "3C417201548B2E3B",
+}
 
 
 class PicnicAPI:
@@ -47,14 +51,7 @@ class PicnicAPI:
         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
-        )
+        headers = _HEADERS if add_picnic_headers else None
         response = self.session.get(url, headers=headers).json()
 
         if self._contains_auth_error(response):
@@ -117,7 +114,7 @@ class PicnicAPI:
             return None
 
         color_regex = re.compile(r"#\(#\d{6}\)")
-        producer = re.sub(color_regex, "", str(article_details[1]["markdown"]))
+        producer = re.sub(color_regex, "", str(article_details[1].get("markdown", "")))
         article_name = re.sub(color_regex, "", str(article_details[0]["markdown"]))
 
         article = {"name": f"{producer} {article_name}", "id": article_id}
@@ -177,5 +174,24 @@ class PicnicAPI:
         tree = "\n".join(_tree_generator(self.get_categories(depth=depth)))
         print(tree)
 
+    def get_article_by_gtin(self, etan: str, maxRedirects: int = 5):
+        # Finds the article ID for a gtin/ean (barcode).
+
+        url = "https://picnic.app/" + self._country_code.lower() + "/qr/gtin/" + etan
+        while maxRedirects > 0:
+            if url == "http://picnic.app/nl/link/store/storefront":
+                # gtin unknown
+                return None
+            r = self.session.get(url, headers=_HEADERS, allow_redirects=False)
+            maxRedirects -= 1
+            if ";id=" in r.url:
+                # found the article id
+                return self.get_article(r.url.split(";id=", 1)[1])
+            if "Location" not in r.headers:
+                # article id not found but also no futher redirect
+                return None
+            url = r.headers["Location"]
+        return None
+
 
 __all__ = ["PicnicAPI"]

{python_picnic_api2-1.2.4 → python_picnic_api2-1.3.1}/tests/test_client.py

@@ -23,7 +23,8 @@ class TestClient(unittest.TestCase):
             return self.json_data
 
     def setUp(self) -> None:
-        self.session_patcher = patch("python_picnic_api2.client.PicnicAPISession")
+        self.session_patcher = patch(
+            "python_picnic_api2.client.PicnicAPISession")
         self.session_mock = self.session_patcher.start()
         self.client = PicnicAPI(username="test@test.nl", password="test")
         self.expected_base_url = DEFAULT_URL.format("nl", "15")
@@ -106,6 +107,21 @@ class TestClient(unittest.TestCase):
             headers=PICNIC_HEADERS,
         )
 
+    def test_get_article(self):
+        self.client.get_article("p3f2qa")
+        self.session_mock().get.assert_called_with(
+            "https://storefront-prod.nl.picnicinternational.com/api/15/pages/product-details-page-root?id=p3f2qa",
+            headers=PICNIC_HEADERS,
+        )
+
+    def test_get_article_by_gtin(self):
+        self.client.get_article_by_gtin("123456789")
+        self.session_mock().get.assert_called_with(
+            "https://picnic.app/nl/qr/gtin/123456789",
+            headers=PICNIC_HEADERS,
+            allow_redirects=False,
+        )
+
     def test_get_cart(self):
         self.client.get_cart()
         self.session_mock().get.assert_called_with(

{python_picnic_api2-1.2.4 → python_picnic_api2-1.3.1}/uv.lock

@@ -197,7 +197,7 @@ wheels = [
 
 [[package]]
 name = "python-picnic-api2"
-version = "1.2.4"
+version = "1.3.1"
 source = { editable = "." }
 dependencies = [
     { name = "requests" },