gfw.common.bigquery.TableDescription

class TableDescription(repo_name, version='', title='', subtitle='', summary='To be completed.', caveats='To be completed.', relevant_params=<factory>)

Generates a structured description for BigQuery table metadata.

Methods

render

Renders the description for use in BigQuery table metadata.

Attributes

caveats	Known limitations or notes about the data.
subtitle	Subtitle or one-line summary.
summary	High-level summary of the table's purpose.
title	Title of the table or dataset.
version	Version of the project generating this table.
repo_name	GitHub repository name (used for URLs and headers).
relevant_params	Key parameters relevant to the table's content generation.

repo_name: str

GitHub repository name (used for URLs and headers).

version: str = ''

Version of the project generating this table.

title: str = ''

Title of the table or dataset.

subtitle: str = ''

Subtitle or one-line summary.

summary: str = 'To be completed.'

High-level summary of the table’s purpose.

caveats: str = 'To be completed.'

Known limitations or notes about the data.

relevant_params: dict[str, Any]

Key parameters relevant to the table’s content generation.

The keys are parameter names (strings), and the values can be any type convertible to string.

When rendered, the parameters are shown as a bullet list of key-value pairs, for example:

• param1: value1

• long_param2: value2

• x: 42

render()

Renders the description for use in BigQuery table metadata.

Returns:

A formatted string including summary, caveats, and relevant parameters.

Return type:

str