Skip to main content

Chronométrage de compétitions d'archerie FFTL (Indoor, Flint) -- serveur + interfaces web incluses

Project description

FletchTime logo

Python Licence Tests PyPI

FletchTime

Logiciel open source de gestion du temps pour compétitions d'archerie FFTL (Indoor et Flint), pensé pour être simple à déployer sur un réseau local multi-écrans et à paramétrer sans compétences techniques.

Se lance avec une fenêtre graphique (démarrage/arrêt du serveur, liens rapides vers les pages, journal réseau) sur toutes les plateformes, y compris Pydroid 3. Ajoute --headless pour retrouver l'ancien mode terminal (aussi utilisé automatiquement si la fenêtre ne peut pas se charger, ex. customtkinter absent).

En mode terminal, fletchtime --headless --help liste toutes les options -- notamment -v/--verbose et -d/--debug (plus de détail dans le journal), et --http-port/--ws-port pour remplacer les ports configurés le temps d'un seul lancement (ex. plusieurs salles de compétition sur un même PC via un script, sans dossier séparé par salle -- voir plus bas pour l'approche par copie de dossier).

Installation

Trois façons d'obtenir et faire tourner FletchTime, selon ton matériel -- toutes lancent le même serveur complet (contrôle + affichage + tout le nécessaire), pas juste un morceau :

1. pip install fletchtime -- Android (Pydroid 3), PC, n'importe où avec Python

pip install fletchtime    # menu ☰ → Pip → chercher "fletchtime" sur Pydroid
python -m fletchtime       # ou juste : fletchtime

Les données propres à ton club (logo, bannières, images de cible, packs de sons, réglages) se créent automatiquement dans le dossier depuis lequel tu lances la commande au premier démarrage -- lance-la toujours depuis le même dossier pour retrouver tes réglages d'une fois sur l'autre.

Sans passer par PyPI (depuis un clone du dépôt) :

git clone https://github.com/MrFanghoDev/fletchtime.git && cd fletchtime
pip install websockets     # ou : pip install -e .
python run_server.py       # raccourci équivalent à `python -m fletchtime`

2. Exécutable autoporteur (Windows / Linux) -- PC dédié, sans Python

Télécharge FletchTime-<version>-windows.zip ou FletchTime-<version>-linux.tar.gz (ex. FletchTime-v0.1.1-windows.zip) depuis les Releases GitHub, décompresse, lance FletchTime.exe (Windows) ou ./FletchTime (Linux). Aucune installation de Python nécessaire. Les dossiers web/assets/... et config/ sont créés automatiquement à côté de l'exécutable au premier lancement s'ils manquent.

Pas d'exécutable macOS pour l'instant : après plusieurs tentatives de correction infructueuses sur un bug d'empaquetage reproductible (ModuleNotFoundError au lancement), retiré de la matrice de build -- voir docs/dev-guide/index.md pour le détail de l'investigation. Sur macOS, installe via pip install fletchtime (option 1 ci-dessus) en attendant.

Chaque Release inclut aussi FletchTime-<version>-docs.tar.gz : la documentation technique (Sphinx) telle qu'elle était pour ce tag précis -- contrairement à la version publiée sur GitHub Pages (toujours celle de main), utile pour consulter la doc correspondant exactement à une version installée. Décompresse et ouvre index.html.

Le wheel et le sdist (fletchtime-<version>-py3-none-any.whl, fletchtime-<version>.tar.gz) sont eux aussi joints à chaque Release -- permet d'installer le paquet directement depuis GitHub (pip install fletchtime-<version>-py3-none-any.whl) sans dépendre de PyPI.

Windows -- pare-feu : au premier lancement, Windows affiche une alerte "Le Pare-feu Windows Defender a bloqué certaines fonctionnalités de cette application" -- coche au moins Réseaux privés puis clique Autoriser l'accès. Sans ça, le serveur démarre normalement et fonctionne depuis l'appareil qui l'héberge, mais reste injoignable depuis les autres appareils (tablettes/PC de pas de tir) sur le même réseau WiFi. Si l'alerte a été fermée par erreur ou n'est jamais apparue : Paramètres Windows → Confidentialité et sécurité → Pare-feu Windows Defender → Autoriser une application via le pare-feu -- coche FletchTime.exe pour les réseaux privés.

