Index

_

__init__() (gitlab_overviewer.api.client.GitLabClient method) (gitlab_overviewer.api.GitLabClient method) (gitlab_overviewer.config.settings.Settings method) (gitlab_overviewer.rendering.markdown.MarkdownRenderer method) (gitlab_overviewer.rendering.quarto.QuartoRenderer method) (gitlab_overviewer.services.data_collector.DataCollector method) (gitlab_overviewer.services.DataCollector method) _ColorFormatter (class in gitlab_overviewer.utils.logging) _common() (in module gitlab_overviewer.cli.__main__)

_parse_boolean() (gitlab_overviewer.config.settings.Settings class method) _parse_dates() (in module gitlab_overviewer.models.mapper) _parse_retry_backoff() (gitlab_overviewer.config.settings.Settings class method) _parse_retry_count() (gitlab_overviewer.config.settings.Settings class method) _request() (gitlab_overviewer.api.client.GitLabClient method) (gitlab_overviewer.api.GitLabClient method) _robust_type_conversion() (in module gitlab_overviewer.models.mapper) _validate_gitlab_host() (gitlab_overviewer.config.settings.Settings class method) _validate_group_api_key() (gitlab_overviewer.config.settings.Settings class method) _validate_table_config_path() (gitlab_overviewer.config.settings.Settings class method)

A

api_retry_backoff (gitlab_overviewer.config.settings.Settings attribute) api_retry_count (gitlab_overviewer.config.settings.Settings attribute) AuthenticationError, [1]

authors (gitlab_overviewer.models.readme_extract.ReadmeExtract attribute) (gitlab_overviewer.models.ReadmeExtract attribute) avatar_url (gitlab_overviewer.models.Project attribute) (gitlab_overviewer.models.project.Project attribute)

C

close() (gitlab_overviewer.api.client.GitLabClient method) (gitlab_overviewer.api.GitLabClient method) coerce_id_to_str() (gitlab_overviewer.models.Group class method) (gitlab_overviewer.models.group.Group class method) collect() (gitlab_overviewer.services.data_collector.DataCollector method) (gitlab_overviewer.services.DataCollector method)

content (gitlab_overviewer.models.Readme attribute) (gitlab_overviewer.models.readme.Readme attribute) current() (gitlab_overviewer.config.settings.Settings class method) CustomEnvSettingsSource (class in gitlab_overviewer.config.settings)

D

DataCollector (class in gitlab_overviewer.services) (class in gitlab_overviewer.services.data_collector) DataCollectorError, [1] debug (gitlab_overviewer.config.settings.Settings attribute) default_branch (gitlab_overviewer.models.Project attribute) (gitlab_overviewer.models.project.Project attribute) description (gitlab_overviewer.models.Group attribute) (gitlab_overviewer.models.group.Group attribute) (gitlab_overviewer.models.Issue attribute) (gitlab_overviewer.models.issue.Issue attribute) (gitlab_overviewer.models.Project attribute) (gitlab_overviewer.models.project.Project attribute)

display() (in module gitlab_overviewer.utils.read_api) display_shared (gitlab_overviewer.config.settings.Settings attribute)

E

extra (gitlab_overviewer.models.overview_data.OverviewData attribute) (gitlab_overviewer.models.OverviewData attribute) (gitlab_overviewer.models.Readme attribute) (gitlab_overviewer.models.readme.Readme attribute)

extract_endpoints() (in module gitlab_overviewer.utils.read_api) extract_first_paragraph() (in module gitlab_overviewer.services.readme_extraction) extract_readme_data() (in module gitlab_overviewer.services.readme_extraction) extract_todo_sections() (in module gitlab_overviewer.services.readme_extraction)

F

fetch_file() (gitlab_overviewer.api.client.GitLabClient method) (gitlab_overviewer.api.GitLabClient method) format() (gitlab_overviewer.utils.logging._ColorFormatter method) format_date() (gitlab_overviewer.rendering.renderer_base.Renderer static method) format_priority_urgency() (gitlab_overviewer.rendering.renderer_base.Renderer static method) format_table_row() (gitlab_overviewer.rendering.renderer_base.Renderer static method) from_api_json() (gitlab_overviewer.models.Group class method) (gitlab_overviewer.models.group.Group class method) (gitlab_overviewer.models.Issue class method) (gitlab_overviewer.models.issue.Issue class method) (gitlab_overviewer.models.Project class method) (gitlab_overviewer.models.project.Project class method)

from_args() (gitlab_overviewer.config.settings.Settings class method) full_content (gitlab_overviewer.models.Readme attribute) (gitlab_overviewer.models.readme.Readme attribute)

G

