docs(v1.4.0): update README, freeze CHANGELOG, bump version
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
50
README.md
50
README.md
@@ -6,6 +6,7 @@ Dashboard CLI affichant en une commande l'état de tous les repos d'une instance
|
||||
|
||||
- Python >= 3.10
|
||||
- Accès à une instance Gitea avec un token API
|
||||
- Dépendances : `requests`, `rich`, `PyYAML`
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -15,7 +16,7 @@ pip install -e .
|
||||
|
||||
## Configuration
|
||||
|
||||
Le dashboard se configure via deux variables d'environnement :
|
||||
### Variables d'environnement
|
||||
|
||||
| Variable | Description | Défaut |
|
||||
|----------|-------------|--------|
|
||||
@@ -24,19 +25,36 @@ Le dashboard se configure via deux variables d'environnement :
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
### Fichier de configuration YAML
|
||||
|
||||
Le dashboard peut être configuré via un fichier YAML, évitant de répéter les variables d'environnement à chaque session. Le fichier est recherché dans l'ordre suivant :
|
||||
|
||||
1. Chemin spécifié via `--config`
|
||||
2. `~/.config/gitea-dashboard/config.yml`
|
||||
|
||||
Les variables d'environnement `${VAR}` sont résolues automatiquement dans le fichier.
|
||||
|
||||
```yaml
|
||||
url: https://gitea.tsmse.fr
|
||||
token: ${GITEA_TOKEN}
|
||||
```
|
||||
|
||||
La priorité de résolution est : options CLI > variables d'environnement > fichier de configuration > valeurs par défaut.
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
gitea-dashboard
|
||||
# ou
|
||||
python -m gitea_dashboard
|
||||
|
||||
# Avec un fichier de configuration spécifique
|
||||
gitea-dashboard --config /chemin/vers/config.yml
|
||||
```
|
||||
|
||||
### Vérification de la connexion
|
||||
@@ -87,12 +105,32 @@ gitea-dashboard --sort issues
|
||||
gitea-dashboard -s activity
|
||||
```
|
||||
|
||||
### Colonne Description
|
||||
### Colonnes configurables
|
||||
|
||||
Le tableau affiche par défaut une colonne "Description" (tronquée à 40 caractères). Pour la masquer :
|
||||
L'option `--columns` permet de choisir les colonnes affichées dans le tableau :
|
||||
|
||||
```bash
|
||||
gitea-dashboard --no-desc
|
||||
# Afficher uniquement les colonnes repo et issues
|
||||
gitea-dashboard --columns repo,issues
|
||||
|
||||
# Exclure la colonne description
|
||||
gitea-dashboard --columns -description
|
||||
|
||||
# Lister les colonnes disponibles
|
||||
gitea-dashboard --columns help
|
||||
```
|
||||
|
||||
Pour masquer la colonne description, l'option historique `--no-desc` reste disponible (équivalent à `--columns -description`).
|
||||
|
||||
### Vue milestones
|
||||
|
||||
L'option `--milestones` affiche un tableau dédié avec la progression de chaque milestone (colonnes Repo/Milestone/Open/Closed/Progress) :
|
||||
|
||||
```bash
|
||||
gitea-dashboard --milestones
|
||||
|
||||
# Export JSON des milestones
|
||||
gitea-dashboard --milestones --format json
|
||||
```
|
||||
|
||||
### Export JSON
|
||||
|
||||
Reference in New Issue
Block a user