cledar-sdk 1.0.1__py3-none-any.whl → 1.2.0__py3-none-any.whl

cledar_sdk-1.2.0.dist-info/METADATA

@@ -0,0 +1,263 @@
+Metadata-Version: 2.4
+Name: cledar-sdk
+Version: 1.2.0
+Summary: Cledar Python SDK
+Author: Cledar
+License-File: LICENSE
+Requires-Python: >=3.12.7
+Requires-Dist: adlfs>=2025.8.0
+Requires-Dist: boto3-stubs>=1.34.138
+Requires-Dist: boto3>=1.34.138
+Requires-Dist: confluent-kafka>=2.4.0
+Requires-Dist: ecs-logging>=2.1.0
+Requires-Dist: fastapi>=0.112.3
+Requires-Dist: fsspec>=2025.9.0
+Requires-Dist: prometheus-client>=0.20.0
+Requires-Dist: pydantic-settings>=2.3.3
+Requires-Dist: pydantic>=2.7.0
+Requires-Dist: redis>=5.2.1
+Requires-Dist: s3fs>=2025.9.0
+Requires-Dist: uvicorn>=0.30.6
+Description-Content-Type: text/markdown
+
+# Cledar Python SDK
+
+## Project Description
+
+**Cledar Python SDK** is a shared set of production‑ready services and utilities used across Cledar projects. It can be installed from PyPI (recommended), or consumed as a Git dependency or Git submodule.
+
+Included modules:
+- kafka_service: Kafka Producer/Consumer, helpers and DLQ handler
+- storage_service: Object storage abstraction (S3/ABFS/local via fsspec)
+- monitoring_service: FastAPI monitoring server with Prometheus metrics and healthchecks
+- redis_service: Redis‑backed typed config store
+- kserve_service: KServe helpers
+- common_logging: Common logging utilities
+---
+
+## Installation and Setup
+
+1. **From PyPI (recommended)**
+
+   Using pip:
+   ```bash
+   pip install cledar-sdk
+   ```
+
+   Using uv:
+   ```bash
+   uv add cledar-sdk
+   ```
+
+   Pin a specific version (example):
+   ```bash
+   pip install "cledar-sdk==1.0.1"
+   ```
+
+2. **From Git (alternative)**
+
+   Using pip (SSH, specific tag):
+   ```bash
+   pip install "git+ssh://git@github.com/Cledar/cledar-python-sdk.git@v1.0.1"
+   ```
+
+   Using uv (SSH, specific tag):
+   ```bash
+   uv add --git ssh://git@github.com/Cledar/cledar-python-sdk.git@v1.0.1
+   ```
+
+   You can also point to a branch (e.g. `main`) instead of a tag.
+
+3. **As a Git submodule**
+   ```bash
+   git submodule add git@github.com:Cledar/cledar-python-sdk.git vendor/cledar-python-sdk
+   git submodule update --init --recursive
+   ```
+   Optionally install it in editable mode from the submodule path:
+   ```bash
+   uv add -e ./vendor/cledar-python-sdk
+   ```
+
+4. **Developing locally**
+   ```bash
+   git clone git@github.com/Cledar/cledar-python-sdk.git
+   cd cledar-python-sdk
+   uv sync
+   ```
+
+Python version required: 3.12.7
+
+## Testing
+
+Unit tests are implemented using **pytest** and **unittest**.
+
+1. Run tests:
+   ```bash
+   uv run pytest
+   ```
+
+2. Adding tests:
+   Place tests under each module's `tests` directory (e.g. `kafka_service/tests`, `storage_service/tests`) or create files with the `_test.py` suffix.
+
+---
+
+## Quick Start Examples
+
+### Kafka
+Producer:
+```python
+from kafka_service.clients.producer import KafkaProducer
+from kafka_service.config.schemas import KafkaProducerConfig
+
+cfg = KafkaProducerConfig(
+    kafka_servers="localhost:9092",
+    kafka_group_id="example",
+    kafka_topic_prefix="dev",
+    compression_type="snappy",
+    kafka_partitioner="consistent_random",
+)
+producer = KafkaProducer(config=cfg)
+producer.connect()
+producer.send(topic="my-topic", value='{"id":"123","payload":"hello"}', key="123")
+```
+
+Consumer:
+```python
+from kafka_service.clients.consumer import KafkaConsumer
+from kafka_service.config.schemas import KafkaConsumerConfig
+
+cfg = KafkaConsumerConfig(
+    kafka_servers="localhost:9092",
+    kafka_group_id="example",
+    kafka_topic_prefix="dev",
+    kafka_offset="earliest",
+    kafka_auto_commit_interval_ms=5000,
+)
+consumer = KafkaConsumer(config=cfg)
+consumer.connect()
+consumer.subscribe(["my-topic"])
+msg = consumer.consume_next()
+if msg:
+    consumer.commit(msg)
+```
+
+### Object Storage (S3/ABFS/local)
+```python
+from storage_service.object_storage import ObjectStorageService
+from storage_service.models import ObjectStorageServiceConfig
+
+cfg = ObjectStorageServiceConfig(
+    s3_access_key="minioadmin",
+    s3_secret_key="minioadmin",
+    s3_endpoint_url="http://localhost:9000",
+)
+storage = ObjectStorageService(config=cfg)
+storage.upload_file(
+    file_path="README.md",
+    destination_path="s3://bucket/path/README.md",
+)
+```
+
+### Monitoring Server
+```python
+from monitoring_service.monitoring_server import MonitoringServer, MonitoringServerConfig
+
+config = MonitoringServerConfig(
+    readiness_checks={"s3": storage.is_alive},
+    liveness_checks={"app": lambda: True},
+)
+server = MonitoringServer(host="0.0.0.0", port=8080, config=config)
+server.start_monitoring_server()
+```
+
+### Redis Config Store
+```python
+from redis import Redis
+from redis_service.redis_config_store import RedisConfigStore
+
+redis = Redis(host="localhost", port=6379, db=0)
+store = RedisConfigStore(redis=redis, prefix="example:")
+# See redis_service/example.py for a full typed config provider example
+```
+
+## Code Quality
+
+- **pydantic** - settings management
+- **ruff**, **mypy** - Linting, formatting, and static type checking
+- **pre-commit** - Pre-commit file checks
+
+## Linting 
+
+If you want to run linting or type checker manually, you can use the following commands. Pre-commit will run these checks automatically before each commit.
+```bash
+uv run ruff format .
+uv run ruff check .
+uv run mypy .
+```
+
+## Pre-commit setup
+
+To get started follow these steps:
+
+1. Install `pre-commit` by running the following command:
+    ```
+    pip install pre-commit
+    ```
+
+2. Once `pre-commit` is installed, set up the pre-commit hooks by running:
+    ```
+    pre-commit install
+    ```
+
+3. Pre-commit hooks will analyze only committed files. To analyze all files after installation run the following:
+    ```
+    pre-commit run --all-files
+    ```
+
+
+### Automatic Fixing Before Commits:
+pre-commit will run Ruff (format + lint) and mypy during the commit process:
+
+   ```bash
+   git commit -m "Describe your changes"
+   ```
+To skip pre-commit hooks for a single commit, use the `--no-verify` flag:
+
+    ```bash
+    git commit -m "Your commit message" --no-verify
+    ```
+
+---
+
+## Technologies and Libraries
+
+### Main Dependencies:
+ - **python** >= "3.12.7"
+ - **pydantic-settings**
+ - **confluent-kafka**
+ - **fastapi**
+ - **prometheus-client**
+ - **uvicorn**
+ - **redis**
+ - **fsspec/s3fs/adlfs** (S3/ABFS backends)
+ - **boto3** and **boto3-stubs**
+
+
+### Developer Tools:
+- **uv** - Dependency and environment management
+- **pydantic** - settings management
+- **ruff** - Linting and formatting
+- **mypy** - Static type checker
+- **pytest**, **unittest** - Unit tests
+- **pre-commit** - Code quality hooks
+
+---
+
+## Commit conventions
+
+We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for our commit messages. This helps us to create a better, more readable changelog.
+
+Example of a commit message:
+```bash
+refactor(XXX-NNN): spaghetti code is now a carbonara
+```

