sokpy 0.1.0__tar.gz

sokpy-0.1.0/LICENSE

@@ -0,0 +1,8 @@
+
+Copyright 2026 Collectseal120
+
+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.

sokpy-0.1.0/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.4
+Name: sokpy
+Version: 0.1.0
+Summary: Unofficial Python wrapper for SOK / S-Kaupat APIs
+Author: Collectseal120
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Collectseal120/sokpy
+Project-URL: Repository, https://github.com/Collectseal120/sokpy
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: beautifulsoup4
+Dynamic: license-file
+
+# sokpy
+
+A Python wrapper for the SOK (S-Group) API, providing easy access to store information, product data, and pricing from Finnish S-Group stores.
+
+## Features
+
+- **Store Management**: Retrieve information about S-Group stores by brand or location
+- **Product Information**: Get detailed product data including pricing, availability, and specifications
+- **Pricing Data**: Access current prices, campaign prices, and historical pricing information
+- **Category Browsing**: Browse products by categories within specific stores
+
+## Installation
+
+```bash
+pip install sokpy
+```
+
+## Quick Start
+
+```python
+from sokpy import SOKAPI
+
+# Initialize the API
+api = SOKAPI()
+
+# Get a product by ID
+product = api.get_product_by_id("some-product-id")
+print(f"Product: {product.name}")
+print(f"Price: {product.price} €")
+
+# Get stores by brand
+stores = api.get_stores_by_brand("S-Market")
+for store in stores[:5]:  # Show first 5 stores
+    print(f"Store: {store.name} - {store.location}")
+
+# Get a specific store
+store = api.get_store_by_id("some-store-id")
+print(f"Store: {store.name}")
+print(f"Opening hours: {store.weeklyOpeningHours}")
+```
+
+## API Reference
+
+### SOKAPI
+
+The main API class for interacting with SOK services.
+
+#### Methods
+
+- `get_product_by_id(product_id: str) -> SOKProduct`: Retrieve a product by its ID
+- `get_all_stores() -> dict`: Get all stores organized by brand
+- `get_stores_by_brand(brand: str) -> list[SOKStore]`: Get stores for a specific brand
+- `get_store_by_id(store_id: str) -> SOKStore`: Get a specific store by ID
+
+### SOKProduct
+
+Represents a product with detailed information.
+
+#### Attributes
+
+- `product_id`: Unique product identifier
+- `sokId`: SOK-specific product ID
+- `name`: Product name
+- `price`: Current price
+- `availability`: Product availability status
+- `pricing`: SOKPricing object with detailed pricing information
+- `basicQuantityUnit`: Unit of measurement
+- `comparisonPrice`: Price per comparison unit
+- `comparisonUnit`: Unit for price comparison
+- `priceUnit`: Unit for pricing
+- `isAgeLimitedByAlcohol`: Whether the product is age-restricted
+- `frozen`: Whether the product is frozen
+- `packagingLabelCodes`: List of packaging label codes
+- `brandName`: Brand name
+- `packagingLabels`: List of packaging labels
+- `slug`: URL slug for the product
+
+### SOKPricing
+
+Contains detailed pricing information for a product.
+
+#### Attributes
+
+- `campaignPrice`: Current campaign price
+- `lowest30DayPrice`: Lowest price in the last 30 days
+- `campaignPriceValidUntil`: Campaign validity date
+- `regularPrice`: Regular price
+- `currentPrice`: Current price
+- `salesUnit`: Unit for sales
+- `comparisonPrice`: Price for comparison
+- `comparisonUnit`: Unit for comparison
+- `isApproximatePrice`: Whether price is approximate
+- `depositPrice`: Deposit price
+- `quantityMultiplier`: Quantity multiplier
+
+### SOKStore
+
+Represents a store with location and product information.
+
+#### Attributes
+
+- `store_id`: Unique store identifier
+- `slug`: URL slug
+- `name`: Store name
+- `brand`: Store brand (e.g., "S-Market", "Prisma")
+- `domains`: List of domains
+- `location`: Street address
+- `postcode`: Postal code
+- `postcodeName`: City name
+- `weeklyOpeningHours`: Opening hours for each day
+- `categories`: SOKCategories object for browsing products
+
+#### Methods
+
+- `get_filtered_products(slug: str, limit: int = 10) -> list[SOKProduct]`: Get products from a specific category
+
+## Examples
+
+### Finding Stores Near You
+
+```python
+api = SOKAPI()
+
+# Get all Prisma stores
+prisma_stores = api.get_stores_by_brand("Prisma")
+print(f"Found {len(prisma_stores)} Prisma stores")
+
+# Display store information
+for store in prisma_stores[:3]:
+    print(f"{store.name} - {store.location}, {store.postcode} {store.postcodeName}")
+```
+
+### Product Price Comparison
+
+```python
+api = SOKAPI()
+
+product = api.get_product_by_id("example-product-id")
+
+if product.pricing:
+    pricing = product.pricing
+    print(f"Product: {product.name}")
+    print(f"Regular Price: {pricing.regularPrice} €")
+    print(f"Current Price: {pricing.currentPrice} €")
+    if pricing.campaignPrice:
+        print(f"Campaign Price: {pricing.campaignPrice} € (valid until {pricing.campaignPriceValidUntil})")
+    print(f"Lowest 30-day Price: {pricing.lowest30DayPrice} €")
+```
+
+### Browsing Store Categories
+
+```python
+api = SOKAPI()
+store = api.get_store_by_id("example-store-id")
+
+# Get products from a specific category
+dairy_products = store.get_filtered_products("maito-tuotteet", limit=20)
+for product in dairy_products:
+    print(f"{product.name}: {product.price} €")
+```
+
+or
+
+```python
+api = SOKAPI()
+store = api.get_store_by_id("example-store-id")
+
+#Get products from a specific category
+chewing_gums = store.categories.karkit_ja_suklaat.purukumit.products()
+
+for product in chewing_gums:
+    print(f"{product.name}: {product.price} €")
+```
+
+## Requirements
+
+- Python 3.7+
+- requests
+- beautifulsoup4
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Disclaimer
+
+This package is not officially affiliated with S-Group or SOK. Use responsibly and in accordance with S-Group's terms of service.