get_avatar_html() (gitlab_overviewer.models.Project method) (gitlab_overviewer.models.project.Project method) get_date() (gitlab_overviewer.models.overview_data.OverviewData method) (gitlab_overviewer.models.OverviewData method) get_importance() (gitlab_overviewer.models.overview_data.OverviewData method) (gitlab_overviewer.models.OverviewData method) get_importance_stars() (gitlab_overviewer.models.overview_data.OverviewData method) (gitlab_overviewer.models.OverviewData method) get_issue_summary() (gitlab_overviewer.models.overview_data.OverviewData method) (gitlab_overviewer.models.OverviewData method) get_logger() (in module gitlab_overviewer.utils.logging) get_priority() (gitlab_overviewer.models.overview_data.OverviewData method) (gitlab_overviewer.models.OverviewData method) get_priority_stars() (gitlab_overviewer.models.overview_data.OverviewData method) (gitlab_overviewer.models.OverviewData method) get_repo() (gitlab_overviewer.models.overview_data.OverviewData method) (gitlab_overviewer.models.OverviewData method) get_status() (gitlab_overviewer.models.overview_data.OverviewData method) (gitlab_overviewer.models.OverviewData method) get_supervisors() (gitlab_overviewer.models.overview_data.OverviewData method) (gitlab_overviewer.models.OverviewData method) get_todos() (gitlab_overviewer.models.overview_data.OverviewData method) (gitlab_overviewer.models.OverviewData method) get_type() (gitlab_overviewer.models.overview_data.OverviewData method) (gitlab_overviewer.models.OverviewData method) get_urgency() (gitlab_overviewer.models.overview_data.OverviewData method) (gitlab_overviewer.models.OverviewData method) get_urgency_stars() (gitlab_overviewer.models.overview_data.OverviewData method) (gitlab_overviewer.models.OverviewData method) get_with_fallback() (gitlab_overviewer.rendering.renderer_base.Renderer static method) gitlab_host (gitlab_overviewer.config.settings.Settings attribute) gitlab_overviewer.api module gitlab_overviewer.api.client module gitlab_overviewer.api.errors module gitlab_overviewer.cli module gitlab_overviewer.cli.__main__ module gitlab_overviewer.cli.diag module gitlab_overviewer.config module gitlab_overviewer.config.settings module gitlab_overviewer.models module

gitlab_overviewer.models.group module gitlab_overviewer.models.issue module gitlab_overviewer.models.mapper module gitlab_overviewer.models.overview_data module gitlab_overviewer.models.project module gitlab_overviewer.models.readme module gitlab_overviewer.models.readme_extract module gitlab_overviewer.rendering module gitlab_overviewer.rendering.markdown module gitlab_overviewer.rendering.quarto module gitlab_overviewer.rendering.renderer_base module gitlab_overviewer.rendering.table module gitlab_overviewer.services module gitlab_overviewer.services.data_collector module gitlab_overviewer.services.readme_extraction module gitlab_overviewer.services.sort_utils module gitlab_overviewer.utils module gitlab_overviewer.utils.logging module gitlab_overviewer.utils.read_api module gitlab_overviewer.utils.timestamp module GitLabAPIError, [1] GitLabClient (class in gitlab_overviewer.api) (class in gitlab_overviewer.api.client) Group (class in gitlab_overviewer.models) (class in gitlab_overviewer.models.group) group (gitlab_overviewer.models.overview_data.OverviewData attribute) (gitlab_overviewer.models.OverviewData attribute) group_api_key (gitlab_overviewer.config.settings.Settings attribute) group_from_json() (in module gitlab_overviewer.models.mapper)

I

id (gitlab_overviewer.models.Group attribute) (gitlab_overviewer.models.group.Group attribute) (gitlab_overviewer.models.Issue attribute) (gitlab_overviewer.models.issue.Issue attribute) (gitlab_overviewer.models.Project attribute) (gitlab_overviewer.models.project.Project attribute) iid (gitlab_overviewer.models.Issue attribute) (gitlab_overviewer.models.issue.Issue attribute)

is_numeric_string() (gitlab_overviewer.rendering.renderer_base.Renderer static method) is_placeholder_value() (gitlab_overviewer.rendering.renderer_base.Renderer static method) is_virtual_column_sortable() (in module gitlab_overviewer.services.sort_utils) Issue (class in gitlab_overviewer.models) (class in gitlab_overviewer.models.issue) issue_from_json() (in module gitlab_overviewer.models.mapper) issues (gitlab_overviewer.models.overview_data.OverviewData attribute) (gitlab_overviewer.models.OverviewData attribute)

L

last_activity_at (gitlab_overviewer.models.Project attribute) (gitlab_overviewer.models.project.Project attribute) list_groups() (gitlab_overviewer.api.client.GitLabClient method) (gitlab_overviewer.api.GitLabClient method) list_issues() (gitlab_overviewer.api.client.GitLabClient method) (gitlab_overviewer.api.GitLabClient method)

