Metadata-Version: 2.4
Name: easyssp-utils
Version: 1.0.0
Summary: A collection of utilities to streamline interaction with the easySSP APIs.
Project-URL: Homepage, https://www.easy-ssp.com
Project-URL: Release Changelog, https://github.com/exxcellent/easyssp-python-clients-util/releases
Project-URL: Source, https://github.com/exxcellent/easyssp-python-clients-util
Author-email: easySSP Dev Team <easyssp-dev@exxcellent.de>
License: MIT
License-File: LICENSE
Keywords: client,easySSP,python,utils
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.11
Requires-Dist: easyssp-auth-client>=1.0.0
Requires-Dist: pydantic>=2.11.3
Requires-Dist: python-dateutil>=2.9.0.post0
Requires-Dist: types-python-dateutil>=2.9.0.20241206
Requires-Dist: urllib3>=2.4.0
Description-Content-Type: text/markdown

![easyssp-logo-light](https://raw.githubusercontent.com/exxcellent/easyssp-auth-client-python/refs/heads/master/images/logo-light.png#gh-light-mode-only)

# 🔧 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

```bash
pip install easyssp-utils
```

Or clone and install from source:

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

## 📁 Project Structure

```bash
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          
```

## 🛠️ Requirements

- Python 3.11+

Install dependencies using uv:

```bash
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.