sokpy-0.1.0/README.md

@@ -0,0 +1,191 @@
+# sokpy
+
+A Python wrapper for the SOK (S-Group) API, providing easy access to store information, product data, and pricing from Finnish S-Group stores.
+
+## Features
+
+- **Store Management**: Retrieve information about S-Group stores by brand or location
+- **Product Information**: Get detailed product data including pricing, availability, and specifications
+- **Pricing Data**: Access current prices, campaign prices, and historical pricing information
+- **Category Browsing**: Browse products by categories within specific stores
+
+## Installation
+
+```bash
+pip install sokpy
+```
+
+## Quick Start
+
+```python
+from sokpy import SOKAPI
+
+# Initialize the API
+api = SOKAPI()
+
+# Get a product by ID
+product = api.get_product_by_id("some-product-id")
+print(f"Product: {product.name}")
+print(f"Price: {product.price} €")
+
+# Get stores by brand
+stores = api.get_stores_by_brand("S-Market")
+for store in stores[:5]:  # Show first 5 stores
+    print(f"Store: {store.name} - {store.location}")
+
+# Get a specific store
+store = api.get_store_by_id("some-store-id")
+print(f"Store: {store.name}")
+print(f"Opening hours: {store.weeklyOpeningHours}")
+```
+
+## API Reference
+
+### SOKAPI
+
+The main API class for interacting with SOK services.
+
+#### Methods
+
+- `get_product_by_id(product_id: str) -> SOKProduct`: Retrieve a product by its ID
+- `get_all_stores() -> dict`: Get all stores organized by brand
+- `get_stores_by_brand(brand: str) -> list[SOKStore]`: Get stores for a specific brand
+- `get_store_by_id(store_id: str) -> SOKStore`: Get a specific store by ID
+
+### SOKProduct
+
+Represents a product with detailed information.
+
+#### Attributes
+
+- `product_id`: Unique product identifier
+- `sokId`: SOK-specific product ID
+- `name`: Product name
+- `price`: Current price
+- `availability`: Product availability status
+- `pricing`: SOKPricing object with detailed pricing information
+- `basicQuantityUnit`: Unit of measurement
+- `comparisonPrice`: Price per comparison unit
+- `comparisonUnit`: Unit for price comparison
+- `priceUnit`: Unit for pricing
+- `isAgeLimitedByAlcohol`: Whether the product is age-restricted
+- `frozen`: Whether the product is frozen
+- `packagingLabelCodes`: List of packaging label codes
+- `brandName`: Brand name
+- `packagingLabels`: List of packaging labels
+- `slug`: URL slug for the product
+
+### SOKPricing
+
+Contains detailed pricing information for a product.
+
+#### Attributes
+
+- `campaignPrice`: Current campaign price
+- `lowest30DayPrice`: Lowest price in the last 30 days
+- `campaignPriceValidUntil`: Campaign validity date
+- `regularPrice`: Regular price
+- `currentPrice`: Current price
+- `salesUnit`: Unit for sales
+- `comparisonPrice`: Price for comparison
+- `comparisonUnit`: Unit for comparison
+- `isApproximatePrice`: Whether price is approximate
+- `depositPrice`: Deposit price
+- `quantityMultiplier`: Quantity multiplier
+
+### SOKStore
+
+Represents a store with location and product information.
+
+#### Attributes
+
+- `store_id`: Unique store identifier
+- `slug`: URL slug
+- `name`: Store name
+- `brand`: Store brand (e.g., "S-Market", "Prisma")
+- `domains`: List of domains
+- `location`: Street address
+- `postcode`: Postal code
+- `postcodeName`: City name
+- `weeklyOpeningHours`: Opening hours for each day
+- `categories`: SOKCategories object for browsing products
+
+#### Methods
+
+- `get_filtered_products(slug: str, limit: int = 10) -> list[SOKProduct]`: Get products from a specific category
+
+## Examples
+
+### Finding Stores Near You
+
+```python
+api = SOKAPI()
+
+# Get all Prisma stores
+prisma_stores = api.get_stores_by_brand("Prisma")
+print(f"Found {len(prisma_stores)} Prisma stores")
+
+# Display store information
+for store in prisma_stores[:3]:
+    print(f"{store.name} - {store.location}, {store.postcode} {store.postcodeName}")
+```
+
+### Product Price Comparison
+
+```python
+api = SOKAPI()
+
+product = api.get_product_by_id("example-product-id")
+
+if product.pricing:
+    pricing = product.pricing
+    print(f"Product: {product.name}")
+    print(f"Regular Price: {pricing.regularPrice} €")
+    print(f"Current Price: {pricing.currentPrice} €")
+    if pricing.campaignPrice:
+        print(f"Campaign Price: {pricing.campaignPrice} € (valid until {pricing.campaignPriceValidUntil})")
+    print(f"Lowest 30-day Price: {pricing.lowest30DayPrice} €")
+```
+
+### Browsing Store Categories
+
+```python
+api = SOKAPI()
+store = api.get_store_by_id("example-store-id")
+
+# Get products from a specific category
+dairy_products = store.get_filtered_products("maito-tuotteet", limit=20)
+for product in dairy_products:
+    print(f"{product.name}: {product.price} €")
+```
+
+or
+
+```python
+api = SOKAPI()
+store = api.get_store_by_id("example-store-id")
+
+#Get products from a specific category
+chewing_gums = store.categories.karkit_ja_suklaat.purukumit.products()
+
+for product in chewing_gums:
+    print(f"{product.name}: {product.price} €")
+```
+
+## Requirements
+
+- Python 3.7+
+- requests
+- beautifulsoup4
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Disclaimer
+
+This package is not officially affiliated with S-Group or SOK. Use responsibly and in accordance with S-Group's terms of service.

