commytho

Un outil en ligne de commande qui pousse des commits sur un dépôt qui vous appartient, à un rythme que vous fixez, depuis votre propre machine.

Le nom vient de commit et de mytho.

Le programme ne prétend pas faire autre chose que ce qu'il fait : ajouter une ligne dans un fichier, la commiter, la pousser. Personne n'est dupe, vous non plus.

C'est avant tout un prétexte pour manipuler des sujets utiles :

planificateurs natifs des trois systèmes, stockage de secret dans un trousseau, API GitHub, empaquetage Python, publication automatisée...

Installation

pipx install commytho

pipx installe l'outil dans son propre environnement et met la commande sur le PATH, sans polluer votre Python système. Si vous ne l'avez pas :

python -m pip install --user pipx
python -m pipx ensurepath

Il vous faut aussi git, et Python 3.10 ou plus récent.

Prise en main

commytho login     # enregistre un jeton GitHub dans le trousseau du système
commytho init      # choisit le dépôt cible, ou le crée
commytho up        # pose la tâche planifiée
commytho status    # montre où en sont les choses
commytho down      # retire la tâche planifiée

Un exemple complet, du jeton au premier commit :

commytho login
commytho init --create journal --private
commytho up --per-day 1-3 --days lun-ven --window 09:00-19:00 --max 20

Le jeton GitHub

commytho login demande un jeton d'accès personnel à portée fine, à créer sur https://github.com/settings/personal-access-tokens/new.

Permissions à cocher, dans Repository permissions :

Limitez la portée au dépôt concerné et mettez une date d'expiration. Si vous choisissez un dépôt existant, la permission Administration est inutile.

Le jeton part dans le trousseau du système : Gestionnaire d'identification sous Windows, Trousseau d'accès sous macOS, Secret Service sous Linux. Il n'apparaît ni dans la configuration, ni dans .git/config, ni dans la liste des processus. Sur une machine sans trousseau, typiquement un serveur sans session graphique, commytho se rabat sur un fichier lisible par votre seul compte et vous prévient.

Pour tout effacer : commytho logout.

Les options de commytho up

commytho plan --days 14 montre les deux prochaines semaines sans rien écrire.

Comment ça marche

Le planificateur du système réveille commytho toutes les trente minutes par défaut. Ce réveil ne commite pas forcément.

Chaque jour, commytho tire un programme, par exemple 09:47, 13:12 et 17:29. Le tirage est déterministe pour un couple dépôt et date : deux réveils du même jour retombent sur le même programme, même si le fichier d'état a disparu. Un réveil ne fait quelque chose que si un créneau est arrivé à échéance.

Les créneaux sont répartis en tranches égales dans la plage horaire, avec un tirage à l'intérieur de chaque tranche. On évite ainsi les paquets de commits à la même minute tout en gardant un rythme irrégulier.

Si la machine était éteinte et que plusieurs créneaux sont en retard, commytho n'en rattrape qu'un seul, le plus récent, et abandonne les autres. Repousser six commits d'un coup après un week-end serait exactement le contraire du but. --rattrapage 0 renverse ce choix et rejoue tout le programme manqué du jour, ce qui convient quand la machine n'est allumée qu'une partie de la journée.

Le plafond de vingt commits par jour est là pour la même raison. Vous pouvez le relever, l'outil vous dira simplement ce qu'il en pense.

Poser la tâche ne réécrit pas le passé : les créneaux du jour déjà écoulés sont comptés comme honorés. Changer de rythme à midi ne déclenche donc pas une salve rétroactive, la journée en cours part de l'heure de la pose.

Une machine éteinte plusieurs jours

Par défaut, une journée manquée est une journée perdue : au réveil suivant, commytho ne regarde que le jour courant.

--rattrapage-jours N remonte plus loin. À la réouverture de session, commytho reprend les programmes des N derniers jours et pousse tout ce qui n'a pas été fait. Chaque commit garde la date et l'heure de son créneau d'origine, pas celles du réveil : un vendredi rattrapé le lundi reste daté du vendredi.

commytho up --rattrapage 0 --rattrapage-jours 7

La remontée s'arrête à la date de pose de la tâche. Une installation toute neuve n'invente donc pas une semaine d'activité à son premier réveil.

Quand le journal s'allonge

Passé mille lignes, commytho laisse journal.md tranquille et ouvre journal-2.md, puis journal-3.md. Un fichier qui grossit sans fin finit par peser dans chaque diff et devient pénible à ouvrir sur GitHub.

Le numéro en cours se lit dans le dépôt lui-même, pas dans un fichier d'état : effacer l'état local, ou installer commytho sur une seconde machine, ne fait pas repartir la rotation en arrière. commytho status affiche le fichier réellement alimenté.

Le seuil se règle avec --max-lines, et --max-lines 0 désactive la rotation.

Le planificateur, système par système

Tout est posé sous votre compte utilisateur, sans droits administrateur, et survit au redémarrage.

Sous Linux, une minuterie utilisateur s'arrête quand vous fermez votre session. Pour qu'elle continue à tourner, activez le maintien de session :

loginctl enable-linger "$USER"

Où sont les fichiers

commytho status affiche les chemins exacts de votre machine. La copie locale du dépôt appartient à commytho : vos dépôts de travail ne sont jamais touchés.

Dépannage

Les commits n'apparaissent pas sur mon profil. GitHub ne compte une contribution que si l'adresse de l'auteur appartient au compte. commytho utilise l'adresse noreply du compte, ce qui remplit toujours cette condition. Vérifiez avec commytho status que l'auteur est bien le vôtre.

Le dépôt est privé. Activez Private contributions dans les réglages du graphe de contributions, sinon rien ne s'affiche.

Rien ne se passe. Regardez le journal, dont commytho status donne le chemin. Pour forcer un commit tout de suite et voir ce qui se passe :

commytho run --force --verbose

Le jeton a expiré. commytho login à nouveau, le jeton est remplacé.

Une fenêtre noire apparaît à chaque commit. Elle ne devrait plus. Si vous venez d'une version antérieure à la 1.1.0, la tâche posée à l'époque est restée telle quelle : relancez commytho up pour la remplacer.

Développement

git clone https://github.com/GuillaumeYves/commytho
cd commytho
python -m pip install -e ".[dev]"
python -m pytest
python -m ruff check .

Les tests ne touchent ni au réseau, ni à git, ni à la configuration réelle de la machine : tout passe par des dossiers temporaires.

Publication

Les versions partent sur PyPI depuis GitHub Actions, déclenchées par un tag. Voir CONTRIBUTING.md pour la marche à suivre.

Licence

MIT.