charmarr-lib-core 0.12.2__py3-none-any.whl

charmarr_lib/core/interfaces/_media_storage.py

@@ -0,0 +1,99 @@
+# Copyright 2025 The Charmarr Project
+# See LICENSE file for licensing details.
+
+"""Media storage interface for shared PVC and PUID/PGID coordination."""
+
+from typing import Any
+
+from ops import EventBase, EventSource, ObjectEvents
+from pydantic import BaseModel, Field
+
+from charmarr_lib.core.interfaces._base import (
+    EventObservingMixin,
+    RelationInterfaceBase,
+)
+
+
+class MediaStorageProviderData(BaseModel):
+    """Data published by charmarr-storage charm."""
+
+    pvc_name: str = Field(description="Name of the shared PVC to mount")
+    mount_path: str = Field(
+        default="/data", description="Mount path for the shared storage inside containers"
+    )
+    puid: int = Field(default=1000, description="User ID for file ownership (LinuxServer PUID)")
+    pgid: int = Field(default=1000, description="Group ID for file ownership (LinuxServer PGID)")
+
+
+class MediaStorageRequirerData(BaseModel):
+    """Data published by apps mounting storage."""
+
+    instance_name: str = Field(description="Juju application name")
+
+
+class MediaStorageChangedEvent(EventBase):
+    """Event emitted when media-storage relation state changes."""
+
+    pass
+
+
+class MediaStorageProvider(
+    RelationInterfaceBase[MediaStorageProviderData, MediaStorageRequirerData]
+):
+    """Provider side of media-storage interface (passive - no events)."""
+
+    def __init__(self, charm: Any, relation_name: str = "media-storage") -> None:
+        super().__init__(charm, relation_name)
+
+    def _get_remote_data_model(self) -> type[MediaStorageRequirerData]:
+        return MediaStorageRequirerData
+
+    def publish_data(self, data: MediaStorageProviderData) -> None:
+        """Publish provider data to all relations."""
+        self._publish_to_all_relations(data)
+
+    def clear_data(self) -> None:
+        """Clear provider data from all relations."""
+        if not self._charm.unit.is_leader():
+            return
+
+        for relation in self._charm.model.relations.get(self._relation_name, []):
+            if "config" in relation.data[self._charm.app]:
+                del relation.data[self._charm.app]["config"]
+
+    def get_connected_apps(self) -> list[str]:
+        """Get list of connected application names (for logging/metrics)."""
+        return [r.instance_name for r in self._get_all_remote_app_data()]
+
+
+class MediaStorageRequirerEvents(ObjectEvents):
+    """Events emitted by MediaStorageRequirer."""
+
+    changed = EventSource(MediaStorageChangedEvent)
+
+
+class MediaStorageRequirer(
+    EventObservingMixin, RelationInterfaceBase[MediaStorageRequirerData, MediaStorageProviderData]
+):
+    """Requirer side of media-storage interface."""
+
+    on = MediaStorageRequirerEvents()  # type: ignore[assignment]
+
+    def __init__(self, charm: Any, relation_name: str = "media-storage") -> None:
+        super().__init__(charm, relation_name)
+        self._setup_event_observation()
+
+    def _get_remote_data_model(self) -> type[MediaStorageProviderData]:
+        return MediaStorageProviderData
+
+    def publish_data(self, data: MediaStorageRequirerData) -> None:
+        """Publish requirer data to the relation."""
+        self._publish_to_single_relation(data)
+
+    def get_provider(self) -> MediaStorageProviderData | None:
+        """Get storage provider data if available."""
+        return self._get_single_provider_data()
+
+    def is_ready(self) -> bool:
+        """Check if storage is available."""
+        return self.get_provider() is not None