sokpy-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sokpy"
+version = "0.1.0"
+description = "Unofficial Python wrapper for SOK / S-Kaupat APIs"
+readme = "README.md"
+authors = [
+  {name = "Collectseal120"}
+]
+license = "MIT"
+requires-python = ">=3.7"
+dependencies = [
+  "requests",
+  "beautifulsoup4"
+]
+
+[project.urls]
+Homepage = "https://github.com/Collectseal120/sokpy"
+Repository = "https://github.com/Collectseal120/sokpy"

sokpy-0.1.0/setup.cfg

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

sokpy-0.1.0/sokpy/__init__.py

@@ -0,0 +1,6 @@
+from .api import SOKAPI
+from .pricing import SOKPricing
+from .products import SOKProduct
+from .stores import SOKStore
+
+__all__ = ["SOKAPI", "SOKPricing", "SOKProduct", "SOKStore"]

sokpy-0.1.0/sokpy/api.py

@@ -0,0 +1,134 @@
+import requests
+import json
+from . import sok_stores
+from .query_hashes import STORE_SEARCH_HASH
+from .stores import SOKStore
+from .products import SOKProduct
+from .pricing import SOKPricing
+from bs4 import BeautifulSoup
+
+
+class SOKAPI:
+    BASE_URL = "https://api.s-kaupat.fi/"
+
+    def __init__(self):
+        self.url = "https://api.s-kaupat.fi/"
+        self.session = requests.Session()
+        self.session.headers.update({
+            "User-Agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64)",
+            "Accept":"application/json",
+            "Referer":"https://www.s-kaupat.fi/",
+            "Origin":"https://www.s-kaupat.fi",
+            "Accept-Language":"fi-FI,fi;q=0.9,en;q=0.8"
+        })
+
+
+    def _request(self, operation_name, variables, sha256):
+        params = {
+            "operationName": operation_name,
+            "variables": json.dumps(variables),
+            "extensions": json.dumps({
+                "persistedQuery": {
+                    "version": 1,
+                    "sha256Hash": sha256
+                }
+            })
+        }
+
+        r = self.session.get(self.BASE_URL, params=params)
+        r.raise_for_status()
+        return r.json()
+
+    def get_product_by_id(self,id: str) -> SOKProduct:
+        url = f"https://www.s-kaupat.fi/tuote/moi/{id}"
+        response = requests.get(url)
+        response.raise_for_status()
+
+        soup = BeautifulSoup(response.text, "html.parser")
+        data = soup.find("script", {"id": "__NEXT_DATA__"})
+        json_data = json.loads(data.string)
+
+
+        p_data = {"data": v for k, v in json_data["props"]["pageProps"]["apolloState"].items() if 'Product:{"id"' in k}
+        p_data = p_data["data"]
+
+        pricing_data = p_data["pricing"]
+        pricing = None
+        if pricing_data != None:
+            pricing = SOKPricing(pricing_data["campaignPrice"],pricing_data["lowest30DayPrice"], pricing_data["campaignPriceValidUntil"],pricing_data["regularPrice"],pricing_data["currentPrice"], pricing_data["salesUnit"], pricing_data["comparisonPrice"], pricing_data["comparisonUnit"],pricing_data["isApproximatePrice"], pricing_data["depositPrice"],pricing_data["quantityMultiplier"])
+        product = SOKProduct(p_data["id"], p_data["sokId"],p_data["name"],p_data["price"],None,pricing, p_data["basicQuantityUnit"], p_data["comparisonPrice"], p_data["comparisonUnit"], p_data["priceUnit"], p_data["isAgeLimitedByAlcohol"], p_data["frozen"], p_data["packagingLabelCodes"], p_data["brandName"], p_data["packagingLabels"], p_data["slug"])
+        return product
+    def get_all_stores(self) -> list[SOKStore]:
+        stores = {}
+        for brand in sok_stores.ALL_STORES:
+            stores[brand] = self.get_stores_by_brand(brand)
+
+        return stores
+
+    def get_store_by_id(self, id: str) -> SOKStore:
+        url = f"https://www.s-kaupat.fi/myymala/moi/{id}"
+
+        response = requests.get(url)
+        response.raise_for_status()
+
+        soup = BeautifulSoup(response.content, "html.parser")
+        data = soup.find("script", {"id": "__NEXT_DATA__"})
+        json_data = json.loads(data.string)
+
+        store_data = json_data["props"]["pageProps"]["store"]
+        store = SOKStore(api=self,
+                        store_id=store_data["id"],
+                        slug=store_data["slug"],
+                        name=store_data["name"],
+                        brand=store_data["brand"],
+                        domains=store_data["domains"],
+                        location=store_data["location"]["address"]["street"]["default"],
+                        postcode=store_data["location"]["address"]["postcode"],
+                        postcodeName=store_data["location"]["address"]["postcodeName"]["default"],
+                        weeklyOpeningHours=store_data["weeklyOpeningHours"]
+                        )
+        return store
+
+
+    def get_stores_by_brand(self, brand: str) -> list[SOKStore]:
+        variables = {"query": None, "brand": brand, "cursor": None}
+
+        response = self._request("RemoteStoreSearch",variables, STORE_SEARCH_HASH)
+
+        data = response["data"]["searchStores"]
+        all_store_count = data["totalCount"]
+        store_count = len(data["stores"])
+        stores = []
+        for store_data in data["stores"]:
+            store = self.make_store(store_data)
+            stores.append(store)
+
+        print(f"Found {all_store_count} stores for brand {brand}")
+
+        while store_count < all_store_count:
+            variables["cursor"] = data["cursor"]
+
+            response = self._request("RemoteStoreSearch",variables, STORE_SEARCH_HASH)
+
+            data = response["data"]["searchStores"]
+            store_count += len(data["stores"])
+
+            for store_data in data["stores"]:
+                store = self.make_store(store_data)
+                stores.append(store)
+        return stores
+
+    def make_store(self, store_data: dict) -> SOKStore:
+        return SOKStore(
+            api=self,
+            store_id=store_data["id"],
+            slug=store_data["slug"],
+            name=store_data["name"],
+            brand=store_data["brand"],
+            domains=store_data["domains"],
+            location=store_data["location"]["address"]["street"]["default"],
+            postcode=store_data["location"]["address"]["postcode"],
+            postcodeName=store_data["location"]["address"]["postcodeName"]["default"],
+            weeklyOpeningHours=store_data["weeklyOpeningHours"]
+        )
+