list_projects() (gitlab_overviewer.api.client.GitLabClient method) (gitlab_overviewer.api.GitLabClient method) load_openapi_spec() (in module gitlab_overviewer.utils.read_api) log_level (gitlab_overviewer.config.settings.Settings attribute)

M

main() (in module gitlab_overviewer.cli.diag) markdown (gitlab_overviewer.cli.__main__.OutputFormat attribute) MarkdownRenderer (class in gitlab_overviewer.rendering.markdown) model_config (gitlab_overviewer.config.settings.Settings attribute) (gitlab_overviewer.models.Group attribute) (gitlab_overviewer.models.group.Group attribute) (gitlab_overviewer.models.Issue attribute) (gitlab_overviewer.models.issue.Issue attribute) (gitlab_overviewer.models.overview_data.OverviewData attribute) (gitlab_overviewer.models.OverviewData attribute) (gitlab_overviewer.models.Project attribute) (gitlab_overviewer.models.project.Project attribute) (gitlab_overviewer.models.Readme attribute) (gitlab_overviewer.models.readme.Readme attribute) (gitlab_overviewer.models.readme_extract.ReadmeExtract attribute) (gitlab_overviewer.models.ReadmeExtract attribute) model_dump() (gitlab_overviewer.models.overview_data.OverviewData method) (gitlab_overviewer.models.OverviewData method) (gitlab_overviewer.models.Project method) (gitlab_overviewer.models.project.Project method) module gitlab_overviewer.api gitlab_overviewer.api.client gitlab_overviewer.api.errors gitlab_overviewer.cli gitlab_overviewer.cli.__main__ gitlab_overviewer.cli.diag gitlab_overviewer.config gitlab_overviewer.config.settings gitlab_overviewer.models gitlab_overviewer.models.group gitlab_overviewer.models.issue gitlab_overviewer.models.mapper gitlab_overviewer.models.overview_data gitlab_overviewer.models.project gitlab_overviewer.models.readme gitlab_overviewer.models.readme_extract gitlab_overviewer.rendering gitlab_overviewer.rendering.markdown gitlab_overviewer.rendering.quarto gitlab_overviewer.rendering.renderer_base gitlab_overviewer.rendering.table gitlab_overviewer.services gitlab_overviewer.services.data_collector gitlab_overviewer.services.readme_extraction gitlab_overviewer.services.sort_utils gitlab_overviewer.utils gitlab_overviewer.utils.logging gitlab_overviewer.utils.read_api gitlab_overviewer.utils.timestamp

N

name (gitlab_overviewer.models.Group attribute) (gitlab_overviewer.models.group.Group attribute) (gitlab_overviewer.models.Project attribute) (gitlab_overviewer.models.project.Project attribute)

namespace (gitlab_overviewer.models.Project attribute) (gitlab_overviewer.models.project.Project attribute) NotFoundError, [1] now_iso() (in module gitlab_overviewer.utils.timestamp)

O

OutputFormat (class in gitlab_overviewer.cli.__main__) override() (gitlab_overviewer.config.settings.Settings method)

overview() (in module gitlab_overviewer.cli.__main__) OverviewData (class in gitlab_overviewer.models) (class in gitlab_overviewer.models.overview_data)

P

parse_comma_list() (gitlab_overviewer.rendering.renderer_base.Renderer static method) parse_iso_date() (gitlab_overviewer.rendering.renderer_base.Renderer static method) parse_readme() (in module gitlab_overviewer.services.readme_extraction) parse_sort_keys() (in module gitlab_overviewer.services.sort_utils) parse_value() (in module gitlab_overviewer.services.sort_utils) parse_virtual_column() (in module gitlab_overviewer.services.sort_utils) path (gitlab_overviewer.models.Group attribute) (gitlab_overviewer.models.group.Group attribute) (gitlab_overviewer.models.Project attribute) (gitlab_overviewer.models.project.Project attribute) (gitlab_overviewer.models.Readme attribute) (gitlab_overviewer.models.readme.Readme attribute)

path_with_namespace (gitlab_overviewer.models.Project attribute) (gitlab_overviewer.models.project.Project attribute) prepare_field_value() (gitlab_overviewer.config.settings.CustomEnvSettingsSource method) process_readme_lines() (gitlab_overviewer.rendering.renderer_base.Renderer static method) Project (class in gitlab_overviewer.models) (class in gitlab_overviewer.models.project) project (gitlab_overviewer.models.overview_data.OverviewData attribute) (gitlab_overviewer.models.OverviewData attribute) project_from_json() (in module gitlab_overviewer.models.mapper) project_id (gitlab_overviewer.models.Issue attribute) (gitlab_overviewer.models.issue.Issue attribute) (gitlab_overviewer.models.Readme attribute) (gitlab_overviewer.models.readme.Readme attribute)

