open-product-client 0.3.0__tar.gz

open_product_client-0.3.0/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: open-product-client
+Version: 0.3.0
+Summary: API Client library to communicate with the Open Product service.
+Author-email: Maykin <support@maykinmedia.nl>
+License-Expression: EUPL-1.2
+Project-URL: Homepage, https://github.com/maykinmedia/open-product-api-client
+Project-URL: Bug Tracker, https://github.com/maykinmedia/open-product-api-client/issues
+Project-URL: Source Code, https://github.com/maykinmedia/open-product-api-client
+Keywords: maykin,openproduct,open product,producten,producttypen,common ground,api client
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/x-rst
+Requires-Dist: ape-pie>=0.2.0
+Requires-Dist: msgspec>=0.22.0
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: tox; extra == "tests"
+Requires-Dist: ruff; extra == "tests"
+Requires-Dist: pyright; extra == "tests"
+Requires-Dist: vcrpy; extra == "tests"
+Requires-Dist: pytest-recording; extra == "tests"
+Requires-Dist: types-requests; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Provides-Extra: release
+Requires-Dist: bump-my-version; extra == "release"
+
+
+
+Open Product Client
+=======================
+
+:Version: 0.3.0
+:Source: https://github.com/maykinmedia/open-product-client
+:Keywords: Open Product API, Client, producten, producttypen
+
+Currently compatible with Open Product 1.7.0
+
+|build-status| |coverage| |python-versions| |pypi-version|
+
+About
+=====
+
+A Python client library for interacting with the `Open Product API <https://github.com/maykinmedia/open-product>`_.
+
+Installation
+============
+
+Requirements
+------------
+
+* Python 3.12 or newer
+
+
+Install
+-------
+
+.. code-block:: bash
+
+    uv pip install open-product-client
+
+
+Usage
+=====
+
+# TODO
+
+Licence
+=======
+
+Licensed under the `MIT`_.
+
+.. _`Maykin Media B.V.`: https://www.maykin.nl
+.. _`MIT`: LICENSE
+.. _`Open Product API`: https://github.com/maykinmedia/open-product
+
+.. |build-status| image:: https://github.com/maykinmedia/open-product-client/actions/workflows/ci.yml/badge.svg
+    :alt: Build status
+    :target: https://github.com/maykinmedia/open-product-client/actions/workflows/ci.yml
+
+.. |coverage| image:: https://codecov.io/gh/maykinmedia/open-product-client/branch/main/graph/badge.svg
+    :target: https://codecov.io/gh/maykinmedia/open-product-client
+    :alt: Coverage status
+
+.. |python-versions| image:: https://img.shields.io/badge/python-3.12-blue.svg
+    :alt: Supported Python versions
+
+.. |pypi-version| image:: https://img.shields.io/pypi/v/open_product_client.svg
+    :target: https://pypi.org/project/open_product_client/

open_product_client-0.3.0/README.rst

@@ -0,0 +1,62 @@
+
+
+Open Product Client
+=======================
+
+:Version: 0.3.0
+:Source: https://github.com/maykinmedia/open-product-client
+:Keywords: Open Product API, Client, producten, producttypen
+
+Currently compatible with Open Product 1.7.0
+
+|build-status| |coverage| |python-versions| |pypi-version|
+
+About
+=====
+
+A Python client library for interacting with the `Open Product API <https://github.com/maykinmedia/open-product>`_.
+
+Installation
+============
+
+Requirements
+------------
+
+* Python 3.12 or newer
+
+
+Install
+-------
+
+.. code-block:: bash
+
+    uv pip install open-product-client
+
+
+Usage
+=====
+
+# TODO
+
+Licence
+=======
+
+Licensed under the `MIT`_.
+
+.. _`Maykin Media B.V.`: https://www.maykin.nl
+.. _`MIT`: LICENSE
+.. _`Open Product API`: https://github.com/maykinmedia/open-product
+
+.. |build-status| image:: https://github.com/maykinmedia/open-product-client/actions/workflows/ci.yml/badge.svg
+    :alt: Build status
+    :target: https://github.com/maykinmedia/open-product-client/actions/workflows/ci.yml
+
+.. |coverage| image:: https://codecov.io/gh/maykinmedia/open-product-client/branch/main/graph/badge.svg
+    :target: https://codecov.io/gh/maykinmedia/open-product-client
+    :alt: Coverage status
+
+.. |python-versions| image:: https://img.shields.io/badge/python-3.12-blue.svg
+    :alt: Supported Python versions
+
+.. |pypi-version| image:: https://img.shields.io/pypi/v/open_product_client.svg
+    :target: https://pypi.org/project/open_product_client/