sokpy-0.1.0/sokpy/categories.py

@@ -0,0 +1,104 @@
+from bs4 import BeautifulSoup
+import requests
+from .products import SOKProduct
+from typing import List
+
+
+class SOKCategory:
+    def __init__(self, store: "SOKStore", slug, parent=None): # type: ignore
+        self.store = store
+        self.slug = slug
+        self.parent = parent
+        self.children: dict[str, "SOKCategory"] = {}
+        self._loaded = False
+
+    @property
+    def path(self):
+        if self.parent:
+            return f"{self.parent.path}/{self.slug}"
+        return self.slug
+
+    def _load_children(self):
+        if self._loaded:
+            return
+
+        url = f"https://www.s-kaupat.fi/tuotteet/{self.path}"
+        response = requests.get(url)
+        soup = BeautifulSoup(response.text, "html.parser")
+        items = soup.find_all("div", {"class": "item-name"})
+
+        for item in items:
+            href = item.parent["href"]
+            child_slug = href.split("/")[-1]
+            child = SOKCategory(self.store, child_slug, parent=self)
+            self.add_child(child)
+
+        self._loaded = True
+
+    def add_child(self, child: "SOKCategory"):
+        self.children[child.slug] = child
+
+    def __getattr__(self, name: str) -> "SOKCategory":
+        self._load_children()
+        for slug, child in self.children.items():
+            if slug.replace("-", "_") == name:
+                return child
+        raise AttributeError(name)
+
+    def products(self, limit: int = 10) -> list["SOKProduct"]:
+        return self.store.get_filtered_products(self.path, limit)
+    def __str__(self):
+            return f"<SOKCategory slug='{self.slug}' path='{self.path}' children={list(self.children.keys())}>"
+
+    def __repr__(self):
+        return self.__str__()
+
+    def to_dict(self):
+        return {
+            "slug": self.slug,
+            "parent": self.parent,
+            "children": self.children,
+        }
+
+
+class SOKCategories:
+    def __init__(self, store):
+        self.store = store
+        self.root: dict[str, SOKCategory] = {}
+        self._loaded = False
+
+    def _load_root_categories(self):
+        if self._loaded:
+            return
+
+        url = "https://www.s-kaupat.fi/tuotteet"
+        response = requests.get(url)
+
+        soup = BeautifulSoup(response.text, "html.parser")
+
+        items = soup.find_all("div", {"class": "item-name"})
+        for item in items:
+            href = item.parent["href"]
+            slug = href.split("/")[-1]
+
+            cat = SOKCategory(self.store, slug)
+            self.add_root(cat)
+
+        self._loaded = True
+
+    def add_root(self, category: "SOKCategory"):
+        self.root[category.slug] = category
+
+    def __getattr__(self, name: str) -> "SOKCategory":
+        self._load_root_categories()
+
+        for slug, cat in self.root.items():
+            if slug.replace("-", "_") == name:
+                return cat
+
+        raise AttributeError(name)
+    def __str__(self):
+            return f"<SOKCategories roots={list(self.root.keys())}>"
+
+    def __repr__(self):
+        return self.__str__()

