docs(v1.0.0): update README and create CHANGELOG

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
sylvain
2026-03-10 19:28:25 +01:00
parent 6ed666fb66
commit 8b4677a6f7
3 changed files with 71 additions and 3 deletions

View File

@@ -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