Files
Jellyfin-Freebox/readme.md
T
stilobiqueandClaude Opus 5.5 1b2acae316
CI / Vérifications et paquet (push) Successful in 48s
CI / Release Gitea (push) Skipped
Add test suite (box rules, Python, QML against a fake Jellyfin server) and local preview jobs
- freebox-jellyfin test: box-only rules (ES5, QtQuick 2.5, qmldir, singletons),
  tooling unit tests, qmltestrunner on tests/qml against fake_server.py
- freebox-jellyfin fake-server and preview --fake-server
- package enforces the box rules; CI runs the tests
- JetBrains run configs: Local Preview, Local Preview (faux serveur), Tests

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 00:08:03 +01:00

83 lines
4.7 KiB
Markdown

![Static Badge](https://img.shields.io/badge/freebox-revolution-black)
![Static Badge](https://img.shields.io/badge/jellyfin-purple?logo=jellyfin&logoColor=white)
# Freebox Jellyfin
Cette application permet d'utiliser jellyfin sur la freebox.
L'application (QML envoyé au Player) est dans `app/` ; le reste du dépôt est l'outillage de développement.
# Configurer un environment de travail
[Documentation pour le SDK de la freebox](https://dev.freebox.fr/sdk/player.html).
Pour Windows, [voir ce billet sur Github](https://github.com/fbx/freebox-qtcreator-plugin/issues/8).
Les outils (aperçu, vérification, paquet, déploiement) sont regroupés dans le module Python `freebox_jellyfin` (`src/`), géré avec [uv](https://docs.astral.sh/uv/) :
```bash
uv sync # crée .venv (Python 3.14) et installe la commande freebox-jellyfin
uv run freebox-jellyfin # liste les commandes
```
## Aperçu sur PC (Linux)
Sans Freebox, l'application tourne avec `qmlscene` (Qt 5) et la bibliothèque [libfbxqml](https://github.com/fbx/libfbxqml) :
```bash
sudo apt install qmlscene qml-module-qtmultimedia qtdeclarative5-dev-tools qml-module-qttest
git clone https://github.com/fbx/libfbxqml.git ../libfbxqml
uv run freebox-jellyfin preview # fenêtre 1280x720
uv run freebox-jellyfin preview --fullscreen # plein écran, comme sur la box
uv run freebox-jellyfin preview --fake-server # avec le faux serveur Jellyfin (127.0.0.1, port 8096)
uv run freebox-jellyfin check # chargement en HTTP comme le Player, échoue sur tout avertissement Qt
```
## Tests
```bash
uv run freebox-jellyfin test # règles de la box, tests Python et QML
uv run freebox-jellyfin test --qml tst_session.qml # un seul fichier de tests (tests/qml/)
uv run freebox-jellyfin test Session::test_logout # une seule fonction
uv run freebox-jellyfin fake-server # faux serveur Jellyfin sur 127.0.0.1:8096
```
`test` vérifie d'abord les règles propres au Freebox Player que le PC ne signale pas (JavaScript ES5, QtQuick 2.5 au plus, `qmldir` complets, singletons), puis lance les tests QML (`tests/qml/`) contre un faux serveur Jellyfin : connexion, catalogue, lecture, Quick Connect, règles de reprise du lecteur et parcours complets à la télécommande.
`fake-server` lance ce même faux serveur pour travailler dans l'aperçu sans vrai serveur : ajouter le serveur `127.0.0.1`, port `8096`, puis se connecter avec `alice` / `secret` ou `bob` (sans mot de passe).
## Tester sur la Freebox
Activer le mode développeur du Player (menu Réglages, avec la télécommande), puis :
```bash
uv run freebox-jellyfin deploy # trouve le Player sur le réseau et lance l'app
uv run freebox-jellyfin deploy --box 192.168.0.21 # ou en donnant son adresse
uv run freebox-jellyfin deploy --server media.example.com # l'app ajoute ce serveur au démarrage
uv run freebox-jellyfin deploy --server media.example.com --user alice:motdepasse bob
```
En mode développement, la box n'enregistre aucune donnée de l'application. Pour éviter de tout ressaisir à chaque test :
- `--server <adresse>` : le serveur est ajouté automatiquement à la liste ;
- `--user <nom>[:<mot de passe>]` (répétable) : le compte apparaît sur « Qui regarde ? », même si le serveur masque ses comptes. Avec un mot de passe, la connexion se fait en un clic ; sans, l'écran de connexion s'ouvre avec le nom pré-rempli. Le mot de passe n'apparaît pas dans les logs, mais il transite en clair sur le réseau local.
La commande sert les fichiers du projet au Player et affiche les logs de l'application. Il doit rester ouvert pendant le test (Ctrl+C pour arrêter).
## Publier sur le FreeStore
```bash
uv run freebox-jellyfin package # crée dist/com.stilobique.jellyfin-<version>.tar.gz
```
Pour une nouvelle version, modifier `version` dans `app/manifest.json` **et** `clientVersion` dans `app/Core/Session.qml` (la commande refuse de créer le paquet si elles diffèrent).
La commande reproduit « Make FreeStore Package » du plugin QtCreator : elle vérifie `app/manifest.json` et la syntaxe QML/JS (`qmllint`), puis crée l'archive à téléverser sur la console [FreeFactory](http://factory.free.fr) (compte développeur requis, validation par Free avant publication).
## Intégration continue
Le workflow Gitea Actions `.gitea/workflows/ci.yml` :
- à chaque push / pull request : vérifie le manifest et la syntaxe QML/JS, charge l'application en HTTP comme le Player (`freebox-jellyfin check`) et publie le paquet en artefact ;
- sur un tag `vX.Y.Z` (égal à la version du manifest) : crée une release Gitea avec le paquet FreeStore en pièce jointe.
```bash
git tag v0.1.0 && git push origin v0.1.0
```
Le téléversement sur la console FreeFactory reste manuel.