lib-shopware6-api-base 3.1.2__tar.gz → 4.0.0__tar.gz

{lib_shopware6_api_base-3.1.2 → lib_shopware6_api_base-4.0.0}/CHANGELOG.md

@@ -5,6 +5,41 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [4.0.0] - 2026-06-08
+
+### Breaking Changes
+
+- **Configuration is now loaded through `lib_layered_config`.** All settings — the
+  `[shopware]` connection settings and the `[lib_log_rich]` logging settings — are merged
+  across bundled defaults → app → host → user → `.env` → environment variables.
+- **Environment variables renamed.** The old single-underscore `SHOPWARE_*` variables are
+  no longer read. Use `SHOPWARE__<KEY>` in a `.env` file, or
+  `LIB_SHOPWARE6_API_BASE___SHOPWARE__<KEY>` as a real environment variable. See the README
+  migration table.
+- `ConfShopware6ApiBase` is now a plain Pydantic `BaseModel` (no longer `pydantic-settings`
+  `BaseSettings`); the removed helpers `from_env_file` / `from_env_vars` are gone.
+  `load_config_from_env()` / `require_config_from_env()` remain and now take no arguments.
+- The `OAUTHLIB_INSECURE_TRANSPORT` side effect was removed (authlib is no longer a
+  dependency); `insecure_transport` is still accepted as a config field.
+
+### Added
+
+- `lib_log_rich` structured logging, configured via the `[lib_log_rich]` config section and
+  initialized by the CLI (`logging_setup.py`). Library modules continue to use stdlib
+  `logging`, which is bridged into `lib_log_rich`.
+- Bundled `defaultconfig.toml` + `defaultconfig.d/{10-logging,20-shopware}.toml` shipped with
+  the package as the lowest-precedence config layer.
+
+### Removed
+
+- `pydantic-settings` dependency.
+
+## [3.1.3] - 2026-06-08
+
+### Fixed
+
+- Docs: reformatted README markdown tables for consistent column alignment (cosmetic; no content change).
+
 ## [3.1.2] - 2026-06-08
 
 ### Changed