sokpy-0.1.0/sokpy/pricing.py

@@ -0,0 +1,35 @@
+from dataclasses import dataclass
+import json
+
+@dataclass
+class SOKPricing():
+    def __init__(self, campaignPrice: float, lowest30DayPrice: float, campaignPriceValidUntil: str, regularPrice: float, currentPrice: float, salesUnit: str, comparisonPrice: float, comparisonUnit: str, isApproximatePrice: bool, depositPrice: float, quantityMultiplier: float):
+        self.campaignPrice = campaignPrice
+        self.lowest30DayPrice = lowest30DayPrice
+        self.campaignPriceValidUntil = campaignPriceValidUntil
+        self.regularPrice = regularPrice
+        self.currentPrice = currentPrice
+        self.salesUnit = salesUnit
+        self.comparisonPrice = comparisonPrice
+        self.comparisonUnit = comparisonUnit
+        self.isApproximatePrice = isApproximatePrice
+        self.depositPrice = depositPrice
+        self.quantityMultiplier = quantityMultiplier
+    def __str__(self):
+        return f"Campaign Price: {self.campaignPrice}, Lowest 30 Day Price: {self.lowest30DayPrice}, Campaign Price Valid Until: {self.campaignPriceValidUntil}, Regular Price: {self.regularPrice}, Current Price: {self.currentPrice}, Sales Unit: {self.salesUnit}, Comparison Price: {self.comparisonPrice}, Comparison Unit: {self.comparisonUnit}, Is Approximate Price: {self.isApproximatePrice}, Deposit Price: {self.depositPrice}, Quantity Multiplier: {self.quantityMultiplier}"
+    def to_dict(self):
+        return {
+            "campaignPrice": self.campaignPrice,
+            "lowest30DayPrice": self.lowest30DayPrice,
+            "campaignPriceValidUntil": self.campaignPriceValidUntil,
+            "regularPrice": self.regularPrice,
+            "currentPrice": self.currentPrice,
+            "salesUnit": self.salesUnit,
+            "comparisonPrice": self.comparisonPrice,
+            "comparisonUnit": self.comparisonUnit,
+            "isApproximatePrice": self.isApproximatePrice,
+            "depositPrice": self.depositPrice,
+            "quantityMultiplier": self.quantityMultiplier
+        }
+    def to_json(self):
+        return json.dumps(self.to_dict())

sokpy-0.1.0/sokpy/products.py

