🔧 easySSP Utils

This module provides shared utilities for the easySSP Python clients. It contains essential functionality such as HTTP request handling, custom exceptions, logging support, and reusable helpers that streamline the integration with the easySSP APIs.

✨ Features

• 📦 Shared core functions for easySSP Python clients
• ✅ Centralized request handling with retry and error management
• 🧰 Utilities for common API-related tasks (e.g., headers, parsing)
• 🚨Exception classes for consistent and transparent error reporting

📦 Installation

pip install easyssp-utils

Or clone and install from source:

git clone https://github.com/exxcellent/easyssp-python-clients-util.git
cd easyssp-python-clients-util
pip install -e .

📁 Project Structure

easyssp_utils/
├── __init__.py
├── client/
│   ├── __init__.py
│   ├── api_client.py         # Generic API client for OpenAPI client library builds
│   ├── api_response.py       # API response object
│   ├── configuration.py      # Settings of the API client
│   ├── exceptions.py         # Exceptions for the API client
│   └── rest.py               # Performing the HTTP requests
│
├── models/
│   ├── __init__.py
│   ├── client_localized_message.py       
│   ├── error_message.py        
│   ├── localized_error_message.py        
│   └── localized_message_key.py          

📚 Documentation

Each utility module is documented inline with docstrings. For detailed usage and integration patterns, refer to the respective client documentation.

Documentation for models

• ClientLocalizedMessage
• ErrorMessage
• LocalizedErrorMessage
• LocalizedMessageKey

🛠️ Requirements

• Python 3.11+

Install dependencies using uv:

pip install uv
uv sync

🤝 Contributing

This module is maintained as part of the easySSP ecosystem. If you find issues or want to suggest improvements, please open an issue or submit a pull request.

📄 License

This project is licensed under the MIT License.