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

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

@@ -5,6 +5,12 @@ 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).
 
+## [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-3.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lib_shopware6_api_base
-Version: 3.1.2
+Version: 3.1.3
 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
@@ -158,17 +158,17 @@ SHOPWARE_STORE_API_SW_ACCESS_KEY="SWSCXXXXXXXXXXXXXXXXXX"
 
 All environment variables use the `SHOPWARE_` prefix to avoid collision with system variables.
 
-| 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...` |
+| 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...`                              |
 
 ### Loading Configuration
 
@@ -258,18 +258,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 +442,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-3.1.3}/README.md

@@ -105,17 +105,17 @@ SHOPWARE_STORE_API_SW_ACCESS_KEY="SWSCXXXXXXXXXXXXXXXXXX"
 
 All environment variables use the `SHOPWARE_` prefix to avoid collision with system variables.
 
-| 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...` |
+| 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...`                              |
 
 ### Loading Configuration
 
@@ -205,18 +205,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 +389,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-3.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lib_shopware6_api_base"
-version = "3.1.2"
+version = "3.1.3"
 description = "python3 base API client for shopware6"
 readme = "README.md"
 requires-python = ">=3.10"

{lib_shopware6_api_base-3.1.2 → lib_shopware6_api_base-3.1.3}/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 = "3.1.3"
 #: Repository homepage presented to users.
 homepage = "https://github.com/bitranox/lib_shopware6_api_base"
 #: Author attribution surfaced in CLI output.