@@ -0,0 +1,48 @@
+import json
+from dataclasses import dataclass
+from .pricing import SOKPricing
+
+
+@dataclass
+class SOKProduct:
+    def __init__(self, product_id: str, sokId: str, name: str, price: float, availability: str, pricing: SOKPricing, basicQuantityUnit: str, comparisonPrice: float, comparisonUnit: str, priceUnit: str, isAgeLimitedByAlcohol: bool, frozen: bool, packagingLabelCodes: list[str], brandName: str, packagingLabels: list[str], slug: str):
+        self.product_id = product_id
+        self.sokId = sokId
+        self.name = name
+        self.price = price
+        self.availability = availability
+        self.pricing = pricing
+        self.basicQuantityUnit = basicQuantityUnit
+        self.comparisonPrice = comparisonPrice
+        self.comparisonUnit = comparisonUnit
+        self.priceUnit = priceUnit
+        self.isAgeLimitedByAlcohol = isAgeLimitedByAlcohol
+        self.frozen = frozen
+        self.packagingLabelCodes = packagingLabelCodes
+        self.brandName = brandName
+        self.packagingLabels = packagingLabels
+        self.slug = slug
+
+    def __str__(self):
+        return f"Product ID: {self.product_id}, SOK ID: {self.sokId}, Name: {self.name}, Price: {self.price}, Availability: {self.availability}, Pricing: {self.pricing}, Basic Quantity Unit: {self.basicQuantityUnit}, Comparison Price: {self.comparisonPrice}, Comparison Unit: {self.comparisonUnit}, Price Unit: {self.priceUnit}, Is Age Limited By Alcohol: {self.isAgeLimitedByAlcohol}, Frozen: {self.frozen}, Packaging Label Codes: {self.packagingLabelCodes}, Brand Name: {self.brandName}, Packaging Labels: {self.packagingLabels}, Slug: {self.slug}"
+    def to_dict(self):
+        return {
+            "product_id": self.product_id,
+            "sokId": self.sokId,
+            "name": self.name,
+            "price": self.price,
+            "availability": self.availability,
+            "pricing": self.pricing.to_dict(),
+            "basicQuantityUnit": self.basicQuantityUnit,
+            "comparisonPrice": self.comparisonPrice,
+            "comparisonUnit": self.comparisonUnit,
+            "priceUnit": self.priceUnit,
+            "isAgeLimitedByAlcohol": self.isAgeLimitedByAlcohol,
+            "frozen": self.frozen,
+            "packagingLabelCodes": self.packagingLabelCodes,
+            "brandName": self.brandName,
+            "packagingLabels": self.packagingLabels,
+            "slug": self.slug
+        }
+    def to_json(self):
+        return json.dumps(self.to_dict())

sokpy-0.1.0/sokpy/query_hashes.py

@@ -0,0 +1,2 @@
+STORE_SEARCH_HASH = "e49317e01c3a57b286fadd6f3ea47fd1d64adebb483943ba0e229307d15763b5"
+PRODUCT_SEARCH_HASH = "908fdf2c35f4a100371ca1b429063492979006147192241341f209ee48892844"

sokpy-0.1.0/sokpy/sok_stores.py

@@ -0,0 +1,9 @@
+PRISMA = "PRISMA"
+S_MARKET = "S_MARKET"
+FOOD_MARKET_HERKKU = "HERKKU"
+ALEPA = "ALEPA"
+SALE = "SALE"
+SOKOS_HERKKU = "SOKOS_HERKKU"
+MESTARIN_HERKKU = "MESTARIN_HERKKU"
+DEFAULT_STORE_ID = "513971200"
+ALL_STORES = [PRISMA, S_MARKET, FOOD_MARKET_HERKKU, ALEPA, SALE, SOKOS_HERKKU, MESTARIN_HERKKU]

sokpy-0.1.0/sokpy/stores.py

