93 lines
2.4 KiB
Markdown
93 lines
2.4 KiB
Markdown
# gitea-dashboard
|
|
|
|
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
|
|
|
|
```bash
|
|
pip install -e .
|
|
```
|
|
|
|
## Configuration
|
|
|
|
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
|
|
```
|
|
|
|
### Filtrage des repos
|
|
|
|
L'option `--repo`/`-r` filtre les repos à afficher (sous-chaîne, insensible à la casse).
|
|
L'option `--exclude`/`-x` exclut des repos de l'affichage.
|
|
Les deux options sont cumulables et répétables.
|
|
|
|
```bash
|
|
# Afficher uniquement les repos contenant "api"
|
|
gitea-dashboard --repo api
|
|
|
|
# Afficher les repos contenant "dashboard" ou "monitor"
|
|
gitea-dashboard -r dashboard -r monitor
|
|
|
|
# Exclure les repos contenant "archive" ou "test"
|
|
gitea-dashboard --exclude archive --exclude test
|
|
|
|
# Combiner inclusion et exclusion
|
|
gitea-dashboard --repo projet --exclude archive
|
|
```
|
|
|
|
### 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
|
|
|
|
Usage personnel.
|