yamcps-arr 0.1.0__tar.gz

yamcps_arr-0.1.0/.github/workflows/verify_release.py

@@ -0,0 +1,71 @@
+"""Validate the exact ARR-package artifacts before uploading them to PyPI."""
+
+import argparse
+import tarfile
+import zipfile
+from email.parser import BytesParser
+from pathlib import Path
+
+
+def _wheel_metadata(path: Path) -> bytes:
+    with zipfile.ZipFile(path) as wheel:
+        names = wheel.namelist()
+        metadata_paths = [name for name in names if name.endswith(".dist-info/METADATA")]
+        if len(metadata_paths) != 1 or any(
+            not name.startswith(("yamcps_arr/", "yamcps_arr-")) for name in names
+        ):
+            raise ValueError("Wheel must contain only the ARR package")
+        return wheel.read(metadata_paths[0])
+
+
+def _source_metadata(path: Path) -> bytes:
+    with tarfile.open(path, "r:gz") as archive:
+        members = [
+            m
+            for m in archive.getmembers()
+            if m.name.count("/") == 1 and m.name.endswith("/PKG-INFO")
+        ]
+        if len(members) != 1:
+            raise ValueError("Expected one root source metadata file")
+        stream = archive.extractfile(members[0])
+        if stream is None:
+            raise ValueError("Missing source metadata")
+        with stream:
+            return stream.read()
+
+
+def verify(directory: Path, tag: str) -> None:
+    """Require exactly one yamcps-arr wheel and sdist matching a v-prefixed tag.
+
+    Args:
+        directory: Dedicated output directory for the root package build.
+        tag: GitHub release tag, such as v0.1.0.
+
+    Raises:
+        ValueError: Unexpected artifacts, distribution name or version.
+    """
+    files = sorted(directory.iterdir())
+    wheels = [p for p in files if p.name.endswith(".whl")]
+    sources = [p for p in files if p.name.endswith(".tar.gz")]
+    if len(files) != 2 or len(wheels) != 1 or len(sources) != 1:
+        raise ValueError("Expected exactly one ARR wheel and one source archive")
+    if not tag.startswith("v") or not tag[1:]:
+        raise ValueError("Release tag must have the form v<package-version>")
+    metadata = [_wheel_metadata(wheels[0]), _source_metadata(sources[0])]
+    for raw in metadata:
+        message = BytesParser().parsebytes(raw)
+        if message["Name"] != "yamcps-arr" or message["Version"] != tag[1:]:
+            raise ValueError("Only yamcps-arr matching the release tag may be published")
+
+
+def main() -> None:
+    """Validate a build directory against its release tag."""
+    parser = argparse.ArgumentParser(description=__doc__)
+    parser.add_argument("directory", type=Path)
+    parser.add_argument("--tag", required=True)
+    args = parser.parse_args()
+    verify(args.directory, args.tag)
+
+
+if __name__ == "__main__":
+    main()

yamcps_arr-0.1.0/.github/workflows/workflow.yaml