open_product_client-0.3.0/open_product_client.egg-info/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: open-product-client
+Version: 0.3.0
+Summary: API Client library to communicate with the Open Product service.
+Author-email: Maykin <support@maykinmedia.nl>
+License-Expression: EUPL-1.2
+Project-URL: Homepage, https://github.com/maykinmedia/open-product-api-client
+Project-URL: Bug Tracker, https://github.com/maykinmedia/open-product-api-client/issues
+Project-URL: Source Code, https://github.com/maykinmedia/open-product-api-client
+Keywords: maykin,openproduct,open product,producten,producttypen,common ground,api client
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/x-rst
+Requires-Dist: ape-pie>=0.2.0
+Requires-Dist: msgspec>=0.22.0
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: tox; extra == "tests"
+Requires-Dist: ruff; extra == "tests"
+Requires-Dist: pyright; extra == "tests"
+Requires-Dist: vcrpy; extra == "tests"
+Requires-Dist: pytest-recording; extra == "tests"
+Requires-Dist: types-requests; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Provides-Extra: release
+Requires-Dist: bump-my-version; extra == "release"
+
+
+
+Open Product Client
+=======================
+
+:Version: 0.3.0
+:Source: https://github.com/maykinmedia/open-product-client
+:Keywords: Open Product API, Client, producten, producttypen
+
+Currently compatible with Open Product 1.7.0
+
+|build-status| |coverage| |python-versions| |pypi-version|
+
+About
+=====
+
+A Python client library for interacting with the `Open Product API <https://github.com/maykinmedia/open-product>`_.
+
+Installation
+============
+
+Requirements
+------------
+
+* Python 3.12 or newer
+
+
+Install
+-------
+
+.. code-block:: bash
+
+    uv pip install open-product-client
+
+
+Usage
+=====
+
+# TODO
+
+Licence
+=======
+
+Licensed under the `MIT`_.
+
+.. _`Maykin Media B.V.`: https://www.maykin.nl
+.. _`MIT`: LICENSE
+.. _`Open Product API`: https://github.com/maykinmedia/open-product
+
+.. |build-status| image:: https://github.com/maykinmedia/open-product-client/actions/workflows/ci.yml/badge.svg
+    :alt: Build status
+    :target: https://github.com/maykinmedia/open-product-client/actions/workflows/ci.yml
+
+.. |coverage| image:: https://codecov.io/gh/maykinmedia/open-product-client/branch/main/graph/badge.svg
+    :target: https://codecov.io/gh/maykinmedia/open-product-client
+    :alt: Coverage status
+
+.. |python-versions| image:: https://img.shields.io/badge/python-3.12-blue.svg
+    :alt: Supported Python versions
+
+.. |pypi-version| image:: https://img.shields.io/pypi/v/open_product_client.svg
+    :target: https://pypi.org/project/open_product_client/

open_product_client-0.3.0/open_product_client.egg-info/SOURCES.txt

