yamcps 0.1.0__tar.gz

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

@@ -0,0 +1,63 @@
+name: Publish yamcps 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 base 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
+      - name: Build only the base package
+        run: python -m build --outdir dist/base .
+      - name: Validate distribution identity and release version
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: python scripts/verify_release.py dist/base --tag "$RELEASE_TAG"
+      - name: Check PyPI metadata
+        run: python -m twine check --strict dist/base/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: yamcps-distributions
+          path: dist/base/*
+          if-no-files-found: error
+          retention-days: 7
+
+  publish:
+    name: Publish base distribution
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/yamcps
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: yamcps-distributions
+          path: dist/base
+      - name: Publish yamcps only
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/base/

yamcps-0.1.0/.gitignore

@@ -0,0 +1,228 @@
+# 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
+
+# Local WebUI secret
+/.webui_secret_key
+
+# Local yamcps encrypted vaults and master keys
+*.yamcps-vault
+*.yamcps-key
+*.yamcps-vault.lock

yamcps-0.1.0/AGENTS.md

@@ -0,0 +1,116 @@
+# Consignes du dépôt yamcps
+
+## Projet et repères
+
+yamcps (Yet Another Model Context Protocole Server) est un serveur MCP Python ≥ 3.12 distribué avec Hatchling.
+Les connecteurs sont des packages indépendants nommés `yamcps-<nom>`.
+Lire `docs/design.md` avant de modifier l’architecture ou le contrat des plugins,
+`docs/user-manual.md` pour le comportement utilisateur et `contributing.md` pour
+le workflow détaillé de contribution.
+
+- `src/yamcps` : cœur, CLI, découverte des plugins, registre et catalogue de skills.
+- `plugins/yamcps-demo` : exemple de distribution autonome et skill embarqué.
+- `plugins/yamcps-demo-secrets` : démo du coffre interactif, token et Basic Auth sans API externe.
+- `plugins/yamcps-sonarr` : connecteur API Sonarr, sans appel réseau à l’import/configuration.
+- `plugins/yamcps-radarr` : connecteur indépendant pour les films et l’API Radarr.
+- `plugins/yamcps-prowlarr` : indexeurs et recherche en lecture seule, sans grab ni configuration.
+- `tests` : tests du cœur et intégrations MCP.
+- `pyproject.toml` : versions Python, dépendances et configuration des outils.
+
+## Règles d’implémentation
+
+- Suivre PEP 8 et utiliser Ruff pour le formatage et le lint. Respecter la
+  configuration du dépôt, notamment la longueur de ligne de 100 caractères.
+- Fonctions et variables : `snake_case` ; classes : `PascalCase` ; constantes :
+  `UPPER_CASE` ; modules : minuscules, avec underscores si nécessaire.
+- Annoter les interfaces publiques et conserver la compatibilité avec mypy strict.
+- Documenter chaque fonction et méthode publique avec une docstring au format
+  Google. Décrire arguments, retour et exceptions lorsque pertinents ; ajouter
+  des exemples quand utiles. Les docstrings du code sont en anglais ; les guides
+  du projet sont en français.
+- Utiliser Radon pour analyser la complexité et Bandit pour les contrôles de sécurité.
+  Examiner les résultats et
+  justifier toute exception ; ne pas masquer un diagnostic pour faire passer un contrôle.
+- Ne pas introduire de dépendance sans nécessité et ne pas modifier le contrat
+  public sans mettre à jour sa documentation et sa stratégie de compatibilité.
+
+## Invariants du serveur
+
+- Contrat minimal : `id: str`, `register(server: MCPServer) -> None` synchrone ;
+  handlers synchrones ou asynchrones. `skill_roots()` et
+  `configure(secrets: ConnectorSecrets)` sont facultatifs. Les connecteurs qui
+  utilisent l’assistant déclarent `required_secrets() -> Iterable[SecretSpec]`.
+- Sans `--connector`, charger tous les plugins installés par ordre alphabétique.
+  Répéter `--connector` pour sélectionner plusieurs plugins.
+- Découvrir via `yamcps.connectors` sans importer les plugins non sélectionnés.
+  Une factory n’a pas d’argument ; son entry point et son identifiant correspondent.
+- Convention : `yamcps-github` / `yamcps_github` / `github`, outils et prompts préfixés
+  `github_`. Signaler explicitement doublons et erreurs de plugin.
+- Préserver stdout pour le protocole stdio ; envoyer les logs sur stderr.
+- Garder HTTP sur loopback par défaut. L’accès distant et l’authentification
+  nécessitent un changement de périmètre explicite.
+- Les skills sont des fichiers servis, pas des scripts à exécuter. Préserver
+  l’indexation au démarrage, les empreintes, le refus des symlinks et des lectures
+  hors racine. Inclure les fichiers des skills dans les distributions.
+- Demander uniquement les secrets manquants au démarrage interactif. Sans terminal,
+  échouer avec une commande de configuration, sans lire le flux MCP. Conserver
+  les chemins par défaut et la commande `yamcps secrets set --connector <nom>`.
+- Préserver le coffre AES-256-GCM, sa clé aléatoire séparée et les saisies masquées.
+  Ne jamais exposer les secrets dans les outils MCP, arguments CLI ou logs.
+  Ne pas présenter yamcps comme un produit qualifié ou certifié ANSSI.
+- Les plugins sont du code de confiance ; ne pas ajouter d’appels réseau à l’import.
+  Ne jamais afficher ou committer de secrets.
+
+## Tests
+
+- Écrire des tests pour toute nouvelle fonctionnalité et des tests de régression
+  pour les corrections.
+- Utiliser `unittest.TestCase` et `unittest.IsolatedAsyncioTestCase` pour les nouveaux
+  tests, avec des fichiers `test_*.py` exécutables par le runner standard.
+- La suite historique utilise pytest/pytest-asyncio : la conserver et l’exécuter
+  pendant la transition. Ne pas prétendre que `unittest discover` couvre ses
+  fonctions pytest. Ne pas convertir toute la suite sans demande liée à ce travail.
+- Maintenir une couverture de lignes strictement supérieure à 80 % pour `yamcps`,
+  `yamcps_demo`, `yamcps_demo_secrets`, `yamcps_sonarr`, `yamcps_radarr` et `yamcps_prowlarr` ; contrôler avec Coverage et `--fail-under=81`.
+- Pour les changements de protocole, plugins ou packaging, vérifier les intégrations
+  pertinentes : mémoire, stdio, HTTP local et installation du wheel hors du dépôt.
+
+## Commandes de validation
+
+Après installation selon `contributing.md` :
+
+```sh
+ruff format --check src plugins scripts tests
+ruff check src plugins scripts tests
+mypy src plugins/*/src scripts
+radon cc src plugins/*/src scripts -s -a
+bandit -r src plugins/*/src scripts
+coverage run --source=yamcps,yamcps_demo,yamcps_demo_secrets,yamcps_sonarr,yamcps_radarr,yamcps_prowlarr -m pytest -q
+coverage report --show-missing --fail-under=81
+python -m unittest discover -s tests -p 'test_*.py'
+python -m build
+python -m build plugins/yamcps-demo --outdir plugins/yamcps-demo/dist
+python -m build plugins/yamcps-demo-secrets --outdir plugins/yamcps-demo-secrets/dist
+python -m build plugins/yamcps-sonarr --outdir plugins/yamcps-sonarr/dist
+python -m build plugins/yamcps-radarr --outdir plugins/yamcps-radarr/dist
+python -m build plugins/yamcps-prowlarr --outdir plugins/yamcps-prowlarr/dist
+```
+
+Adapter les vérifications au changement ; une modification documentaire seule
+requiert surtout la validation des liens et des exemples. Signaler les contrôles
+non exécutés, leurs raisons et les échecs restants. Radon, Bandit et
+Coverage sont des exigences de validation locale et doivent être installés
+séparément de l’extra `dev`. Le workflow `.github/workflows/workflow.yaml` publie uniquement le package de base
+`yamcps` à la publication d’une release. Exécuter les contrôles de développement
+en local ; ne pas ajouter de publication automatique des plugins.
+
+## Documentation et livraison
+
+Garder le README bref : description, fonctionnalités, démarrage et liens.
+Mettre les détails d’utilisation dans `docs/user-manual.md`, l’architecture et les
+contrats dans `docs/design.md`, les règles de contribution dans `contributing.md`.
+Mettre à jour les documents concernés lorsqu’un comportement change.
+
+Avant livraison, relire le diff et résumer les changements, vérifications et
+limites. Ne pas publier sur PyPI sans instruction explicite. Le nom `yamcps` est réservé pour le projet. Ne jamais déclencher de release
+ou publier une version sans instruction explicite.

yamcps-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-0.1.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.5
+Name: yamcps
+Version: 0.1.0
+Summary: Yet Another Model Context Protocole Server: a plugin-based MCP server with skills
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: cryptography<51,>=46
+Requires-Dist: mcp<3,>=2.3
+Requires-Dist: pydantic<3,>=2
+Requires-Dist: pyyaml<7,>=6
+Provides-Extra: dev
+Requires-Dist: build; 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: ruff; extra == 'dev'
+Requires-Dist: types-pyyaml; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# yamcps — Yet Another Model Context Protocole Server
+
+**yamcps** est un serveur MCP Python extensible qui expose les fonctionnalités de
+connecteurs à des assistants compatibles avec le Model Context Protocol.
+Python 3.12 ou supérieur est requis.
+
+## Fonctionnalités
+
+- Connecteurs indépendants distribuables sur PyPI sous le nom `yamcps-<nom>`.
+- Chargement de tous les plugins installés par défaut, ou sélection avec `--connector`.
+- Outils, ressources et prompts MCP fournis par les connecteurs.
+- Plugins `yamcps-sonarr` et `yamcps-radarr` : bibliothèques de séries/films, calendriers,
+  téléchargements, recherche et ajout.
+- Plugin `yamcps-prowlarr` : indexeurs, recherche de releases et diagnostics en lecture seule.
+- Skills `SKILL.md` et fichiers associés consultables via MCP.
+- Coffre local chiffré et configuration interactive des secrets requis par les connecteurs.
+- Transports stdio et Streamable HTTP local.
+- Plugins `yamcps-demo` et `yamcps-demo-secrets` pour tester les outils et la configuration des secrets.
+
+## Démarrage depuis le dépôt
+
+```sh
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -e . -e plugins/yamcps-demo
+yamcps connectors list
+yamcps serve --connector demo
+```
+
+Pour charger tous les plugins installés : `yamcps serve`. Pour en sélectionner plusieurs :
+`yamcps serve --connector demo --connector demo-secrets`.
+
+Pour HTTP : `yamcps serve --connector demo --transport http --port 8000`.
+Le serveur écoute sur `http://127.0.0.1:8000/mcp`.
+
+## Documentation
+
+- [Manuel utilisateur](docs/user-manual.md) : installation, clients et utilisation.
+- [Architecture](docs/design.md) : contrats des connecteurs et gestion des skills.
+- [Contribution](contributing.md) : conventions, tests et contrôles qualité.
+- [Consignes pour les agents](AGENTS.md) : règles de travail dans le dépôt.
+
+Le nom PyPI `yamcps` est réservé pour ce projet. Seule la distribution de base
+est publiée par le [workflow de release](.github/workflows/workflow.yaml).
+Les plugins restent installables depuis le dépôt. Voir le guide de contribution
+pour configurer Trusted Publishing et publier une version.