{cledar_sdk-1.0.1.dist-info → cledar_sdk-1.2.0.dist-info}/RECORD

@@ -38,7 +38,7 @@ monitoring_service/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuF
 monitoring_service/monitoring_server.py,sha256=lBnImACViG6QE70RFTziDg8zh0FJsiza6knPI-rvsE8,3488
 monitoring_service/tests/test_monitoring_server.py,sha256=urL2seruM_peNIr7c4hblGfEDjqQUzhPCE2gXIJ_Vf8,1657
 monitoring_service/tests/integration/test_monitoring_server_int.py,sha256=5PP-nm-gZPMyShccYUU17TfRprWq2Ij6Y1YA6JnN9jE,5359
-cledar_sdk-1.0.1.dist-info/METADATA,sha256=mND5kyI_61f0IP3qfSatPMfKm_1kiiJ2KGaN7WNh9WM,3694
-cledar_sdk-1.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cledar_sdk-1.0.1.dist-info/licenses/LICENSE,sha256=Pz2eACSxkhsGfW9_iN60pgy-enjnbGTj8df8O3ebnQQ,16726
-cledar_sdk-1.0.1.dist-info/RECORD,,
+cledar_sdk-1.2.0.dist-info/METADATA,sha256=UveAiUFJICL4WhvllDT7McaYBVW2P3uZIWnBQwlmLrQ,6752
+cledar_sdk-1.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cledar_sdk-1.2.0.dist-info/licenses/LICENSE,sha256=Pz2eACSxkhsGfW9_iN60pgy-enjnbGTj8df8O3ebnQQ,16726
+cledar_sdk-1.2.0.dist-info/RECORD,,