@@ -0,0 +1,95 @@
+import sok.categories as categories
+from .query_hashes import PRODUCT_SEARCH_HASH
+from dataclasses import dataclass
+from .pricing import SOKPricing
+from .products import SOKProduct
+import json
+
+@dataclass
+class SOKStore:
+    def __init__(self,api: "SOKAPI", store_id: str, slug: str, name: str, brand: str, domains: list[str], location: str, postcode: str, postcodeName: str, weeklyOpeningHours: list[object]): # type: ignore
+        self.api = api
+        self.store_id = store_id
+        self.slug = slug
+        self.name = name
+        self.brand = brand
+        self.domains = domains
+        self.location = location
+        self.postcode = postcode
+        self.postcodeName = postcodeName
+        self.weeklyOpeningHours = weeklyOpeningHours
+        self.categories = categories.SOKCategories(self)
+
+
+    def get_filtered_products(self, slug: str, limit: int = 10) -> list[SOKProduct]:
+        variables = {
+            "facets":[
+                {"key":"brandName","order":"asc"},
+                {"key":"labels"}
+            ],
+            "from":0,
+            "limit":limit,
+            "queryString":"",
+            "slug": slug,
+            "storeId": self.store_id,
+            "fetchSponsoredContent":True,
+            "includeAgeLimitedByAlcohol":True,
+            "useRandomId":True
+        }
+
+        response = self.api._request("RemoteFilteredProducts", variables, PRODUCT_SEARCH_HASH)
+        products = []
+
+        for product_data in response["data"]["store"]["products"]["productListItems"]:
+            product = self.create_product(product_data["product"])
+            products.append(product)
+
+        all_product_count = response["data"]["store"]["products"]["total"]
+        product_count = len(response["data"]["store"]["products"]["productListItems"])
+        for i in range(limit, all_product_count, limit):
+            variables["from"] = i
+            response = self.api._request("RemoteFilteredProducts", variables, PRODUCT_SEARCH_HASH)
+            product_count += len(response["data"]["store"]["products"]["productListItems"])
+            for product_data in response["data"]["store"]["products"]["productListItems"]:
+                product = self.create_product(product_data["product"])
+                products.append(product)
+            print(f"Got {product_count} / {all_product_count} products for store {self.name}")
+        return products
+
+
+    def create_product(self, product_data: dict) -> SOKProduct:
+        pricing_data = product_data["pricing"]
+        pricing = SOKPricing(pricing_data["campaignPrice"], pricing_data["lowest30DayPrice"], pricing_data["campaignPriceValidUntil"], pricing_data["regularPrice"], pricing_data["currentPrice"], pricing_data["salesUnit"], pricing_data["comparisonPrice"], pricing_data["comparisonUnit"], pricing_data["isApproximatePrice"], pricing_data["depositPrice"], pricing_data["quantityMultiplier"])
+        return SOKProduct(
+            product_id=product_data["id"],
+            sokId=product_data["sokId"],
+            name=product_data["name"],
+            price=product_data["price"],
+            availability=product_data["availability"],
+            pricing=pricing,
+            basicQuantityUnit=product_data["basicQuantityUnit"],
+            comparisonPrice=product_data["comparisonPrice"],
+            comparisonUnit=product_data["comparisonUnit"],
+            priceUnit=product_data["priceUnit"],
+            isAgeLimitedByAlcohol=product_data["isAgeLimitedByAlcohol"],
+            frozen=product_data["frozen"],
+            packagingLabelCodes=product_data["packagingLabelCodes"],
+            brandName=product_data["brandName"],
+            packagingLabels=product_data["packagingLabels"],
+            slug=product_data["slug"]
+        )
+    def to_dict(self):
+        return {
+            "store_id": self.store_id,
+            "slug": self.slug,
+            "name": self.name,
+            "brand": self.brand,
+            "domains": self.domains,
+            "location": self.location,
+            "postcode": self.postcode,
+            "postcodeName": self.postcodeName,
+            "weeklyOpeningHours": self.weeklyOpeningHours,
+            "categories": {slug: cat.to_dict() for slug, cat in self.categories.root.items()} if hasattr(self, "categories") else {}
+        }
+    def to_json(self):
+        return json.dumps(self.to_dict(), indent=4, ensure_ascii=False)

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