yamcps-0.1.0/README.md

@@ -0,0 +1,46 @@
+# yamcps — Yet Another Model Context Protocole Server
+
+**yamcps** est un serveur MCP Python extensible qui expose les fonctionnalités de
+connecteurs à des assistants compatibles avec le Model Context Protocol.
+Python 3.12 ou supérieur est requis.
+
+## Fonctionnalités
+
+- Connecteurs indépendants distribuables sur PyPI sous le nom `yamcps-<nom>`.
+- Chargement de tous les plugins installés par défaut, ou sélection avec `--connector`.
+- Outils, ressources et prompts MCP fournis par les connecteurs.
+- Plugins `yamcps-sonarr` et `yamcps-radarr` : bibliothèques de séries/films, calendriers,
+  téléchargements, recherche et ajout.
+- Plugin `yamcps-prowlarr` : indexeurs, recherche de releases et diagnostics en lecture seule.
+- Skills `SKILL.md` et fichiers associés consultables via MCP.
+- Coffre local chiffré et configuration interactive des secrets requis par les connecteurs.
+- Transports stdio et Streamable HTTP local.
+- Plugins `yamcps-demo` et `yamcps-demo-secrets` pour tester les outils et la configuration des secrets.
+
+## Démarrage depuis le dépôt
+
+```sh
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -e . -e plugins/yamcps-demo
+yamcps connectors list
+yamcps serve --connector demo
+```
+
+Pour charger tous les plugins installés : `yamcps serve`. Pour en sélectionner plusieurs :
+`yamcps serve --connector demo --connector demo-secrets`.
+
+Pour HTTP : `yamcps serve --connector demo --transport http --port 8000`.
+Le serveur écoute sur `http://127.0.0.1:8000/mcp`.
+
+## Documentation
+
+- [Manuel utilisateur](docs/user-manual.md) : installation, clients et utilisation.
+- [Architecture](docs/design.md) : contrats des connecteurs et gestion des skills.
+- [Contribution](contributing.md) : conventions, tests et contrôles qualité.
+- [Consignes pour les agents](AGENTS.md) : règles de travail dans le dépôt.
+
+Le nom PyPI `yamcps` est réservé pour ce projet. Seule la distribution de base
+est publiée par le [workflow de release](.github/workflows/workflow.yaml).
+Les plugins restent installables depuis le dépôt. Voir le guide de contribution
+pour configurer Trusted Publishing et publier une version.