Shared libraries for Charmarr charms.
| Package | Description | PyPI |
|---|---|---|
| charmarr-lib-core | Core interfaces, API clients, reconcilers, and storage utilities |  |
| charmarr-lib-krm | Kubernetes Resource Manager with retry logic |  |
| charmarr-lib-vpn | VPN gateway interface and pod-gateway integration |  |
| charmarr-lib-testing | Integration testing utilities with Terraform and Jubilant |  |
pip install charmarr-lib-core
pip install charmarr-lib-krm
pip install charmarr-lib-vpn
pip install charmarr-lib-testingfrom charmarr_lib.core.interfaces import (
MediaIndexerProvider,
DownloadClientRequirer,
MediaStorageRequirer,
)from charmarr_lib.core import ArrApiClient, ProwlarrApiClient
with ArrApiClient("http://radarr:7878", api_key) as client:
client.add_root_folder("/movies")from charmarr_lib.core import reconcile_download_clients
reconcile_download_clients(client, desired_clients, "radarr", MediaManager.RADARR, get_secret)from charmarr_lib.krm import K8sResourceManager
manager = K8sResourceManager()
manager.patch(StatefulSet, "my-app", patch_data, "my-namespace")# Create and activate virtual environment
uv venv && source .venv/bin/activate
# Install dependencies
uv sync
# Install pre-commit hooks
pre-commit install -t pre-commit -t commit-msg
# Run all checks
tox
# Run specific checks
tox -e lint,fmt # Linting and formatting
tox -e static # Type checking
tox -e unit # Unit testscharmarr-lib/
├── core/ # charmarr-lib-core
│ └── src/charmarr_lib/core/
│ ├── interfaces/ # Juju relation interfaces
│ ├── _arr/ # API clients and reconcilers
│ └── _k8s/ # Storage utilities
├── krm/ # charmarr-lib-krm
│ └── src/charmarr_lib/krm/
│ └── _manager.py # K8sResourceManager
├── vpn/ # charmarr-lib-vpn
│ └── src/charmarr_lib/vpn/
│ ├── interfaces/ # VPN gateway interface
│ └── _k8s/ # Pod-gateway patching
└── testing/ # charmarr-lib-testing
└── src/charmarr_lib/testing/
└── _terraform.py, _juju.py
LGPL-3.0-or-later