@@ -0,0 +1,206 @@
+Metadata-Version: 2.4
+Name: sokpy
+Version: 0.1.0
+Summary: Unofficial Python wrapper for SOK / S-Kaupat APIs
+Author: Collectseal120
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Collectseal120/sokpy
+Project-URL: Repository, https://github.com/Collectseal120/sokpy
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: beautifulsoup4
+Dynamic: license-file
+
+# sokpy
+
+A Python wrapper for the SOK (S-Group) API, providing easy access to store information, product data, and pricing from Finnish S-Group stores.
+
+## Features
+
+- **Store Management**: Retrieve information about S-Group stores by brand or location
+- **Product Information**: Get detailed product data including pricing, availability, and specifications
+- **Pricing Data**: Access current prices, campaign prices, and historical pricing information
+- **Category Browsing**: Browse products by categories within specific stores
+
+## Installation
+
+```bash
+pip install sokpy
+```
+
+## Quick Start
+
+```python
+from sokpy import SOKAPI
+
+# Initialize the API
+api = SOKAPI()
+
+# Get a product by ID
+product = api.get_product_by_id("some-product-id")
+print(f"Product: {product.name}")
+print(f"Price: {product.price} €")
+
+# Get stores by brand
+stores = api.get_stores_by_brand("S-Market")
+for store in stores[:5]:  # Show first 5 stores
+    print(f"Store: {store.name} - {store.location}")
+
+# Get a specific store
+store = api.get_store_by_id("some-store-id")
+print(f"Store: {store.name}")
+print(f"Opening hours: {store.weeklyOpeningHours}")
+```
+
+## API Reference
+
+### SOKAPI
+
+The main API class for interacting with SOK services.
+
+#### Methods
+
+- `get_product_by_id(product_id: str) -> SOKProduct`: Retrieve a product by its ID
+- `get_all_stores() -> dict`: Get all stores organized by brand
+- `get_stores_by_brand(brand: str) -> list[SOKStore]`: Get stores for a specific brand
+- `get_store_by_id(store_id: str) -> SOKStore`: Get a specific store by ID
+
+### SOKProduct
+
+Represents a product with detailed information.
+
+#### Attributes
+
+- `product_id`: Unique product identifier
+- `sokId`: SOK-specific product ID
+- `name`: Product name
+- `price`: Current price
+- `availability`: Product availability status
+- `pricing`: SOKPricing object with detailed pricing information
+- `basicQuantityUnit`: Unit of measurement
+- `comparisonPrice`: Price per comparison unit
+- `comparisonUnit`: Unit for price comparison
+- `priceUnit`: Unit for pricing
+- `isAgeLimitedByAlcohol`: Whether the product is age-restricted
+- `frozen`: Whether the product is frozen
+- `packagingLabelCodes`: List of packaging label codes
+- `brandName`: Brand name
+- `packagingLabels`: List of packaging labels
+- `slug`: URL slug for the product
+
+### SOKPricing
+
+Contains detailed pricing information for a product.
+
+#### Attributes
+
+- `campaignPrice`: Current campaign price
+- `lowest30DayPrice`: Lowest price in the last 30 days
+- `campaignPriceValidUntil`: Campaign validity date
+- `regularPrice`: Regular price
+- `currentPrice`: Current price
+- `salesUnit`: Unit for sales
+- `comparisonPrice`: Price for comparison
+- `comparisonUnit`: Unit for comparison
+- `isApproximatePrice`: Whether price is approximate
+- `depositPrice`: Deposit price
+- `quantityMultiplier`: Quantity multiplier
+
+### SOKStore
+
+Represents a store with location and product information.
+
+#### Attributes
+
+- `store_id`: Unique store identifier
+- `slug`: URL slug
+- `name`: Store name
+- `brand`: Store brand (e.g., "S-Market", "Prisma")
+- `domains`: List of domains
+- `location`: Street address
+- `postcode`: Postal code
+- `postcodeName`: City name
+- `weeklyOpeningHours`: Opening hours for each day
+- `categories`: SOKCategories object for browsing products
+
+#### Methods
+
+- `get_filtered_products(slug: str, limit: int = 10) -> list[SOKProduct]`: Get products from a specific category
+
+## Examples
+
+### Finding Stores Near You
+
+```python
+api = SOKAPI()
+
+# Get all Prisma stores
+prisma_stores = api.get_stores_by_brand("Prisma")
+print(f"Found {len(prisma_stores)} Prisma stores")
+
+# Display store information
+for store in prisma_stores[:3]:
+    print(f"{store.name} - {store.location}, {store.postcode} {store.postcodeName}")
+```
+
+### Product Price Comparison
+
+```python
+api = SOKAPI()
+
+product = api.get_product_by_id("example-product-id")
+
+if product.pricing:
+    pricing = product.pricing
+    print(f"Product: {product.name}")
+    print(f"Regular Price: {pricing.regularPrice} €")
+    print(f"Current Price: {pricing.currentPrice} €")
+    if pricing.campaignPrice:
+        print(f"Campaign Price: {pricing.campaignPrice} € (valid until {pricing.campaignPriceValidUntil})")
+    print(f"Lowest 30-day Price: {pricing.lowest30DayPrice} €")
+```
+
+### Browsing Store Categories
+
+```python
+api = SOKAPI()
+store = api.get_store_by_id("example-store-id")
+
+# Get products from a specific category
+dairy_products = store.get_filtered_products("maito-tuotteet", limit=20)
+for product in dairy_products:
+    print(f"{product.name}: {product.price} €")
+```
+
+or
+
+```python
+api = SOKAPI()
+store = api.get_store_by_id("example-store-id")
+
+#Get products from a specific category
+chewing_gums = store.categories.karkit_ja_suklaat.purukumit.products()
+
+for product in chewing_gums:
+    print(f"{product.name}: {product.price} €")
+```
+
+## Requirements
+
+- Python 3.7+
+- requests
+- beautifulsoup4
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Disclaimer
+
+This package is not officially affiliated with S-Group or SOK. Use responsibly and in accordance with S-Group's terms of service.

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

@@ -0,0 +1,16 @@
+LICENSE
+README.md
+pyproject.toml
+sokpy/__init__.py
+sokpy/api.py
+sokpy/categories.py
+sokpy/pricing.py
+sokpy/products.py
+sokpy/query_hashes.py
+sokpy/sok_stores.py
+sokpy/stores.py
+sokpy.egg-info/PKG-INFO
+sokpy.egg-info/SOURCES.txt
+sokpy.egg-info/dependency_links.txt
+sokpy.egg-info/requires.txt
+sokpy.egg-info/top_level.txt

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

@@ -0,0 +1 @@
+

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

@@ -0,0 +1,2 @@
+requests
+beautifulsoup4

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

@@ -0,0 +1 @@
+sokpy