Welcome to GitLab Overviewer’s technical documentation

About 

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 site is the technical documentation for developers of the project and not targeted directly to end-users. For the user-documentation refer to the gitlab-project.

Structure 

This Project defines its functionalities in its Specifications. Every leaf-module (….module) also links back to the respective spec it implements.

API 

API Module 

API subpackage for gitlab_overviewer.

Implements Specification: GitLab API Client §1-3, covering:

API client operations (§1)
Error handling (§3)

Provides the main API client and error models for interacting with GitLab’s REST API.

GitLabClient – Main client for GitLab API operations.
GitLabAPIError, AuthenticationError, NotFoundError, RateLimitError – Error models for robust error handling.

See also: gitlab_overviewer.api.client, gitlab_overviewer.api.errors

CLI Module 

Command-line interface for gitlab_overviewer (Typer-based).

Implements Specification: Configuration Settings Layer §1-3 for CLI argument handling and configuration.

Provides commands for running the overview pipeline, diagnostics, and other utilities. See cli.diag and cli.__main__ for argument parsing and entry points.

Models Module 

Domain models for gitlab_overviewer.

Provides data structures for groups, projects, issues, and readme extraction.

Implements Specification: Model Mapping Layer §1-5, covering:

Group – GitLab group model
Project – GitLab project model
Issue – GitLab issue model
Readme – Project readme model
ReadmeExtract – Extracted readme content
OverviewData – Aggregated overview data

See also: gitlab_overviewer.models.group, gitlab_overviewer.models.project, gitlab_overviewer.models.issue, gitlab_overviewer.models.readme, gitlab_overviewer.models.readme_extract, gitlab_overviewer.models.overview_data

Rendering Module 

Rendering subpackage for gitlab_overviewer.

Implements Specification: Markdown Overview Renderer §1-4 and Specification: Quarto Renderer (index.qmd + project sheets) §1-4, covering:

Markdown and Quarto rendering utilities
Table rendering helpers and configuration

Provides utilities for rendering tables and documents in Markdown and Quarto formats.

gitlab_overviewer.rendering.markdown – Markdown rendering utilities
gitlab_overviewer.rendering.quarto – Quarto (.qmd) rendering for advanced publishing
gitlab_overviewer.rendering.table – Table rendering helpers and configuration

See also: TableConfig, MarkdownRenderer, QuartoRenderer

Services Module 

Services subpackage for gitlab_overviewer.

Implements Specification: Data Collection Workflow §1-4, covering:

Data aggregation and business logic services for the overview pipeline

Business logic and data aggregation services for the overview pipeline.

DataCollector – Aggregates data from GitLab and prepares it for rendering
DataCollectorError – Error handling for data collection

See also: gitlab_overviewer.services.data_collector, gitlab_overviewer.services.readme_extraction, gitlab_overviewer.services.sort_utils

Utils Module 

Utility helpers for gitlab_overviewer.

Implements Specification: Configuration Settings Layer §2.7 and Specification: GitLab API Client §1, covering:

Logging utilities
Timestamp helpers
API reading helpers
Miscellaneous functions

Provides logging setup, timestamp utilities, API reading helpers, and miscellaneous functions.

gitlab_overviewer.utils.logging – Logging utilities
gitlab_overviewer.utils.timestamp – Timestamp helpers
gitlab_overviewer.utils.read_api – API reading helpers
gitlab_overviewer.utils.render_utils – Rendering utilities

See also: Logger, get_timestamp(), read_api_response()

Config Module 

Configuration management for gitlab_overviewer.

Implements Specification: Configuration Settings Layer §1-4, covering:

Settings sources and precedence (§1)
Supported settings keys (§2)
Parsing rules (§3)
Runtime behavior (§4)

Provides Pydantic-based Settings for CLI and environment configuration.

Settings – Main configuration class

See also: gitlab_overviewer.config.settings

Indices and tables 