Q

quarto (gitlab_overviewer.cli.__main__.OutputFormat attribute)

QuartoRenderer (class in gitlab_overviewer.rendering.quarto)

R

RateLimitError, [1] raw_frontmatter (gitlab_overviewer.models.readme_extract.ReadmeExtract attribute) (gitlab_overviewer.models.ReadmeExtract attribute) Readme (class in gitlab_overviewer.models) (class in gitlab_overviewer.models.readme) readme (gitlab_overviewer.models.overview_data.OverviewData attribute) (gitlab_overviewer.models.OverviewData attribute) readme_from_str() (in module gitlab_overviewer.models.mapper) readme_url (gitlab_overviewer.models.Project attribute) (gitlab_overviewer.models.project.Project attribute) ReadmeExtract (class in gitlab_overviewer.models) (class in gitlab_overviewer.models.readme_extract) ref (gitlab_overviewer.models.Readme attribute) (gitlab_overviewer.models.readme.Readme attribute)

render() (gitlab_overviewer.rendering.markdown.MarkdownRenderer method) (gitlab_overviewer.rendering.quarto.QuartoRenderer method) (gitlab_overviewer.rendering.renderer_base.Renderer method) render_index() (gitlab_overviewer.rendering.quarto.QuartoRenderer method) render_project_qmd() (gitlab_overviewer.rendering.quarto.QuartoRenderer method) render_project_section() (gitlab_overviewer.rendering.markdown.MarkdownRenderer method) (gitlab_overviewer.rendering.quarto.QuartoRenderer method) render_summary_table() (gitlab_overviewer.rendering.markdown.MarkdownRenderer method) render_table() (in module gitlab_overviewer.rendering.table) Renderer (class in gitlab_overviewer.rendering.renderer_base) run() (in module gitlab_overviewer.cli.__main__) run_script() (in module gitlab_overviewer.cli.diag)

S

safe_float() (gitlab_overviewer.rendering.renderer_base.Renderer static method) safe_int() (gitlab_overviewer.rendering.renderer_base.Renderer static method) safe_str() (gitlab_overviewer.rendering.renderer_base.Renderer static method) set_singleton() (gitlab_overviewer.config.settings.Settings class method) Settings (class in gitlab_overviewer.config.settings) settings_customise_sources() (gitlab_overviewer.config.settings.Settings class method) sort_overview() (in module gitlab_overviewer.services.sort_utils)

sort_row_tuple() (in module gitlab_overviewer.services.sort_utils) sort_with_fallback() (in module gitlab_overviewer.services.sort_utils) star_rating() (gitlab_overviewer.rendering.renderer_base.Renderer static method) state (gitlab_overviewer.models.Issue attribute) (gitlab_overviewer.models.issue.Issue attribute) strip_trailing_whitespace() (gitlab_overviewer.rendering.renderer_base.Renderer static method) supervisors (gitlab_overviewer.models.readme_extract.ReadmeExtract attribute) (gitlab_overviewer.models.ReadmeExtract attribute)

T

table_config (gitlab_overviewer.config.settings.Settings attribute) TableConfigurationError title (gitlab_overviewer.models.Issue attribute) (gitlab_overviewer.models.issue.Issue attribute)

todo (gitlab_overviewer.models.Readme attribute) (gitlab_overviewer.models.readme.Readme attribute) todo_keywords (gitlab_overviewer.config.settings.Settings attribute)

V

validate_datetime_fields() (gitlab_overviewer.models.Project class method) (gitlab_overviewer.models.project.Project class method) validate_group_fields() (gitlab_overviewer.models.Project class method) (gitlab_overviewer.models.project.Project class method) validate_iid() (gitlab_overviewer.models.Issue class method) (gitlab_overviewer.models.issue.Issue class method) validate_int_fields() (gitlab_overviewer.models.Issue class method) (gitlab_overviewer.models.issue.Issue class method) (gitlab_overviewer.models.Project class method) (gitlab_overviewer.models.project.Project class method)

validate_required_fields() (gitlab_overviewer.config.settings.Settings method) visibility (gitlab_overviewer.models.Group attribute) (gitlab_overviewer.models.group.Group attribute) (gitlab_overviewer.models.Project attribute) (gitlab_overviewer.models.project.Project attribute)

W

web_url (gitlab_overviewer.models.Group attribute) (gitlab_overviewer.models.group.Group attribute) (gitlab_overviewer.models.Issue attribute) (gitlab_overviewer.models.issue.Issue attribute) (gitlab_overviewer.models.Project attribute) (gitlab_overviewer.models.project.Project attribute)

write_files() (gitlab_overviewer.rendering.markdown.MarkdownRenderer method) (gitlab_overviewer.rendering.quarto.QuartoRenderer method) (gitlab_overviewer.rendering.renderer_base.Renderer method)