cledar_sdk-1.0.1.dist-info/METADATA

@@ -1,142 +0,0 @@
-Metadata-Version: 2.4
-Name: cledar-sdk
-Version: 1.0.1
-Summary: Cledar Python SDK
-Author: Cledar
-License-File: LICENSE
-Requires-Python: ==3.12.7
-Requires-Dist: adlfs==2025.8.0
-Requires-Dist: boto3-stubs==1.34.138
-Requires-Dist: boto3==1.34.138
-Requires-Dist: confluent-kafka==2.4.0
-Requires-Dist: ecs-logging==2.1.0
-Requires-Dist: fastapi<0.113,>=0.112.3
-Requires-Dist: fsspec==2025.9.0
-Requires-Dist: prometheus-client<0.21,>=0.20.0
-Requires-Dist: pydantic-settings==2.3.3
-Requires-Dist: pydantic<3.0,>=2.7.0
-Requires-Dist: redis==5.2.1
-Requires-Dist: s3fs==2025.9.0
-Requires-Dist: uvicorn<0.31,>=0.30.6
-Description-Content-Type: text/markdown
-
-# Cledar Python SDK
-
-## Project Description
-
-**Cledar Python SDK** is a git submodule that contains shared services (S3, kafka service, dlq service, monitoring service) redy for use across projects. It is used by multiple workers to ensure consistency and compatibility between different components.
----
-
-## Installation and Setup
-
-1. **Clone the Repository**
-   ```bash
-   git clone git@github.com:Cledar/cledar-python-sdk.git
-   ```
-
-2. **Install Dependencies**
-   ```bash
-   uv sync
-   ```
-3. **How to use this repo in your project**
-   To use this repo in your project, you can add it as a submodule like this:
-   ```bash
-   git submodule add <submodule_url> [optional_path]
-   ```
-   Then you can import the services in your project like this:
-   ```python
-   from common_services.kafka_service.kafka_producer import KafkaProducer
-
-   ```
-   etc.
-
-## Testing
-
-Unit tests are implemented using **pytest** and **unittest**.
-
-1. Run tests:
-   ```bash
-   uv run pytest
-   ```
-
-2. Adding tests:
-   Place your tests in the *_service/tests folder or as files with the _test.py suffix in */tests folder.
-
-## Code Quality
-
-- **pydantic** - settings management
-- **ruff**, **mypy** - Linting, formatting, and static type checking
-- **pre-commit** - Pre-commit file checks
-
-## Linting 
-
-If you want to run linting or type checker manually, you can use the following commands. Pre-commit will run these checks automatically before each commit.
-```bash
-uv run ruff format .
-uv run ruff check .
-uv run mypy .
-```
-
-## Pre-commit setup
-
-To get started follow these steps:
-
-1. Install `pre-commit` by running the following command:
-    ```
-    pip install pre-commit
-    ```
-
-2. Once `pre-commit` is installed, set up the pre-commit hooks by running:
-    ```
-    pre-commit install
-    ```
-
-3. Pre-commit hooks will analyze only commited files. To analyze all files after installation run the following:
-    ```
-    pre-commit run --all-files
-    ```
-
-
-### Automatic Fixing Before Commits:
-pre-commit will run Ruff (format + lint) and mypy during the commit process:
-
-   ```bash
-   git commit -m "Describe your changes"
-   ```
-To skip pre-commit hooks for a single commit, use the `--no-verify` flag:
-
-    ```bash
-    git commit -m "Your commit message" --no-verify
-    ```
-
----
-
-## Technologies and Libraries
-
-### Main Dependencies:
- - **python** = "3.12.7"
- - **pydantic-settings** = "2.3.3"
- - **confluent-kafka** = "2.4.0"
- - **fastapi** = "^0.112.3"
- - **prometheus-client** = "^0.20.0"
- - **uvicorn** = "^0.30.6"
-
-
-### Developer Tools:
-- **uv** - Dependency and environment management
-- **pydantic** - settings management
-- **ruff** - Linting and formatting
-- **mypy** - Static type checker
-- **pytest**, **unittest** - Unit tests
-- **pre-commit** - Code quality hooks
-
----
-
-## Commit conventions
-
-We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for our commit messages. This helps us to create a better, more readable changelog.
-
-Example of a commit message:
-```bash
-refactor(XXX-NNN): spaghetti code is now a carbonara
-```