@@ -0,0 +1,65 @@
+name: Publish yamcps-arr to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pypi-${{ github.event.release.tag_name }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build ARR distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.release.tag_name }}
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.12'
+      - name: Verify release is based on main
+        run: git merge-base --is-ancestor HEAD origin/main
+      - name: Install build tools
+        run: python -m pip install build twine
+      # hatch-vcs reads the release tag from the complete Git history above.
+      # Keep the metadata check below: an inferred development version must not be published.
+      - name: Build ARR package
+        run: python -m build --outdir dist/arr .
+      - name: Validate distribution identity and release version
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: python .github/workflows/verify_release.py dist/arr --tag "$RELEASE_TAG"
+      - name: Check PyPI metadata
+        run: python -m twine check --strict dist/arr/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: yamcps-arr-distributions
+          path: dist/arr/*
+          if-no-files-found: error
+          retention-days: 7
+
+  publish:
+    name: Publish ARR distribution
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/yamcps-arr
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: yamcps-arr-distributions
+          path: dist/arr
+      - name: Publish yamcps-arr only
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/arr/

yamcps_arr-0.1.0/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

yamcps_arr-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 JoReci
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

yamcps_arr-0.1.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.5
+Name: yamcps-arr
+Version: 0.1.0
+Summary: Unified Sonarr, Radarr and Prowlarr connector for yamcps
+Project-URL: Repository, https://github.com/JoReci2/yamcps-arr
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: httpx<1,>=0.28
+Requires-Dist: yamcps>=0.1
+Provides-Extra: dev
+Requires-Dist: bandit; extra == 'dev'
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: coverage; extra == 'dev'
+Requires-Dist: editables; extra == 'dev'
+Requires-Dist: hatch-vcs<1,>=0.4; extra == 'dev'
+Requires-Dist: hatchling; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest-asyncio>=1; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: radon; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# yamcps-arr
+
+## Description
+
+Plugin unique pour Sonarr, Radarr et Prowlarr : bibliothèques, ajouts et recherches
+pour films et séries, consultation des indexeurs et recherche de releases.
+Les trois services sont configurés ensemble sous l’identifiant `arr`.
+Voir [la contribution](contributing.md) et [la migration](MIGRATION.md).
+
+## Quickstart
+
+Python ≥ 3.12, moteur yamcps compatible et instances des trois services requis.
+Depuis la racine du dépôt :
+
+```sh
+python -m pip install -e .
+yamcps connectors list
+yamcps secrets set --connector arr
+yamcps serve --connector arr
+```
+
+L’assistant demande les URL et clés API des trois services dans le terminal et
+les conserve dans le coffre chiffré. Aucun appel réseau n’est fait au démarrage.
+Lire `skill://arr-sonarr-manage/SKILL.md`, `skill://arr-radarr-manage/SKILL.md`
+ou `skill://arr-prowlarr-search/SKILL.md` depuis le client MCP. Par exemple,
+appeler `arr_sonarr_system_status` pour vérifier Sonarr après configuration.
+Pour une installation existante, suivre [MIGRATION.md](MIGRATION.md).
+Les tests utilisent des API simulées. Guides : [Sonarr](docs/sonarr.md),
+[Radarr](docs/radarr.md), [Prowlarr](docs/prowlarr.md).
+
+## Outils
+
+| Outil | Description |
+| --- | --- |
+| `arr_sonarr_system_status` | Version et état de l’instance |
+| `arr_sonarr_list_series` | Bibliothèque, filtre facultatif sur le titre |
+| `arr_sonarr_get_series` | Détails d’une série par identifiant Sonarr |
+| `arr_sonarr_list_episodes` | Épisodes d’une série, saison facultative |
+| `arr_sonarr_calendar` | Épisodes diffusés entre deux dates |
+| `arr_sonarr_queue` | File de téléchargements, avec pagination |
+| `arr_sonarr_lookup_series` | Recherche dans le catalogue par titre ou `tvdb:<id>` |
+| `arr_sonarr_quality_profiles` | Profils qualité existants |
+| `arr_sonarr_root_folders` | Dossiers racines existants |
+| `arr_sonarr_add_series` | Ajout à partir d’un identifiant TVDB, d’un profil et d’un dossier racine |
+| `arr_sonarr_search_series` | Recherche active d’épisodes pour une série existante |
+| `arr_sonarr_search_episodes` | Recherche active d’épisodes par identifiants Sonarr |
+| `arr_sonarr_command_status` | Suivi d’une recherche asynchrone par identifiant de commande |
+| `arr_radarr_system_status` | Version et état de l’instance |
+| `arr_radarr_list_movies` | Bibliothèque, filtre facultatif sur le titre |
+| `arr_radarr_get_movie` | Détails d’un film par identifiant Radarr |
+| `arr_radarr_calendar` | Sorties entre deux dates explicites |
+| `arr_radarr_queue` | File de téléchargements avec pagination |
+| `arr_radarr_lookup_movies` | Recherche de catalogue par titre ou `tmdb:<id>` |
+| `arr_radarr_quality_profiles` | Profils qualité existants |
+| `arr_radarr_root_folders` | Dossiers racines existants |
+| `arr_radarr_add_movie` | Ajout par identifiant TMDB, profil qualité et dossier racine |
+| `arr_radarr_search_movies` | Recherche active pour des identifiants Radarr existants |
+| `arr_radarr_command_status` | Suivi d’une recherche asynchrone |
+| `arr_prowlarr_system_status` | Version et informations publiques d’exécution |
+| `arr_prowlarr_list_indexers` | Métadonnées et capacités des indexeurs configurés |
+| `arr_prowlarr_get_indexer` | Métadonnées d’un indexeur par identifiant |
+| `arr_prowlarr_indexer_status` | Derniers échecs et désactivations temporaires |
+| `arr_prowlarr_categories` | Identifiants et hiérarchie des catégories |
+| `arr_prowlarr_search` | Recherche de releases, sans téléchargement |
+| `arr_prowlarr_history` | Historique paginé, filtrable par indexeurs |
+| `arr_prowlarr_health` | Sources et sévérité des contrôles de santé |
+| `arr_prowlarr_statistics` | Compteurs et temps de réponse par indexeur |
+| `arr_prowlarr_applications` | Noms et niveau de synchronisation des applications liées |
+
+Sonarr/Radarr : ajout et recherche active peuvent déclencher des téléchargements.
+Prowlarr : recherche sans envoi au téléchargement, avec consommation possible des
+quotas des fournisseurs. Consulter les guides de chaque service.
+
+## Skills
+
+| Skill | Description |
+| --- | --- |
+| [arr-sonarr-manage](src/yamcps_arr/sonarr/skills/arr-sonarr-manage/SKILL.md) | Browse Sonarr series, episodes and downloads, find and add series, and launch episode searches. |
+| [arr-radarr-manage](src/yamcps_arr/radarr/skills/arr-radarr-manage/SKILL.md) | Browse Radarr movies and downloads, find and add movies, and launch movie searches. |
+| [arr-prowlarr-search](src/yamcps_arr/prowlarr/skills/arr-prowlarr-search/SKILL.md) | Inspect Prowlarr indexers, categories, history and health, and search releases without downloading. |
+
+## Variable de configuration
+
+| Variable | Nom du champ | Description | Obligatoire | Valeur par défaut |
+| --- | --- | --- | --- | --- |
+| Aucune | — | — | — | — |
+
+## Secret
+
+| Secret | Nom du champ | Description | Obligatoire |
+| --- | --- | --- | --- |
+| `YAMCPS_ARR_SONARR_URL` | `sonarr-url` | URL de l’instance sans identifiants ni suffixe API | Oui |
+| `YAMCPS_ARR_SONARR_API_KEY` | `sonarr-api-key` | Clé API de l’instance | Oui |
+| `YAMCPS_ARR_RADARR_URL` | `radarr-url` | URL de l’instance sans identifiants ni suffixe API | Oui |
+| `YAMCPS_ARR_RADARR_API_KEY` | `radarr-api-key` | Clé API de l’instance | Oui |
+| `YAMCPS_ARR_PROWLARR_URL` | `prowlarr-url` | URL de l’instance sans identifiants ni suffixe API | Oui |
+| `YAMCPS_ARR_PROWLARR_API_KEY` | `prowlarr-api-key` | Clé API de l’instance | Oui |
+
+Les six champs sont requis par `arr` et configurés via le vault.

yamcps_arr-0.1.0/README.md

@@ -0,0 +1,99 @@
+# yamcps-arr
+
+## Description
+
+Plugin unique pour Sonarr, Radarr et Prowlarr : bibliothèques, ajouts et recherches
+pour films et séries, consultation des indexeurs et recherche de releases.
+Les trois services sont configurés ensemble sous l’identifiant `arr`.
+Voir [la contribution](contributing.md) et [la migration](MIGRATION.md).
+
+## Quickstart
+
+Python ≥ 3.12, moteur yamcps compatible et instances des trois services requis.
+Depuis la racine du dépôt :
+
+```sh
+python -m pip install -e .
+yamcps connectors list
+yamcps secrets set --connector arr
+yamcps serve --connector arr
+```
+
+L’assistant demande les URL et clés API des trois services dans le terminal et
+les conserve dans le coffre chiffré. Aucun appel réseau n’est fait au démarrage.
+Lire `skill://arr-sonarr-manage/SKILL.md`, `skill://arr-radarr-manage/SKILL.md`
+ou `skill://arr-prowlarr-search/SKILL.md` depuis le client MCP. Par exemple,
+appeler `arr_sonarr_system_status` pour vérifier Sonarr après configuration.
+Pour une installation existante, suivre [MIGRATION.md](MIGRATION.md).
+Les tests utilisent des API simulées. Guides : [Sonarr](docs/sonarr.md),
+[Radarr](docs/radarr.md), [Prowlarr](docs/prowlarr.md).
+
+## Outils
+
+| Outil | Description |
+| --- | --- |
+| `arr_sonarr_system_status` | Version et état de l’instance |
+| `arr_sonarr_list_series` | Bibliothèque, filtre facultatif sur le titre |
+| `arr_sonarr_get_series` | Détails d’une série par identifiant Sonarr |
+| `arr_sonarr_list_episodes` | Épisodes d’une série, saison facultative |
+| `arr_sonarr_calendar` | Épisodes diffusés entre deux dates |
+| `arr_sonarr_queue` | File de téléchargements, avec pagination |
+| `arr_sonarr_lookup_series` | Recherche dans le catalogue par titre ou `tvdb:<id>` |
+| `arr_sonarr_quality_profiles` | Profils qualité existants |
+| `arr_sonarr_root_folders` | Dossiers racines existants |
+| `arr_sonarr_add_series` | Ajout à partir d’un identifiant TVDB, d’un profil et d’un dossier racine |
+| `arr_sonarr_search_series` | Recherche active d’épisodes pour une série existante |
+| `arr_sonarr_search_episodes` | Recherche active d’épisodes par identifiants Sonarr |
+| `arr_sonarr_command_status` | Suivi d’une recherche asynchrone par identifiant de commande |
+| `arr_radarr_system_status` | Version et état de l’instance |
+| `arr_radarr_list_movies` | Bibliothèque, filtre facultatif sur le titre |
+| `arr_radarr_get_movie` | Détails d’un film par identifiant Radarr |
+| `arr_radarr_calendar` | Sorties entre deux dates explicites |
+| `arr_radarr_queue` | File de téléchargements avec pagination |
+| `arr_radarr_lookup_movies` | Recherche de catalogue par titre ou `tmdb:<id>` |
+| `arr_radarr_quality_profiles` | Profils qualité existants |
+| `arr_radarr_root_folders` | Dossiers racines existants |
+| `arr_radarr_add_movie` | Ajout par identifiant TMDB, profil qualité et dossier racine |
+| `arr_radarr_search_movies` | Recherche active pour des identifiants Radarr existants |
+| `arr_radarr_command_status` | Suivi d’une recherche asynchrone |
+| `arr_prowlarr_system_status` | Version et informations publiques d’exécution |
+| `arr_prowlarr_list_indexers` | Métadonnées et capacités des indexeurs configurés |
+| `arr_prowlarr_get_indexer` | Métadonnées d’un indexeur par identifiant |
+| `arr_prowlarr_indexer_status` | Derniers échecs et désactivations temporaires |
+| `arr_prowlarr_categories` | Identifiants et hiérarchie des catégories |
+| `arr_prowlarr_search` | Recherche de releases, sans téléchargement |
+| `arr_prowlarr_history` | Historique paginé, filtrable par indexeurs |
+| `arr_prowlarr_health` | Sources et sévérité des contrôles de santé |
+| `arr_prowlarr_statistics` | Compteurs et temps de réponse par indexeur |
+| `arr_prowlarr_applications` | Noms et niveau de synchronisation des applications liées |
+
+Sonarr/Radarr : ajout et recherche active peuvent déclencher des téléchargements.
+Prowlarr : recherche sans envoi au téléchargement, avec consommation possible des
+quotas des fournisseurs. Consulter les guides de chaque service.
+
+## Skills
+
+| Skill | Description |
+| --- | --- |
+| [arr-sonarr-manage](src/yamcps_arr/sonarr/skills/arr-sonarr-manage/SKILL.md) | Browse Sonarr series, episodes and downloads, find and add series, and launch episode searches. |
+| [arr-radarr-manage](src/yamcps_arr/radarr/skills/arr-radarr-manage/SKILL.md) | Browse Radarr movies and downloads, find and add movies, and launch movie searches. |
+| [arr-prowlarr-search](src/yamcps_arr/prowlarr/skills/arr-prowlarr-search/SKILL.md) | Inspect Prowlarr indexers, categories, history and health, and search releases without downloading. |
+
+## Variable de configuration
+
+| Variable | Nom du champ | Description | Obligatoire | Valeur par défaut |
+| --- | --- | --- | --- | --- |
+| Aucune | — | — | — | — |
+
+## Secret
+
+| Secret | Nom du champ | Description | Obligatoire |
+| --- | --- | --- | --- |
+| `YAMCPS_ARR_SONARR_URL` | `sonarr-url` | URL de l’instance sans identifiants ni suffixe API | Oui |
+| `YAMCPS_ARR_SONARR_API_KEY` | `sonarr-api-key` | Clé API de l’instance | Oui |
+| `YAMCPS_ARR_RADARR_URL` | `radarr-url` | URL de l’instance sans identifiants ni suffixe API | Oui |
+| `YAMCPS_ARR_RADARR_API_KEY` | `radarr-api-key` | Clé API de l’instance | Oui |
+| `YAMCPS_ARR_PROWLARR_URL` | `prowlarr-url` | URL de l’instance sans identifiants ni suffixe API | Oui |
+| `YAMCPS_ARR_PROWLARR_API_KEY` | `prowlarr-api-key` | Clé API de l’instance | Oui |
+
+Les six champs sont requis par `arr` et configurés via le vault.

yamcps_arr-0.1.0/contributing.md

@@ -0,0 +1,63 @@
+# Contribuer à yamcps-arr
+
+Python ≥ 3.12. Installer d'abord un moteur yamcps compatible depuis sa distribution,
+son wheel ou, pour travailler sur les deux dépôts, `python -m pip install -e ../yamcps`.
+Depuis la racine de ce dépôt dans un environnement activé :
+
+```sh
+python -m pip install -e '.[dev]'
+ruff format --check src tests
+ruff check src tests
+mypy src
+radon cc src -s -a
+bandit -r src
+coverage run --source=yamcps_arr -m pytest -q
+coverage report --show-missing --fail-under=81
+python -m unittest discover -s tests -p 'test_*.py'
+python -m build
+```
+
+Les sources et les tests de ce dépôt ne nécessitent pas le dépôt source du moteur.
+Le moteur est une dépendance Python installée. Sur poste hors ligne, fournir les
+wheels de toutes les dépendances, dont `hatchling` et `editables` pour le mode
+editable ; utiliser `--no-index --find-links /chemin/wheels` et construire avec
+`python -m build --no-isolation` après installation des outils.
+
+Suivre PEP 8 (100 caractères), typer les interfaces publiques, documenter en anglais
+au format Google ; guides en français. Utiliser unittest pour les nouveaux tests,
+conserver les tests existants et simuler les API. Garder stdout pour MCP stdio,
+les secrets hors des logs, et aucun appel réseau à l'import ou à l'enregistrement.
+Tester une installation wheel hors du dépôt, sans PYTHONPATH vers ses sources.
+Conserver une couverture >80 %, examiner Radon/Bandit et signaler les limites.
+Ne pas publier sur PyPI ni déclencher une release sans demande explicite.
+
+## Versions et publication
+
+La version est calculée par `hatch-vcs` depuis Git, comme dans yamcps : le tag
+`v0.1.0` produit la version `0.1.0`. Cloner avec l’historique et les tags ; hors
+d’un tag propre, le build peut porter une version de développement. Ne pas
+renseigner de version fixe dans `pyproject.toml`.
+
+Le workflow `.github/workflows/workflow.yaml` s’exécute à la publication d’une
+release GitHub. Il extrait son tag avec l’historique complet, vérifie que le commit
+appartient à `main`, construit le wheel et le sdist, puis contrôle que les deux
+métadonnées portent le nom `yamcps-arr` et exactement la version du tag sans `v`.
+Une version inférée de développement ou un artefact supplémentaire bloque l’envoi.
+Les artefacts validés sont transmis au job de publication PyPI par OIDC, dans
+l’environnement GitHub `pypi`.
+
+Avant la première publication, configurer le Trusted Publisher PyPI pour le dépôt
+`JoReci2/yamcps-arr`, le workflow `workflow.yaml` et l’environnement `pypi`, ainsi
+que les protections souhaitées de cet environnement. La création de la release
+et la publication restent des actions explicites de maintenance.
+
+Vérification locale d’un build issu d’un tag propre (dans un dossier de sortie vide) :
+
+```sh
+python -m build --outdir dist/release .
+python .github/workflows/verify_release.py dist/release --tag v0.1.0
+```
+
+Adapter le tag à la release visée. Ces commandes construisent et vérifient les
+archives sans publier. Inclure `.github/workflows` dans les contrôles Ruff, mypy,
+Radon et Bandit lors d’une modification du workflow ou de sa validation.