@@ -0,0 +1,30 @@
+README.rst
+pyproject.toml
+open_product_client.egg-info/PKG-INFO
+open_product_client.egg-info/SOURCES.txt
+open_product_client.egg-info/dependency_links.txt
+open_product_client.egg-info/requires.txt
+open_product_client.egg-info/top_level.txt
+openproduct_client/__init__.py
+openproduct_client/clients.py
+openproduct_client/resources/__init__.py
+openproduct_client/resources/base.py
+openproduct_client/resources/product/__init__.py
+openproduct_client/resources/product_type/__init__.py
+openproduct_client/resources/product_type/content_label.py
+openproduct_client/resources/product_type/price.py
+openproduct_client/resources/product_type/product_type.py
+openproduct_client/resources/product_type/theme.py
+openproduct_client/structs/__init__.py
+openproduct_client/structs/base.py
+openproduct_client/structs/product/__init__.py
+openproduct_client/structs/product_type/__init__.py
+openproduct_client/structs/product_type/common.py
+openproduct_client/structs/product_type/content_label.py
+openproduct_client/structs/product_type/price.py
+openproduct_client/structs/product_type/product_type.py
+openproduct_client/structs/product_type/theme.py
+tests/test_content_label.py
+tests/test_price.py
+tests/test_product_type.py
+tests/test_theme.py

open_product_client-0.3.0/open_product_client.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

open_product_client-0.3.0/open_product_client.egg-info/requires.txt

@@ -0,0 +1,19 @@
+ape-pie>=0.2.0
+msgspec>=0.22.0
+
+[docs]
+sphinx
+sphinx-rtd-theme
+
+[release]
+bump-my-version
+
+[tests]
+pytest
+tox
+ruff
+pyright
+vcrpy
+pytest-recording
+types-requests
+pytest-cov

open_product_client-0.3.0/open_product_client.egg-info/top_level.txt

@@ -0,0 +1 @@
+openproduct_client

open_product_client-0.3.0/openproduct_client/__init__.py

@@ -0,0 +1 @@
+

open_product_client-0.3.0/openproduct_client/clients.py

@@ -0,0 +1,53 @@
+from collections.abc import MutableMapping
+from typing import Literal
+
+from ape_pie import APIClient
+from ape_pie.typing import ConfigAdapter
+
+from .resources.product_type import (
+    ContentLabelResource,
+    PriceResource,
+    ProductTypeResource,
+    ThemeResource,
+)
+
+
+class OpenProductClient(APIClient):
+    product_type: ProductTypeResource
+    theme: ThemeResource
+    content_label: ContentLabelResource
+    price: PriceResource
+
+    def __init__(
+        self,
+        base_url: str,
+        *,
+        token: str = "",
+        language_code: Literal["nl", "en"] = "nl",
+        request_kwargs: MutableMapping[str, object] | None = None,
+        **kwargs,
+    ):
+        if request_kwargs is None:
+            request_kwargs = {}
+        if "headers" not in request_kwargs:
+            request_kwargs["headers"] = {}
+
+        assert isinstance(request_kwargs["headers"], MutableMapping)
+
+        if token:
+            request_kwargs["headers"]["Authorization"] = f"Token {token}"
+
+        request_kwargs["headers"]["Accept-Language"] = language_code
+
+        super().__init__(base_url=base_url, request_kwargs=request_kwargs)  # pyright: ignore[reportArgumentType]
+
+        self.theme = ThemeResource(self)
+        self.content_label = ContentLabelResource(self)
+        self.product_type = ProductTypeResource(self)
+        self.price = PriceResource(self)
+
+    @classmethod
+    def configure_from(cls, adapter: ConfigAdapter, **kwargs):
+        base_url = adapter.get_client_base_url()
+        session_kwargs = adapter.get_client_session_kwargs()
+        return cls(base_url, request_kwargs=session_kwargs, **kwargs)

open_product_client-0.3.0/openproduct_client/resources/base.py