charmarr_lib_core-0.12.2.dist-info/METADATA

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: charmarr-lib-core
+Version: 0.12.2
+Summary: Core charm libraries for Charmarr media automation
+Author-email: Adhitya Ravi <adhityashan95@gmail.com>
+License: LGPL-3.0-or-later
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
+Requires-Dist: charmarr-lib-krm>=0.1
+Requires-Dist: httpx>=0.27
+Requires-Dist: lightkube>=0.15
+Requires-Dist: ops>=2.0
+Requires-Dist: pydantic>=2.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="../assets/charmarr-charmarr-lib.png" width="350" alt="Charmarr Lib">
+</p>
+
+<h1 align="center">charmarr-lib-core</h1>
+
+Core charm libraries for Charmarr media automation.
+
+## Features
+
+- Juju relation interfaces for media automation
+- API clients for *arr applications (Radarr, Sonarr, Prowlarr, etc.)
+- Reconcilers for managing application configuration
+- Pydantic models for type-safe data validation
+- K8s storage utilities for StatefulSet patching
+
+## Installation
+
+```bash
+pip install charmarr-lib-core
+```
+
+## Usage
+
+### Interfaces
+
+```python
+from charmarr_lib.core.interfaces import (
+    # Media Indexer (Prowlarr <-> Radarr/Sonarr/Lidarr)
+    MediaIndexerProvider,
+    MediaIndexerRequirer,
+    MediaIndexerProviderData,
+    MediaIndexerRequirerData,
+    # Download Client (qBittorrent/SABnzbd <-> Radarr/Sonarr/Lidarr)
+    DownloadClientProvider,
+    DownloadClientRequirer,
+    DownloadClientProviderData,
+    DownloadClientRequirerData,
+    # Media Storage (shared PVC <-> all apps)
+    MediaStorageProvider,
+    MediaStorageRequirer,
+    MediaStorageProviderData,
+    MediaStorageRequirerData,
+    # Media Manager (Radarr/Sonarr <-> Overseerr/Jellyseerr)
+    MediaManagerProvider,
+    MediaManagerRequirer,
+    MediaManagerProviderData,
+    MediaManagerRequirerData,
+    QualityProfile,
+)
+```
+
+### API Clients
+
+```python
+from charmarr_lib.core import (
+    # Radarr/Sonarr/Lidarr client (v3 API)
+    ArrApiClient,
+    # Prowlarr client (v1 API)
+    ProwlarrApiClient,
+    # Errors
+    ArrApiError,
+    ArrApiConnectionError,
+    ArrApiResponseError,
+)
+
+# Connect to Radarr
+with ArrApiClient("http://radarr:7878", api_key) as client:
+    profiles = client.get_quality_profiles()
+    client.add_root_folder("/movies")
+```
+
+### Reconcilers
+
+```python
+from charmarr_lib.core import (
+    reconcile_download_clients,
+    reconcile_media_manager_connections,
+    reconcile_root_folder,
+    reconcile_external_url,
+)
+
+# Sync download clients from relations to Radarr
+reconcile_download_clients(
+    api_client=arr_client,
+    desired_clients=download_client_data_from_relations,
+    category="radarr",
+    media_manager=MediaManager.RADARR,
+    get_secret=lambda sid: model.get_secret(id=sid).get_content(),
+)
+```
+
+### Storage Utilities
+
+```python
+from charmarr_lib.core import (
+    reconcile_storage_volume,
+    is_storage_mounted,
+    K8sResourceManager,
+    ReconcileResult,
+)
+
+manager = K8sResourceManager()
+result = reconcile_storage_volume(
+    manager=manager,
+    statefulset_name="radarr",
+    container_name="radarr",  # from charmcraft.yaml
+    namespace="media",
+    pvc_name="media-storage",
+    mount_path="/data",
+)
+```

charmarr_lib_core-0.12.2.dist-info/RECORD

