docs(v1.0.0): update README and create CHANGELOG
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
19
CHANGELOG.md
Normal file
19
CHANGELOG.md
Normal file
@@ -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
|
||||||
53
README.md
53
README.md
@@ -1,6 +1,11 @@
|
|||||||
# gitea-dashboard
|
# 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
|
## Installation
|
||||||
|
|
||||||
@@ -10,12 +15,56 @@ pip install -e .
|
|||||||
|
|
||||||
## Configuration
|
## 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
|
## Usage
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
gitea-dashboard
|
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
|
## Licence
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "gitea-dashboard"
|
name = "gitea-dashboard"
|
||||||
version = "0.0.0"
|
version = "1.0.0"
|
||||||
description = "CLI dashboard for Gitea repos status"
|
description = "CLI dashboard for Gitea repos status"
|
||||||
requires-python = ">=3.10"
|
requires-python = ">=3.10"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
|
|||||||
Reference in New Issue
Block a user