@@ -0,0 +1,125 @@
+from __future__ import annotations
+
+import logging
+from collections.abc import Mapping
+from typing import TYPE_CHECKING
+
+import msgspec
+import requests
+
+if TYPE_CHECKING:
+    from ..clients import OpenProductClient
+
+
+logger = logging.getLogger(__name__)
+
+
+class BaseResource:
+    http_client: OpenProductClient
+
+    def __init__(self, http_client: OpenProductClient):
+        self.http_client = http_client
+
+    @staticmethod
+    def process_response[T](
+        response: requests.Response,
+        struct_type: type[T],
+    ) -> T:
+        response_data = response.json()
+        # for now: assume no errors :)
+        return msgspec.convert(response_data, type=struct_type)
+
+    def _get(
+        self,
+        path: str,
+        headers: Mapping | None = None,
+        params: msgspec.Struct | None = None,
+    ) -> requests.Response:
+        query_params = msgspec.to_builtins(params)
+        response = self.http_client.request(
+            "get", path, headers=headers, params=query_params
+        )
+        response.raise_for_status()
+        return response
+
+    def _post(
+        self,
+        path: str,
+        headers: Mapping | None = None,
+        params: msgspec.Struct | None = None,
+        data: object = None,
+    ) -> requests.Response:
+        query_params = msgspec.to_builtins(params)
+        response = self.http_client.request(
+            "post",
+            path,
+            headers=headers,
+            json=data,
+            params=query_params,
+        )
+        response.raise_for_status()
+        return response
+
+    def _put(
+        self,
+        path: str,
+        headers: Mapping | None = None,
+        params: msgspec.Struct | None = None,
+        data: object = None,
+    ) -> requests.Response:
+        query_params = msgspec.to_builtins(params)
+        response = self.http_client.request(
+            "put", path, headers=headers, json=data, params=query_params
+        )
+        response.raise_for_status()
+        return response
+
+    def _delete(
+        self,
+        path: str,
+        headers: Mapping | None = None,
+        params: msgspec.Struct | None = None,
+    ) -> requests.Response:
+        query_params = msgspec.to_builtins(params)
+        response = self.http_client.request(
+            "delete",
+            path,
+            headers=headers,
+            params=query_params,
+        )
+        response.raise_for_status()
+        return response
+
+    def _patch(
+        self,
+        path: str,
+        headers: Mapping | None = None,
+        params: msgspec.Struct | None = None,
+        data: object = None,
+    ) -> requests.Response:
+        query_params = msgspec.to_builtins(params)
+        response = self.http_client.request(
+            "patch",
+            path,
+            headers=headers,
+            params=query_params,
+            json=data,
+        )
+        response.raise_for_status()
+        return response
+
+    def _options(
+        self,
+        path: str,
+        headers: Mapping | None = None,
+        params: msgspec.Struct | None = None,
+    ) -> requests.Response:
+        query_params = msgspec.to_builtins(params)
+        response = self.http_client.request(
+            "delete",
+            path,
+            headers=headers,
+            params=query_params,
+        )
+        response.raise_for_status()
+        return response

open_product_client-0.3.0/openproduct_client/resources/product_type/__init__.py

@@ -0,0 +1,11 @@
+from .content_label import ContentLabelResource
+from .price import PriceResource
+from .product_type import ProductTypeResource
+from .theme import ThemeResource
+
+__all__ = [
+    "ContentLabelResource",
+    "PriceResource",
+    "ProductTypeResource",
+    "ThemeResource",
+]

open_product_client-0.3.0/openproduct_client/resources/product_type/content_label.py

@@ -0,0 +1,18 @@
+from typing import ClassVar
+
+from ...structs.base import PaginatedResponseBody, PaginationParams
+from ...structs.product_type import ContentLabel
+from ..base import BaseResource
+
+
+class ContentLabelResource(BaseResource):
+    base_path: ClassVar[str] = "contentlabels"
+
+    def list(
+        self, *, params: PaginationParams | None = None
+    ) -> PaginatedResponseBody[ContentLabel]:
+        """
+        Get all the available content labels (based on query parameters).
+        """
+        response = self._get(self.base_path, params=params)
+        return self.process_response(response, PaginatedResponseBody[ContentLabel])