Ports réseau utilisés : 8000 en HTTP (pages web) et 8765 en WebSocket (synchronisation temps réel) par défaut -- deux ports séparés, tous deux nécessaires, modifiables (fenêtre graphique, config/gui.toml, ou --http-port/--ws-port en ligne de commande). Si le serveur tourne dans un conteneur/VM (Docker, WSL2...), les deux doivent être redirigés vers l'hôte, pas seulement le port HTTP : sans le port WebSocket, les pages se chargent normalement mais restent bloquées sur "en attente de connexion" indéfiniment (la synchronisation temps réel ne peut jamais s'établir).

Pour construire ces exécutables toi-même : voir .github/workflows/build.yml et fletchtime.spec (PyInstaller). Un git tag v0.1.0 && git push --tags déclenche la construction et publie les deux archives automatiquement.

3. import fletchtime.engine -- pour réutiliser juste le moteur de séquencement

Le moteur (fletchtime.engine, pur Python, zéro dépendance) est aussi utilisable seul dans un autre projet, sans le serveur ni les pages web :

from fletchtime.engine import IndoorMode, IndoorConfig, MatchEngine
engine = MatchEngine(IndoorMode(IndoorConfig()))

Plusieurs salles de compétition sur un même PC

Chaque installation de FletchTime (dossier pip install, ou dossier de l'exécutable autoporteur) fait tourner une seule salle -- son propre match, sa propre urgence, sa propre config. Pour plusieurs salles en parallèle sur le même PC :

  1. Copie le dossier FletchTime une fois par salle (ex. salle-A/, salle-B/) -- ça isole automatiquement config/ (temps de tir, urgence...), les journaux, et l'instantané de récupération après plantage : chaque copie a sa propre urgence, indépendante des autres.
  2. Dans la fenêtre de chaque copie, section Ports (HTTP/WS) : donne des ports différents à chaque salle (ex. salle A garde 8000/8765 par défaut, salle B passe à 8001/8766) -- Appliquer redémarre le serveur automatiquement si besoin.
  3. Lance chaque copie séparément. Les écrans de chaque salle se connectent à l'adresse (IP + port) affichée dans la fenêtre de leur salle respective.

Windows : le pare-feu autorise généralement par chemin d'exécutable -- avec des copies de dossier séparées, prévoir de valider l'alerte une fois par copie au premier lancement.

Contribuer

Envie de proposer un correctif, une idée, ou juste signaler un bug ? Voir CONTRIBUTING.md (français/anglais) -- processus volontairement simple, flux classique fork/branche/Pull Request.

Merci aux membres du club qui ont testé l'outil et proposé des idées au fil du développement -- voir REMERCIEMENTS.md.

Qualité continue

Chaque push et pull request déclenche .github/workflows/test.yml : formatage/lint (Black + Ruff -- corrigés et recommités automatiquement sur un push direct, juste vérifiés sur une pull request) puis la suite de tests complète. Aucune dépendance externe nécessaire pour les tests, websockets compris (voir docs/dev-guide/index.md).

En local :

pip install -e ".[dev]"
black src tests demo.py run_server.py run_tests.py
ruff check --fix src tests demo.py run_server.py run_tests.py
python -m unittest discover -s tests -v

Publication (pour les mainteneurs)

Trois workflows GitHub Actions couvrent toute la chaîne, organisés par type de production plutôt que par outil : test.yml (lint + tests), docs.yml (doc Sphinx : construction, publication GitHub Pages, archivage sur Release), build.yml (paquet Python + exécutables PyInstaller).

  • TestPyPI (essai avant publication réelle) : publication automatique via .github/workflows/build.yml (job publish-testpypi) à chaque push sur main/master qui touche au code. La version est dérivée automatiquement du tag git le plus proche par setuptools_scm (voir pyproject.toml) : sur un commit qui n'est pas exactement un tag, elle inclut le nombre de commits depuis ce tag (ex. 0.1.3.dev4), donc jamais de conflit de version sur TestPyPI, sans bricolage manuel. Configuration ponctuelle sur test.pypi.org/manage/account/publishing -- compte séparé de pypi.org, à créer indépendamment sur test.pypi.org. Le champ "Workflow name" doit être build.yml.

    Pour installer une version publiée sur TestPyPI et vérifier qu'elle fonctionne avant de publier pour de vrai :

    pip install --index-url https://test.pypi.org/simple/ \
                --extra-index-url https://pypi.org/simple/ \
                fletchtime
    

    Le --extra-index-url vers le vrai PyPI est nécessaire : TestPyPI ne contient que les paquets qu'on y a explicitement publiés, pas leurs dépendances (ici, websockets) -- sans ça, l'installation échouerait en cherchant websockets sur TestPyPI où il n'existe pas.

  • PyPI (pip install fletchtime) : publication automatique via .github/workflows/build.yml (job publish-pypi, Trusted Publishing OIDC, sans jeton API) à chaque Release GitHub. Configuration ponctuelle nécessaire sur pypi.org/manage/account/publishing -- le champ "Workflow name" doit être build.yml (voir les commentaires en tête du fichier de workflow). À faire une fois que les essais sur TestPyPI sont concluants : contrairement à TestPyPI, un numéro de version publié sur PyPI ne peut plus jamais être réutilisé ni supprimé.

  • Exécutables : voir section 2 ci-dessus.

Documentation

Il y a deux documentations distinctes, pour deux publics différents :

  • Manuel utilisateur (manual.html) : pour le DOS et les bénévoles du club. Servi localement par FletchTime lui-même (ouvre "Manuel utilisateur" depuis la page d'accueil de l'application) — fonctionne sans connexion Internet, comme le reste de l'outil.

  • Documentation développeur (docs/, Sphinx + MyST) : specs, architecture, plan de développement, guide de contribution. En local :

    pip install -e ".[docs]"      # ou : pip install -r docs/requirements.txt
    sphinx-build -b html docs docs/_build/html
    

    Ouvrir ensuite docs/_build/html/index.html dans un navigateur.

    Elle est aussi publiée automatiquement sur GitHub Pages à chaque push sur main (voir .github/workflows/docs.yml). Configuration à faire une seule fois sur GitHub : Settings → Pages → Source : "GitHub Actions".

État du projet

Étapes 1 à 5 terminées (moteur de séquencement, serveur temps réel, affichage, interface de contrôle, son) — étape 6 en cours (documentation, packaging). Voir docs/roadmap.md pour le détail du plan de développement par étapes.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fletchtime-0.2.4.tar.gz (749.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fletchtime-0.2.4-py3-none-any.whl (684.3 kB view details)

Uploaded Python 3

File details

Details for the file fletchtime-0.2.4.tar.gz.

File metadata

  • Download URL: fletchtime-0.2.4.tar.gz
  • Upload date:
  • Size: 749.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for fletchtime-0.2.4.tar.gz
Algorithm Hash digest
SHA256 60160fcf8c720925dfbcda3c9250405b9d7e4792cfb82ae0294f7a4bfb2b1382
MD5 647907c4e0f586c1365b9a9b5aeeaa06
BLAKE2b-256 1a2103eddbf795658d48f931222e01baee0e18e273619a5666bccfa916e634c7

See more details on using hashes here.

Provenance

The following attestation bundles were made for fletchtime-0.2.4.tar.gz:

Publisher: build.yml on MrFanghoDev/fletchtime

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fletchtime-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: fletchtime-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 684.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for fletchtime-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 79ae8c8c71b95fd00ef53d1a18c8a7b25a0c7e14414181d6a9bfd5ed34a91536
MD5 f08f6a7a143d1143ec6d038d8c1a8559
BLAKE2b-256 024ca9de90bfee424e97d7f99d02cadf22935d2481f9552896ba3f5244764ce0

See more details on using hashes here.

Provenance

The following attestation bundles were made for fletchtime-0.2.4-py3-none-any.whl:

Publisher: build.yml on MrFanghoDev/fletchtime

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page