@@ -0,0 +1,32 @@
+charmarr_lib/core/__init__.py,sha256=9iTHLea8kbXNPBOAcBkx4wQK3T3wa5LPAW0TGm9qop4,3230
+charmarr_lib/core/_variant.py,sha256=5SLyJn3fEsbG4K8iAIklwJTSkehkHzpJg-_-RpzkoMg,1356
+charmarr_lib/core/_version.py,sha256=L6cX0RHoWTs-DaGZVEELehp3559HrfGryRfTWHaRXWg,93
+charmarr_lib/core/constants.py,sha256=cn1TUDzQ79bD_olGxnxutKg-ccfhYPOVZa8P8UCdbo4,1260
+charmarr_lib/core/enums.py,sha256=EIhDNYxTH2QNHzlmyTCFysnNIdAuMPff8vIKqcXUAfk,1120
+charmarr_lib/core/_arr/__init__.py,sha256=hS7TGAbWVpyNBX51yLNVetF5-aYgkT_DmOWUPjQ7e1M,1842
+charmarr_lib/core/_arr/_arr_client.py,sha256=ZZCJccFGibRKrt1TW5Romw8GXGTsqAUy7RPhAdw2jKM,4544
+charmarr_lib/core/_arr/_base_client.py,sha256=9qEJHKhu2C_R2PR54MRLejMhOIklPm2WZ6xATxaN3Zw,9831
+charmarr_lib/core/_arr/_config_builders.py,sha256=ON3tyn9bsBhggD-NHzXrWdMYyT643x5xm8Y1in2KlKU,8418
+charmarr_lib/core/_arr/_config_xml.py,sha256=picvSBFoUgACc9A-Gi_P-G3qb5onklwsDAdIOKu08Zk,3510
+charmarr_lib/core/_arr/_protocols.py,sha256=UqnNwSJpbWx29_7K_2svLKClMaj1ccQdjyYjZUKmXZg,1625
+charmarr_lib/core/_arr/_reconcilers.py,sha256=xdoA-tuggTC-HTFM5g5yi_3OpqX6f0CNS8LdwpQbZYA,9041
+charmarr_lib/core/_arr/_recyclarr.py,sha256=Qo55BwgDjfJ3OxQMz9WP98QqY_YlK-qq6j2Di_8AEDM,4666
+charmarr_lib/core/_juju/__init__.py,sha256=c33kTuwUtmauzM9Z2RTRPFcw4d9JhMU__JQoZdjazIA,734
+charmarr_lib/core/_juju/_pebble.py,sha256=2BYTl1bvVJYH_3NIRIeI_hiNjg2TesQtDlKIgYPrfko,3422
+charmarr_lib/core/_juju/_reconciler.py,sha256=8fqmfI-y7oAI8Y9WecKq_tcWRsRW9RnNcXK5kiFkv7g,4780
+charmarr_lib/core/_juju/_secrets.py,sha256=_silLiY3l7hOh5a_QpRH0U86oBqaIFmq6QMel97U7iw,1384
+charmarr_lib/core/_k8s/__init__.py,sha256=Y_UXl8074Cxo4MdHVJRpp9-h-cp7fu32NFeXQAdK0YM,1398
+charmarr_lib/core/_k8s/_hardware.py,sha256=ZAf48vznw5_35w0LaCa24d1RaXiCrQFphIDvetDgqko,6711
+charmarr_lib/core/_k8s/_permission_check.py,sha256=fFW5RMZf1T2wANPBbcSbHqpjbwmjvyIAuetODtnz9NA,9105
+charmarr_lib/core/_k8s/_storage.py,sha256=Z4znpev2wNHG04JvmCi7ekB2kRGxvpLiZXAkYIJkhls,8786
+charmarr_lib/core/interfaces/__init__.py,sha256=tTbQTrYcUCBGVS3qspRpEpUrJwvw_U828Yz7c7D9lkY,2211
+charmarr_lib/core/interfaces/_base.py,sha256=QEOMva4qzEmnm6NivzJFYc5jgFkWwWKbkMaxSFkTLuU,4185
+charmarr_lib/core/interfaces/_download_client.py,sha256=y02oLszgSSoz86-1Oa8n-LbbFsRhSwfTmlAZqt60E10,4304
+charmarr_lib/core/interfaces/_flaresolverr.py,sha256=Jqdw6cS-vBdKcKuK3v4aGB9Ln9VNIRrwZOj-3m6B4BE,2152
+charmarr_lib/core/interfaces/_media_indexer.py,sha256=rEbVXOtdFzi4VWcJ8C7MvLHryy3JBOtbt4DpxKQM5cY,4300
+charmarr_lib/core/interfaces/_media_manager.py,sha256=BDL5gQFWkiq6zjfjgx_jF1x22rlQ5k_qpERAZrrjeLM,4073
+charmarr_lib/core/interfaces/_media_server.py,sha256=vkdVkKeDyWS-mk1KZqtKm4Pca95IP2-dM-drgtOswe8,2432
+charmarr_lib/core/interfaces/_media_storage.py,sha256=affcBNnZ6AssXt_NQDfWD9gzPtnbMYh00Pg-GuG5CzY,3451
+charmarr_lib_core-0.12.2.dist-info/METADATA,sha256=1tOcrh_tWevgvA8HMDYIkrhY2Uzak8Jd5UQ7e8zk0NM,3561
+charmarr_lib_core-0.12.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+charmarr_lib_core-0.12.2.dist-info/RECORD,,

charmarr_lib_core-0.12.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any