open_product_client-0.3.0/openproduct_client/resources/product_type/price.py

@@ -0,0 +1,18 @@
+from typing import ClassVar
+
+from ...structs.base import PaginatedResponseBody
+from ...structs.product_type import Price, PriceParams
+from ..base import BaseResource
+
+
+class PriceResource(BaseResource):
+    base_path: ClassVar[str] = "prijzen"
+
+    def list(
+        self, *, params: PriceParams | None = None
+    ) -> PaginatedResponseBody[Price]:
+        """
+        Get all the available prices (based on query parameters).
+        """
+        response = self._get(self.base_path, params=params)
+        return self.process_response(response, PaginatedResponseBody[Price])

open_product_client-0.3.0/openproduct_client/resources/product_type/product_type.py

@@ -0,0 +1,65 @@
+import uuid
+from collections.abc import Sequence
+from typing import ClassVar
+
+from ...structs.base import PaginatedResponseBody
+from ...structs.product_type import (
+    ContentParams,
+    NestedContentElement,
+    ProductType,
+    ProductTypeCreateData,
+    ProductTypeParams,
+    ProductTypePartialUpdateData,
+)
+from ..base import BaseResource
+
+
+class ProductTypeResource(BaseResource):
+    base_path: ClassVar[str] = "producttypen"
+
+    def list(
+        self, *, params: ProductTypeParams | None = None
+    ) -> PaginatedResponseBody[ProductType]:
+        """
+        Get all the available product types (based on query parameters).
+        """
+        response = self._get(self.base_path, params=params)
+        return self.process_response(response, PaginatedResponseBody[ProductType])
+
+    def retrieve(self, /, uuid: str | uuid.UUID) -> ProductType:
+        """
+        Get a specific product type based on its uuid.
+        """
+        response = self._get(f"{self.base_path}/{uuid!s}")
+        return self.process_response(response, ProductType)
+
+    def create(self, *, data: ProductTypeCreateData) -> ProductType:
+        """
+        Create a new product type.
+        """
+        response = self._post(self.base_path, data=data)
+        return self.process_response(response, ProductType)
+
+    def partial_update(
+        self, /, uuid: str, *, data: ProductTypePartialUpdateData
+    ) -> ProductType:
+        """
+        Partially update a specific product type.
+        """
+        response = self._patch(f"{self.base_path}/{uuid!s}", data=data)
+        return self.process_response(response, ProductType)
+
+    def delete(self, /, uuid: str):
+        """
+        Delete a specific product type.
+        """
+        return self._delete(f"{self.base_path}/{uuid!s}")
+
+    def list_content(
+        self, uuid: str | uuid.UUID, *, params: ContentParams | None = None
+    ) -> Sequence[NestedContentElement]:
+        """
+        Get the content of a specific product type (based on query parameters).
+        """
+        response = self._get(f"{self.base_path}/{uuid!s}/content", params=params)
+        return self.process_response(response, Sequence[NestedContentElement])

open_product_client-0.3.0/openproduct_client/resources/product_type/theme.py

@@ -0,0 +1,21 @@
+from typing import ClassVar
+
+from ...structs.base import PaginatedResponseBody
+from ...structs.product_type import (
+    Theme,
+    ThemeParams,
+)
+from ..base import BaseResource
+
+
+class ThemeResource(BaseResource):
+    base_path: ClassVar[str] = "themas"
+
+    def list(
+        self, *, params: ThemeParams | None = None
+    ) -> PaginatedResponseBody[Theme]:
+        """
+        Get all the available themes (based on query parameters).
+        """
+        response = self._get(self.base_path, params=params)
+        return self.process_response(response, PaginatedResponseBody[Theme])