Add initial project structure and tests for Elytra PIM Client

- Created pyproject.toml for project metadata and dependencies. - Added requirements.txt for development and production dependencies. - Implemented basic test structure in the tests module. - Developed unit tests for ElytraClient, including Pydantic validation and error handling.
2026-02-20 09:08:43 +01:00 · 2026-02-20 09:08:43 +01:00 · 05fca294f9
commit 05fca294f9
15 changed files with 10532 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,238 @@
+# Elytra PIM Client
+
+A fully Pythonic and **Pydantic-driven** client for the Elytra PIM (Product Information Management) API.
+
+## Features
+
+- 🐍 Fully Pythonic with Pydantic v2 data validation
+- 📦 Auto-generated Pydantic models from OpenAPI specification
+- 🔐 Bearer token authentication
+- ✅ Request/Response validation with Pydantic
+- 🌍 Multi-language support
+- 📄 Full type hints throughout the codebase
+- 🧪 Comprehensive error handling
+- 🔄 Context manager support
+- 🔄 Automatic serialization/deserialization
+
+## Installation
+
+### From Source
+
+Clone the repository:
+
+```bash
+git clone https://git.him-tools.de/HIM-public/elytra_client.git
+cd elytra_client
+pip install -e .
+```
+
+### With Development Dependencies
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from elytra_client import ElytraClient, SingleProductResponse
+
+# Initialize the client
+client = ElytraClient(
+    base_url="https://example.com/api/v1",
+    api_key="your-api-key"
+)
+
+# Get all products - returns dict with Pydantic validated items
+products_response = client.get_products(lang="en", page=1, limit=10)
+for product in products_response["items"]:
+    print(f"Product: {product.productName}, ID: {product.id}")
+
+# Get a specific product - returns Pydantic model directly
+product: SingleProductResponse = client.get_product(product_id=123, lang="en")
+print(f"Name: {product.productName}")
+print(f"Status: {product.objectStatus}")
+
+# Close the client
+client.close()
+```
+
+### Creating Products with Validation
+
+```python
+from elytra_client import (
+    ElytraClient,
+    SingleNewProductRequestBody,
+    AttributeRequestBody,
+)
+
+with ElytraClient(base_url="https://example.com/api/v1", api_key="your-api-key") as client:
+    # Create a new product with validated Pydantic model
+    new_product = SingleNewProductRequestBody(
+        productName="NEW-PRODUCT-001",
+        parentId=1,
+        attributeGroupId=10,
+        attributes=[
+            AttributeRequestBody(
+                attributeId=1,
+                value="Sample Value",
+                languageCode="en"
+            )
+        ]
+    )
+    
+    # Validation happens automatically
+    created_product = client.create_product(new_product)
+    print(f"Created product ID: {created_product.id}")
+```
+
+### Environment Variable Configuration
+
+Set your environment variables:
+
+```bash
+export ELYTRA_BASE_URL="https://example.com/api/v1"
+export ELYTRA_API_KEY="your-api-key"
+export ELYTRA_TIMEOUT="30"
+export ELYTRA_VERIFY_SSL="true"
+```
+
+Then load from environment:
+
+```python
+from elytra_client import ElytraClient
+from elytra_client.config import ElytraConfig
+
+config = ElytraConfig.from_env()
+client = ElytraClient(base_url=config.base_url, api_key=config.api_key)
+```
+
+## API Methods
+
+All methods return Pydantic models with full type validation and IDE autocompletion support.
+
+### Products
+
+- `get_products(...) -> Dict` - Get all products (items are `SingleProductResponse` Pydantic models)
+- `get_product(id, lang) -> SingleProductResponse` - Get single product
+- `create_product(data) -> SingleProductResponse` - Create new product with validation
+- `update_product(data) -> SingleProductResponse` - Update product with validation
+- `delete_product(id) -> Dict` - Delete product
+
+### Product Groups
+
+- `get_product_groups(...) -> Dict` - Get all product groups (items are `SingleProductGroupResponse` models)
+- `get_product_group(id, lang) -> SingleProductGroupResponse` - Get single product group
+- `create_product_group(data) -> SingleProductGroupResponse` - Create new product group
+- `update_product_group(data) -> SingleProductGroupResponse` - Update product group
+- `delete_product_group(id) -> Dict` - Delete product group
+
+### Attributes
+
+- `get_attributes(...) -> Dict` - Get all attributes (items are `SingleAttributeResponse` models)
+- `get_attribute(id, lang) -> SingleAttributeResponse` - Get single attribute
+
+### Health Check
+
+- `health_check() -> Dict` - Check API health status
+
+## Error Handling
+
+The client provides specific exception classes for different error types:
+
+```python
+from elytra_client import ElytraClient
+from elytra_client.exceptions import (
+    ElytraAuthenticationError,
+    ElytraNotFoundError,
+    ElytraValidationError,
+    ElytraAPIError,
+)
+from pydantic import ValidationError
+
+try:
+    client = ElytraClient(base_url="https://example.com/api/v1", api_key="invalid-key")
+    product = client.get_product(123)
+except ElytraAuthenticationError:
+    print("Authentication failed")
+except ElytraNotFoundError:
+    print("Product not found")
+except ElytraValidationError as e:
+    print(f"API response validation failed: {e}")
+except ValidationError as e:
+    print(f"Request model validation failed: {e}")
+except ElytraAPIError as e:
+    print(f"API error: {e}")
+```
+
+### Validation
+
+- **Request validation**: Pydantic models validate all input before sending to API
+- **Response validation**: Pydantic models validate API responses for data integrity
+- **Automatic deserialization**: Responses are automatically converted to Pydantic models
+
+## Pydantic Models
+
+All request and response models are automatically generated from the OpenAPI specification using [datamodel-code-generator](https://github.com/koxudaxi/datamodel-code-generator).
+
+### Available Models
+
+- **Response Models**: `SingleProductResponse`, `SingleProductGroupResponse`, `SingleAttributeResponse`, etc.
+- **Request Models**: `SingleNewProductRequestBody`, `SingleUpdateProductRequestBody`, `SingleNewProductGroupRequestBody`, etc.
+- **Attribute Models**: `ProductAttributeResponse`, `AttributeRequestBody`
+
+All models include:
+- ✅ Full type hints and validation
+- ✅ Documentation from OpenAPI spec
+- ✅ IDE autocompletion support
+- ✅ Automatic serialization/deserialization
+
+### Regenerating Models
+
+To regenerate models from the OpenAPI spec:
+
+```bash
+python -m datamodel_code_generator --input openapi.yaml --input-file-type openapi --output elytra_client/models.py --target-python-version 3.10
+```
+
+## Development
+
+### Running Tests
+
+```bash
+pytest
+```
+
+### Code Quality
+
+Format code with Black:
+
+```bash
+black elytra_client tests
+```
+
+Check with flake8:
+
+```bash
+flake8 elytra_client tests
+```
+
+Type checking with mypy:
+
+```bash
+mypy elytra_client
+```
+
+## API Documentation
+
+For complete API documentation, refer to the OpenAPI specification in `openapi.yaml` or visit the Elytra website: https://www.elytra.ch/
+
+## Contact
+
+For support, please email: support@elytra.ch
+
+## License
+
+MIT License - see LICENSE file for details