Published July 31, 2025 | Version 0.3
Software Open

Gitlab Overviewer

  • 1. ROR icon Humboldt-Universität zu Berlin

Description

GitLab Overviewer automatically gathers information from the `README.md`
files of all GitLab repositories you have access to and generates a concise
summary (e.g., as a Markdown table or for Quarto/Confluence).

  • Extracts metadata (front-matter), description, status/todo sections, and open issues
  • Presents a clear output as `Overview.md` and Quarto files suitable for a project
  • Flexible customization via YAML keys in the READMEs (e.g., `type`, `priority`, `urgency`)
  • Custom sorting & columns (CLI: `--sort`, YAML: `table_config.yaml`)
  • Configurable renderer output (Markdown, Quarto) according to specification
  • Gold-standard tests and snapshot testing for renderer outputs

This work was created as part of the NFDI consortium 4Memory (www.4memory.de). We
gratefully acknowledge the financial support of the German Research Foundation (DFG) –
project number 501609550.

Abstract (German)

Gitlab Overviewer sammelt automatisiert Informationen aus den
`README.md`-Dateien aller GitLab-Repositories, auf die du Zugriff hast, und
erstellt daraus eine übersichtliche Zusammenfassung (z.B. als Markdown-Tabelle
oder für Quarto/Confluence).

  • Extrahiert Metadaten (Frontmatter), Beschreibung, Status/Todo-Abschnitte und offene Issues
  • Übersichtliche Ausgabe als `Overview.md` und Quarto-Dateien für ein Quarto-Projekt
  • Flexible Anpassung über YAML-Keys in den READMEs (z.B. `type`, `priority`, `urgency`)
  • Individuelle Sortierung & Spalten (CLI: `--sort`, YAML: `table_config.yaml`)
  • Konfigurierbare Renderer-Ausgabe (Markdown, Quarto) gemäß Spezifikation
  • Gold-Standard-Tests und Snapshot-Testing für Renderer-Ausgaben

Diese Arbeit ist im Rahmen des NFDI-Konsortiums 4Memory entstanden
(www.4memory.de). Wir danken der Deutschen Forschungsgemeinschaft (DFG) für die
finanzielle Unterstützung – Projektnummer 501609550

Files

p_gitlab-overviewer-v0.3.zip

Files (10.0 MB)

Name Size Download all
md5:1f2f444cf76e349052a01cb641d84f6f
10.0 MB Preview Download

Additional details

Software

Repository URL
https://scm.cms.hu-berlin.de/methodenlabor/p_gitlab-overviewer
Programming language
Python
Development Status
Active