{lib_shopware6_api_base-3.1.2 → lib_shopware6_api_base-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lib_shopware6_api_base
-Version: 3.1.2
+Version: 4.0.0
 Summary: python3 base API client for shopware6
 Project-URL: Homepage, https://github.com/bitranox/lib_shopware6_api_base
 Project-URL: Documentation, https://github.com/bitranox/lib_shopware6_api_base/blob/master/README.md
@@ -24,8 +24,9 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Requires-Dist: httpx2>=2.3.0
 Requires-Dist: lib-cli-exit-tools>=2.3.1
+Requires-Dist: lib-layered-config>=5.5.1
+Requires-Dist: lib-log-rich>=6.3.4
 Requires-Dist: orjson
-Requires-Dist: pydantic-settings>=2.14.1
 Requires-Dist: pydantic>=2.13.4
 Requires-Dist: rich-click
 Provides-Extra: dev
@@ -122,10 +123,28 @@ This is the base abstraction layer. For higher-level functions, see [lib_shopwar
 
 ## Configuration
 
-Configuration is managed via the `ConfShopware6ApiBase` class (Pydantic-based) which can load settings from:
-1. Environment variables
-2. A `.env` file
-3. Direct instantiation
+Configuration is managed via the `ConfShopware6ApiBase` class (Pydantic) and loaded
+through [`lib_layered_config`](https://github.com/bitranox/lib_layered_config), which
+merges, in increasing precedence:
+
+```
+bundled defaults  ->  app  ->  host  ->  user  ->  .env  ->  environment variables
+```
+
+You can also instantiate `ConfShopware6ApiBase(...)` directly with keyword arguments.
+
+> **⚠️ Breaking change in 4.0.0 — env vars renamed.** Configuration moved to
+> `lib_layered_config`, so the old single-underscore `SHOPWARE_*` variables are **no
+> longer read**. Rename them to the `[shopware]` section form:
+>
+> | Old (≤ 3.x)                        | New — `.env` file              | New — environment variable                              |
+> |------------------------------------|--------------------------------|---------------------------------------------------------|
+> | `SHOPWARE_ADMIN_API_URL`           | `SHOPWARE__ADMIN_API_URL`      | `LIB_SHOPWARE6_API_BASE___SHOPWARE__ADMIN_API_URL`      |
+> | `SHOPWARE_STOREFRONT_API_URL`      | `SHOPWARE__STOREFRONT_API_URL` | `LIB_SHOPWARE6_API_BASE___SHOPWARE__STOREFRONT_API_URL` |
+> | `SHOPWARE_<NAME>`                  | `SHOPWARE__<NAME>`             | `LIB_SHOPWARE6_API_BASE___SHOPWARE__<NAME>`             |
+>
+> i.e. in a `.env` file replace the single `_` after `SHOPWARE` with `__`; as a real
+> environment variable also add the `LIB_SHOPWARE6_API_BASE___` slug prefix.
 
 ### Environment File (.env)
 
@@ -133,42 +152,44 @@ Copy `example.env` to `.env` and adjust values for your shop:
 
 ```bash
 # API Endpoints
-SHOPWARE_ADMIN_API_URL="https://shop.example.com/api"
-SHOPWARE_STOREFRONT_API_URL="https://shop.example.com/store-api"
+SHOPWARE__ADMIN_API_URL="https://shop.example.com/api"
+SHOPWARE__STOREFRONT_API_URL="https://shop.example.com/store-api"
 
-# OAuth2 Security (set to "1" only for local HTTP development)
-SHOPWARE_INSECURE_TRANSPORT="0"
+# Transport (set to "1" only for local HTTP development)
+SHOPWARE__INSECURE_TRANSPORT="0"
 
-# User Credentials Grant (for interactive apps with refresh tokens)
-SHOPWARE_USERNAME="admin@example.com"
-SHOPWARE_PASSWORD="your-password"
+# User-Credentials grant (interactive apps with refresh tokens)
+SHOPWARE__USERNAME="admin@example.com"
+SHOPWARE__PASSWORD="your-password"
 
-# Resource Owner Grant (for automation/CLI - no refresh tokens)
-SHOPWARE_CLIENT_ID="SWIAXXXXXXXXXXXXXXXXXXXX"
-SHOPWARE_CLIENT_SECRET="your-integration-secret"
+# Resource-Owner grant (automation/CLI - no refresh tokens)
+SHOPWARE__CLIENT_ID="SWIAXXXXXXXXXXXXXXXXXXXX"
+SHOPWARE__CLIENT_SECRET="your-integration-secret"
 
 # Grant type: USER_CREDENTIALS or RESOURCE_OWNER
-SHOPWARE_GRANT_TYPE="RESOURCE_OWNER"
+SHOPWARE__GRANT_TYPE="RESOURCE_OWNER"
 
 # Storefront API access key (from Sales Channel settings)
-SHOPWARE_STORE_API_SW_ACCESS_KEY="SWSCXXXXXXXXXXXXXXXXXX"
+SHOPWARE__STORE_API_SW_ACCESS_KEY="SWSCXXXXXXXXXXXXXXXXXX"
 ```
 
-#### .env Settings Reference
+#### `[shopware]` Settings Reference
 
-All environment variables use the `SHOPWARE_` prefix to avoid collision with system variables.
+In a `.env` file use the `SHOPWARE__<KEY>` form; as a real environment variable prefix
+with `LIB_SHOPWARE6_API_BASE___`. The same keys can be set in a TOML config file under
+`[shopware]` (dropping the `SHOPWARE__` prefix).
 
-| Variable | Description                                                   | Example |
-|----------|---------------------------------------------------------------|---------|
-| `SHOPWARE_ADMIN_API_URL` | Admin API endpoint                                            | `https://shop.example.com/api` |
-| `SHOPWARE_STOREFRONT_API_URL` | Storefront API endpoint                                       | `https://shop.example.com/store-api` |
-| `SHOPWARE_INSECURE_TRANSPORT` | Allow HTTP (dev only)                                         | `0` (production) or `1` (dev) |
-| `SHOPWARE_USERNAME` | Admin user email                                              | `admin@example.com` |
-| `SHOPWARE_PASSWORD` | Admin user password                                           | `secret` |
-| `SHOPWARE_CLIENT_ID` | Integration Access ID | `SWIA...` |
-| `SHOPWARE_CLIENT_SECRET` | Integration Secret                                            | `...` |
-| `SHOPWARE_GRANT_TYPE` | Auth method                                                   | `USER_CREDENTIALS` or `RESOURCE_OWNER` |
-| `SHOPWARE_STORE_API_SW_ACCESS_KEY` | Storefront access key                                         | `SWSC...` |
+| `.env` key                         | Description             | Example                                |
+|------------------------------------|-------------------------|----------------------------------------|
+| `SHOPWARE__ADMIN_API_URL`          | Admin API endpoint      | `https://shop.example.com/api`         |
+| `SHOPWARE__STOREFRONT_API_URL`     | Storefront API endpoint | `https://shop.example.com/store-api`   |
+| `SHOPWARE__INSECURE_TRANSPORT`     | Allow HTTP (dev only)   | `0` (production) or `1` (dev)          |
+| `SHOPWARE__USERNAME`               | Admin user email        | `admin@example.com`                    |
+| `SHOPWARE__PASSWORD`               | Admin user password     | `secret`                               |
+| `SHOPWARE__CLIENT_ID`              | Integration Access ID   | `SWIA...`                              |
+| `SHOPWARE__CLIENT_SECRET`          | Integration Secret      | `...`                                  |
+| `SHOPWARE__GRANT_TYPE`             | Auth method             | `USER_CREDENTIALS` or `RESOURCE_OWNER` |
+| `SHOPWARE__STORE_API_SW_ACCESS_KEY`| Storefront access key   | `SWSC...`                              |
 
 ### Loading Configuration
 
@@ -258,18 +279,18 @@ products = client.request_post("product", payload=criteria)
 
 All request methods accept these parameters:
 
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `request_url` | `str` | API endpoint (without base URL) |
-| `payload` | `dict \| Criteria \| None` | Request body |
-| `update_header_fields` | `dict[str, str] \| None` | Custom headers |
+| Parameter              | Type                       | Description                     |
+|------------------------|----------------------------|---------------------------------|
+| `request_url`          | `str`                      | API endpoint (without base URL) |
+| `payload`              | `dict \| Criteria \| None` | Request body                    |
+| `update_header_fields` | `dict[str, str] \| None`   | Custom headers                  |
 
 Admin API methods also support:
 
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `content_type` | `str` | Content type (`json`, `octet-stream`) |
-| `additional_query_params` | `dict` | URL query parameters |
+| Parameter                 | Type   | Description                           |
+|---------------------------|--------|---------------------------------------|
+| `content_type`            | `str`  | Content type (`json`, `octet-stream`) |
+| `additional_query_params` | `dict` | URL query parameters                  |
 
 ### Custom Headers
 
@@ -442,10 +463,10 @@ except ShopwareAPIError as e:
 
 ### Exception Types
 
-| Exception | When Raised |
-|-----------|-------------|
+| Exception            | When Raised                                     |
+|----------------------|-------------------------------------------------|
 | `ConfigurationError` | Missing .env file, invalid configuration values |
-| `ShopwareAPIError` | HTTP errors from the API (4xx, 5xx responses) |
+| `ShopwareAPIError`   | HTTP errors from the API (4xx, 5xx responses)   |
 
 ---
 

{lib_shopware6_api_base-3.1.2 → lib_shopware6_api_base-4.0.0}/README.md

@@ -69,10 +69,28 @@ This is the base abstraction layer. For higher-level functions, see [lib_shopwar
 
 ## Configuration
 
-Configuration is managed via the `ConfShopware6ApiBase` class (Pydantic-based) which can load settings from:
-1. Environment variables
-2. A `.env` file
-3. Direct instantiation
+Configuration is managed via the `ConfShopware6ApiBase` class (Pydantic) and loaded
+through [`lib_layered_config`](https://github.com/bitranox/lib_layered_config), which
+merges, in increasing precedence:
+
+```
+bundled defaults  ->  app  ->  host  ->  user  ->  .env  ->  environment variables
+```
+
+You can also instantiate `ConfShopware6ApiBase(...)` directly with keyword arguments.
+
+> **⚠️ Breaking change in 4.0.0 — env vars renamed.** Configuration moved to
+> `lib_layered_config`, so the old single-underscore `SHOPWARE_*` variables are **no
+> longer read**. Rename them to the `[shopware]` section form:
+>
+> | Old (≤ 3.x)                        | New — `.env` file              | New — environment variable                              |
+> |------------------------------------|--------------------------------|---------------------------------------------------------|
+> | `SHOPWARE_ADMIN_API_URL`           | `SHOPWARE__ADMIN_API_URL`      | `LIB_SHOPWARE6_API_BASE___SHOPWARE__ADMIN_API_URL`      |
+> | `SHOPWARE_STOREFRONT_API_URL`      | `SHOPWARE__STOREFRONT_API_URL` | `LIB_SHOPWARE6_API_BASE___SHOPWARE__STOREFRONT_API_URL` |
+> | `SHOPWARE_<NAME>`                  | `SHOPWARE__<NAME>`             | `LIB_SHOPWARE6_API_BASE___SHOPWARE__<NAME>`             |
+>
+> i.e. in a `.env` file replace the single `_` after `SHOPWARE` with `__`; as a real
+> environment variable also add the `LIB_SHOPWARE6_API_BASE___` slug prefix.
 
 ### Environment File (.env)
 
@@ -80,42 +98,44 @@ Copy `example.env` to `.env` and adjust values for your shop:
 
 ```bash
 # API Endpoints
-SHOPWARE_ADMIN_API_URL="https://shop.example.com/api"
-SHOPWARE_STOREFRONT_API_URL="https://shop.example.com/store-api"
+SHOPWARE__ADMIN_API_URL="https://shop.example.com/api"
+SHOPWARE__STOREFRONT_API_URL="https://shop.example.com/store-api"
 
-# OAuth2 Security (set to "1" only for local HTTP development)
-SHOPWARE_INSECURE_TRANSPORT="0"
+# Transport (set to "1" only for local HTTP development)
+SHOPWARE__INSECURE_TRANSPORT="0"
 
-# User Credentials Grant (for interactive apps with refresh tokens)
-SHOPWARE_USERNAME="admin@example.com"
-SHOPWARE_PASSWORD="your-password"
+# User-Credentials grant (interactive apps with refresh tokens)
+SHOPWARE__USERNAME="admin@example.com"
+SHOPWARE__PASSWORD="your-password"
 
-# Resource Owner Grant (for automation/CLI - no refresh tokens)
-SHOPWARE_CLIENT_ID="SWIAXXXXXXXXXXXXXXXXXXXX"
-SHOPWARE_CLIENT_SECRET="your-integration-secret"
+# Resource-Owner grant (automation/CLI - no refresh tokens)
+SHOPWARE__CLIENT_ID="SWIAXXXXXXXXXXXXXXXXXXXX"
+SHOPWARE__CLIENT_SECRET="your-integration-secret"
 
 # Grant type: USER_CREDENTIALS or RESOURCE_OWNER
-SHOPWARE_GRANT_TYPE="RESOURCE_OWNER"
+SHOPWARE__GRANT_TYPE="RESOURCE_OWNER"
 
 # Storefront API access key (from Sales Channel settings)
-SHOPWARE_STORE_API_SW_ACCESS_KEY="SWSCXXXXXXXXXXXXXXXXXX"
+SHOPWARE__STORE_API_SW_ACCESS_KEY="SWSCXXXXXXXXXXXXXXXXXX"
 ```
 
-#### .env Settings Reference
+#### `[shopware]` Settings Reference
 
-All environment variables use the `SHOPWARE_` prefix to avoid collision with system variables.
+In a `.env` file use the `SHOPWARE__<KEY>` form; as a real environment variable prefix
+with `LIB_SHOPWARE6_API_BASE___`. The same keys can be set in a TOML config file under
+`[shopware]` (dropping the `SHOPWARE__` prefix).
 
-| Variable | Description                                                   | Example |
-|----------|---------------------------------------------------------------|---------|
-| `SHOPWARE_ADMIN_API_URL` | Admin API endpoint                                            | `https://shop.example.com/api` |
-| `SHOPWARE_STOREFRONT_API_URL` | Storefront API endpoint                                       | `https://shop.example.com/store-api` |
-| `SHOPWARE_INSECURE_TRANSPORT` | Allow HTTP (dev only)                                         | `0` (production) or `1` (dev) |
-| `SHOPWARE_USERNAME` | Admin user email                                              | `admin@example.com` |
-| `SHOPWARE_PASSWORD` | Admin user password                                           | `secret` |
-| `SHOPWARE_CLIENT_ID` | Integration Access ID | `SWIA...` |
-| `SHOPWARE_CLIENT_SECRET` | Integration Secret                                            | `...` |
-| `SHOPWARE_GRANT_TYPE` | Auth method                                                   | `USER_CREDENTIALS` or `RESOURCE_OWNER` |
-| `SHOPWARE_STORE_API_SW_ACCESS_KEY` | Storefront access key                                         | `SWSC...` |
+| `.env` key                         | Description             | Example                                |
+|------------------------------------|-------------------------|----------------------------------------|
+| `SHOPWARE__ADMIN_API_URL`          | Admin API endpoint      | `https://shop.example.com/api`         |
+| `SHOPWARE__STOREFRONT_API_URL`     | Storefront API endpoint | `https://shop.example.com/store-api`   |
+| `SHOPWARE__INSECURE_TRANSPORT`     | Allow HTTP (dev only)   | `0` (production) or `1` (dev)          |
+| `SHOPWARE__USERNAME`               | Admin user email        | `admin@example.com`                    |
+| `SHOPWARE__PASSWORD`               | Admin user password     | `secret`                               |
+| `SHOPWARE__CLIENT_ID`              | Integration Access ID   | `SWIA...`                              |
+| `SHOPWARE__CLIENT_SECRET`          | Integration Secret      | `...`                                  |
+| `SHOPWARE__GRANT_TYPE`             | Auth method             | `USER_CREDENTIALS` or `RESOURCE_OWNER` |
+| `SHOPWARE__STORE_API_SW_ACCESS_KEY`| Storefront access key   | `SWSC...`                              |
 
 ### Loading Configuration
 
@@ -205,18 +225,18 @@ products = client.request_post("product", payload=criteria)
 
 All request methods accept these parameters:
 
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `request_url` | `str` | API endpoint (without base URL) |
-| `payload` | `dict \| Criteria \| None` | Request body |
-| `update_header_fields` | `dict[str, str] \| None` | Custom headers |
+| Parameter              | Type                       | Description                     |
+|------------------------|----------------------------|---------------------------------|
+| `request_url`          | `str`                      | API endpoint (without base URL) |
+| `payload`              | `dict \| Criteria \| None` | Request body                    |
+| `update_header_fields` | `dict[str, str] \| None`   | Custom headers                  |
 
 Admin API methods also support:
 
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `content_type` | `str` | Content type (`json`, `octet-stream`) |
-| `additional_query_params` | `dict` | URL query parameters |
+| Parameter                 | Type   | Description                           |
+|---------------------------|--------|---------------------------------------|
+| `content_type`            | `str`  | Content type (`json`, `octet-stream`) |
+| `additional_query_params` | `dict` | URL query parameters                  |
 
 ### Custom Headers
 
@@ -389,10 +409,10 @@ except ShopwareAPIError as e:
 
 ### Exception Types
 
-| Exception | When Raised |
-|-----------|-------------|
+| Exception            | When Raised                                     |
+|----------------------|-------------------------------------------------|
 | `ConfigurationError` | Missing .env file, invalid configuration values |
-| `ShopwareAPIError` | HTTP errors from the API (4xx, 5xx responses) |
+| `ShopwareAPIError`   | HTTP errors from the API (4xx, 5xx responses)   |
 
 ---
 

lib_shopware6_api_base-4.0.0/example.env

@@ -0,0 +1,48 @@
+# =============================================================================
+# Shopware 6 API Configuration - Example .env
+# =============================================================================
+#
+# Copy this file to .env and adjust the values for your shop.
+#
+# Configuration is loaded through lib_layered_config and merged in increasing
+# precedence: bundled defaults -> app -> host -> user -> .env -> environment.
+#
+# Naming convention (IMPORTANT — changed in 4.0.0):
+#   - In a .env file, use the SECTION__KEY form (double underscore), no prefix:
+#         SHOPWARE__ADMIN_API_URL=...
+#         LIB_LOG_RICH__CONSOLE_LEVEL=DEBUG
+#   - As a real environment variable, prefix with the slug:
+#         LIB_SHOPWARE6_API_BASE___SHOPWARE__ADMIN_API_URL=...
+#
+# Migration from <=3.x: the old single-underscore SHOPWARE_* variables
+# (e.g. SHOPWARE_ADMIN_API_URL) are NO LONGER read. Rename them to the
+# [shopware] section form above (SHOPWARE__ADMIN_API_URL, ...).
+# =============================================================================
+
+# --- API Endpoints --------------------------------------------------------
+SHOPWARE__ADMIN_API_URL="https://shop.example.com/api"
+SHOPWARE__STOREFRONT_API_URL="https://shop.example.com/store-api"
+
+# --- Transport ------------------------------------------------------------
+# Allow plain HTTP (HTTP instead of HTTPS). "0" in production; "1" only for local dev.
+SHOPWARE__INSECURE_TRANSPORT="0"
+
+# --- Authentication: User-Credentials grant (interactive; refresh tokens) -
+# Setup: Admin Panel > Settings > System > Users
+SHOPWARE__USERNAME="api-user@example.com"
+SHOPWARE__PASSWORD="your-secure-password-here"
+
+# --- Authentication: Resource-Owner / Integration grant (automation) ------
+# Setup: Admin Panel > Settings > System > Integrations
+SHOPWARE__CLIENT_ID="SWIAXXXXXXXXXXXXXXXXXXXX"
+SHOPWARE__CLIENT_SECRET="your-integration-secret-key-here"
+
+# --- Grant type: USER_CREDENTIALS or RESOURCE_OWNER -----------------------
+SHOPWARE__GRANT_TYPE="RESOURCE_OWNER"
+
+# --- Store API access key (sw-access-key from the Sales Channel) ----------
+SHOPWARE__STORE_API_SW_ACCESS_KEY="SWSCXXXXXXXXXXXXXXXXXX"
+
+# --- Logging (lib_log_rich) — optional overrides --------------------------
+# LIB_LOG_RICH__CONSOLE_LEVEL=INFO
+# LIB_LOG_RICH__ENVIRONMENT=prod

{lib_shopware6_api_base-3.1.2 → lib_shopware6_api_base-4.0.0}/pyproject.toml

@@ -1,12 +1,13 @@
 [project]
 name = "lib_shopware6_api_base"
-version = "3.1.2"
+version = "4.0.0"
 description = "python3 base API client for shopware6"
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
     "pydantic>=2.13.4",
-    "pydantic-settings>=2.14.1",
+    "lib_layered_config>=5.5.1",
+    "lib_log_rich>=6.3.4",
     "lib_cli_exit_tools>=2.3.1",
     "rich-click",
     "orjson",
@@ -71,6 +72,8 @@ build-backend = "hatchling.build"
 packages = ["src/lib_shopware6_api_base"]
 include = [
     "src/lib_shopware6_api_base/py.typed",
+    "src/lib_shopware6_api_base/defaultconfig.toml",
+    "src/lib_shopware6_api_base/defaultconfig.d/*.toml",
 ]
 
 [tool.ruff]

{lib_shopware6_api_base-3.1.2 → lib_shopware6_api_base-4.0.0}/src/lib_shopware6_api_base/__init__conf__.py

@@ -26,7 +26,7 @@ name = "lib_shopware6_api_base"
 #: Human-readable summary shown in CLI help output.
 title = "python3 base API client for shopware6"
 #: Current release version pulled from ``pyproject.toml`` by automation.
-version = "3.1.2"
+version = "4.0.0"
 #: Repository homepage presented to users.
 homepage = "https://github.com/bitranox/lib_shopware6_api_base"
 #: Author attribution surfaced in CLI output.

lib_shopware6_api_base-4.0.0/src/lib_shopware6_api_base/conf_shopware6_api_base_classes.py

@@ -0,0 +1,143 @@
+# STDLIB
+from enum import Enum
+from typing import Any
+
+# EXT
+from pydantic import AliasChoices, BaseModel, ConfigDict, Field, field_validator
+
+# PROJ
+from .config import get_config
+
+__all__ = [
+    "GrantType",
+    "HttpMethod",
+    "ShopwareAPIError",
+    "ConfigurationError",
+    "ConfShopware6ApiBase",
+    "load_config_from_env",
+    "require_config_from_env",
+]
+
+
+class GrantType(str, Enum):
+    """OAuth2 grant type for Shopware6 API authentication."""
+
+    USER_CREDENTIALS = "user_credentials"
+    RESOURCE_OWNER = "resource_owner"
+
+
+class HttpMethod(str, Enum):
+    """HTTP methods supported by the Shopware6 API."""
+
+    GET = "get"
+    PATCH = "patch"
+    POST = "post"
+    PUT = "put"
+    DELETE = "delete"
+
+
+class ShopwareAPIError(Exception):
+    """Exception raised for Shopware API errors."""
+
+
+class ConfigurationError(Exception):
+    """Exception raised for configuration errors."""
+
+
+class ConfShopware6ApiBase(BaseModel):
+    """Configuration for a Shopware6 API connection.
+
+    The values are loaded through ``lib_layered_config`` from the ``[shopware]``
+    section (bundled defaults -> app -> host -> user -> ``.env`` -> environment),
+    but the model may also be instantiated directly with keyword arguments.
+
+    Environment variables use the ``lib_layered_config`` scheme, e.g.::
+
+        LIB_SHOPWARE6_API_BASE___SHOPWARE__ADMIN_API_URL=https://shop.example.com/api
+
+    or, inside a ``.env`` file (no slug prefix)::
+
+        SHOPWARE__ADMIN_API_URL=https://shop.example.com/api
+    """
+
+    model_config = ConfigDict(populate_by_name=True, validate_assignment=True, extra="ignore")
+
+    # API Endpoints (TOML keys drop the redundant ``shopware_`` prefix).
+    shopware_admin_api_url: str = Field(default="", validation_alias=AliasChoices("admin_api_url", "shopware_admin_api_url"))
+    shopware_storefront_api_url: str = Field(
+        default="", validation_alias=AliasChoices("storefront_api_url", "shopware_storefront_api_url")
+    )
+
+    # User-Credentials grant (with refresh token).
+    username: str = ""
+    password: str = ""
+
+    # Resource-Owner / Integration grant (no refresh token).
+    client_id: str = ""
+    client_secret: str = ""
+
+    # Grant type selection.
+    grant_type: GrantType = GrantType.USER_CREDENTIALS
+
+    # Storefront API access key.
+    store_api_sw_access_key: str = ""
+
+    # Allow plain HTTP (development only); "1" enables it.
+    insecure_transport: str = "0"
+
+    # Follow HTTP redirects (may expose auth tokens to redirect targets).
+    follow_redirects: bool = False
+
+    # Emit debug logging of all HTTP requests/responses (may expose secrets).
+    enable_request_logging: bool = False
+
+    @field_validator("grant_type", mode="before")
+    @classmethod
+    def parse_grant_type(cls, v: str | GrantType) -> GrantType:
+        """Parse grant_type from a string ("USER_CREDENTIALS"/"user_credentials") or enum."""
+        if isinstance(v, GrantType):
+            return v
+        v_upper = v.upper()
+        if v_upper in ("USER_CREDENTIALS", "RESOURCE_OWNER"):
+            return GrantType(v.lower())
+        try:
+            return GrantType(v.lower())
+        except ValueError:
+            pass
+        raise ValueError(f"Invalid grant_type: {v!r}. Must be 'USER_CREDENTIALS' or 'RESOURCE_OWNER'")
+
+
+def _load_shopware_section() -> dict[str, Any]:
+    """Return the merged ``[shopware]`` configuration section as a plain dict."""
+    raw: Any = get_config().get("shopware", default={})
+    return dict(raw) if raw else {}
+
+
+def load_config_from_env() -> ConfShopware6ApiBase:
+    """Load the Shopware configuration via ``lib_layered_config``.
+
+    Reads the ``[shopware]`` section merged across all configuration layers
+    (bundled defaults, app/host/user config files, ``.env``, environment).
+
+    Returns:
+        ConfShopware6ApiBase: the loaded configuration (fields default to empty
+        when nothing is configured).
+    """
+    return ConfShopware6ApiBase(**_load_shopware_section())
+
+
+def require_config_from_env() -> ConfShopware6ApiBase:
+    """Load the configuration, raising if no Shopware endpoint is configured.
+
+    Raises:
+        ConfigurationError: if neither the admin nor the storefront API URL is set.
+    """
+    config = load_config_from_env()
+    if not (config.shopware_admin_api_url or config.shopware_storefront_api_url):
+        raise ConfigurationError(
+            "No Shopware configuration found.\n\n"
+            "Provide a [shopware] section via a config file, a .env file, or environment\n"
+            "variables (e.g. LIB_SHOPWARE6_API_BASE___SHOPWARE__ADMIN_API_URL=...).\n"
+            "See example.env / the README for the full list of settings."
+        )
+    return config

lib_shopware6_api_base-4.0.0/src/lib_shopware6_api_base/config.py

@@ -0,0 +1,50 @@
+"""Layered configuration loading via ``lib_layered_config``.
+
+All configuration for this package — both the Shopware connection settings
+(``[shopware]``) and logging (``[lib_log_rich]``) — is loaded through
+``lib_layered_config``, which merges, in increasing precedence:
+
+    defaults (bundled) → app → host → user → ``.env`` → environment variables
+
+The vendor / app / slug identifiers (see :mod:`__init__conf__`) determine the
+platform-specific config file locations and the environment-variable prefix.
+"""
+
+from __future__ import annotations
+
+from functools import lru_cache
+from pathlib import Path
+
+from lib_layered_config import Config, read_config
+
+from . import __init__conf__
+
+__all__ = ["get_config", "get_default_config_path"]
+
+
+def get_default_config_path() -> Path:
+    """Return the path to the bundled ``defaultconfig.toml`` shipped with the package."""
+    return Path(__file__).parent / "defaultconfig.toml"
+
+
+@lru_cache(maxsize=4)
+def get_config(*, profile: str | None = None, start_dir: str | None = None) -> Config:
+    """Load the merged, layered configuration.
+
+    Args:
+        profile: Optional profile name for environment isolation (inserts a
+            ``profile/<name>/`` subdirectory into all config paths).
+        start_dir: Optional directory that seeds ``.env`` discovery (defaults to cwd).
+
+    Returns:
+        An immutable :class:`lib_layered_config.Config`. Sections are read with
+        ``config.get("<section>", default={})``.
+    """
+    return read_config(
+        vendor=__init__conf__.LAYEREDCONF_VENDOR,
+        app=__init__conf__.LAYEREDCONF_APP,
+        slug=__init__conf__.LAYEREDCONF_SLUG,
+        profile=profile,
+        default_file=get_default_config_path(),
+        start_dir=start_dir,
+    )

lib_shopware6_api_base-4.0.0/src/lib_shopware6_api_base/defaultconfig.d/10-logging.toml

@@ -0,0 +1,26 @@
+# ==============================================================================
+# [lib_log_rich] — Rich-powered structured logging
+# ==============================================================================
+#
+# Loaded via lib_layered_config and passed to lib_log_rich.runtime.RuntimeConfig.
+# Override via host/user config, a .env file, or environment variables:
+#
+#   .env:        LIB_LOG_RICH__CONSOLE_LEVEL=DEBUG
+#   environment: LIB_SHOPWARE6_API_BASE___LIB_LOG_RICH__CONSOLE_LEVEL=DEBUG
+#
+# Only the most common keys are listed here; every RuntimeConfig field is
+# accepted. See https://github.com/bitranox/lib_log_rich for the full reference.
+#
+[lib_log_rich]
+
+# Logical service name recorded on each log event.
+service = "lib_shopware6_api_base"
+
+# Deployment environment label (dev, staging, prod, local, ...).
+environment = "prod"
+
+# Minimum console severity: DEBUG, INFO, WARNING, ERROR, CRITICAL.
+console_level = "INFO"
+
+# Minimum severity for backend adapters (journald / Windows Event Log).
+backend_level = "WARNING"