API Reference#

This pages contains the API reference of the gfw-common package.

Packages#

gfw.common.beam

Apache Beam utilities.

gfw.common.bigquery

BigQuery utilities and configuration classes.

gfw.common.cli

Lightweight framework around argparse for building CLIs more easily.

Modules#

gfw.common.collections

Utility functions for collections.

gfw.common.config

Defines the PipelineConfig class used to configure data pipeline executions.

gfw.common.datetime

Utility functions for working with datetime objects and timezones.

gfw.common.decorators

Module that contains simple function decorators.

gfw.common.dictionaries

Utility functions for dictionary and mapping operations.

gfw.common.diff

General utilities for generating diffs between objects.

gfw.common.io

Module that contains simple IO utilities.

gfw.common.iterables

Module that contains simple iterable utilities.

gfw.common.jinja2

Helpers for working with Jinja2 templates and environments.

gfw.common.logging

Logging utilities.

gfw.common.query

Utilities for repsenting SQL queries in a structured, reusable way.

gfw.common.serialization

Serialization utilities.

gfw.common.sorting

Utilities for sorting data structures.

gfw.common.strings

Small utilities for common string manipulation tasks.