From 8b4677a6f73bdb7c740a2e51834f860970e4f914 Mon Sep 17 00:00:00 2001 From: sylvain Date: Tue, 10 Mar 2026 19:28:25 +0100 Subject: [PATCH] docs(v1.0.0): update README and create CHANGELOG Co-Authored-By: Claude Sonnet 4.6 --- CHANGELOG.md | 19 ++++++++++++++++++ README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++-- pyproject.toml | 2 +- 3 files changed, 71 insertions(+), 3 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..bb14fe0 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,19 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/). + +## [Unreleased] + +## [1.0.0] - 2026-03-10 + +### Added + +- Client API Gitea avec authentification par token et pagination automatique +- Collecteur de données avec dataclass `RepoData` +- Affichage Rich du dashboard avec tableau repos et section milestones +- Point d'entrée CLI `gitea-dashboard` avec configuration par variables d'environnement +- Indicateurs visuels pour les repos forks, archives et miroirs +- Gestion des erreurs réseau (connexion refusée, timeout, erreurs API) +- Masquage du token dans les messages d'erreur diff --git a/README.md b/README.md index 7ff1b7a..a329f08 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # gitea-dashboard -Dashboard CLI affichant l'etat des repos Gitea : issues ouvertes, dernieres releases, milestones. +Dashboard CLI affichant en une commande l'état de tous les repos d'une instance Gitea : issues ouvertes, dernières releases et progression des milestones. + +## Prérequis + +- Python >= 3.10 +- Accès à une instance Gitea avec un token API ## Installation @@ -10,12 +15,56 @@ pip install -e . ## Configuration -Variables d'environnement requises : voir `CLAUDE.md` (section "Variables d'environnement"). +Le dashboard se configure via deux variables d'environnement : + +| Variable | Description | Défaut | +|----------|-------------|--------| +| `GITEA_URL` | URL de l'instance Gitea | `http://192.168.0.106:3000` | +| `GITEA_TOKEN` | Token API Gitea (requis) | — | + +Pour créer un token : Gitea > Settings > Applications > Generate Token. + +Exemple de configuration dans votre shell : + +```bash +export GITEA_URL=https://gitea.tsmse.fr +# Définir GITEA_TOKEN avec la valeur obtenue depuis Gitea > Settings > Applications +``` ## Usage ```bash gitea-dashboard +# ou +python -m gitea_dashboard +``` + +### Exemple de sortie + +``` + Gitea Dashboard +┏━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Repo ┃ Issues ┃ Release ┃ +┡━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━┩ +│ mon-projet │ 3 │ v1.2.0 (il y a 2j) │ +│ autre-repo │ 0 │ — │ +└─────────────────┴────────┴──────────────────────┘ + +Milestones + mon-projet / v2.0 : 3/5 (60%) +``` + +## Développement + +```bash +# Installer avec les dépendances de développement +pip install -e ".[dev]" + +# Lancer les tests +pytest + +# Vérifier le style +ruff check src/ tests/ ``` ## Licence diff --git a/pyproject.toml b/pyproject.toml index 2b3b52c..4d25c3e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "gitea-dashboard" -version = "0.0.0" +version = "1.0.0" description = "CLI dashboard for Gitea repos status" requires-python = ">=3.10" dependencies = [