GFW Common User Guide#

The Global Fishing Watch (GFW) common package provides reusable utilities, abstractions, and helpers for data processing, validation, and orchestration across GFW pipelines and projects.

Installation#

You can install the gfw-common package directly from PyPI:

pip install gfw-common

Once installed, you can import it in your Python code:

from gfw.common.version import __version__

# Example: check the package version
print(__version__)

Subpackages and User Guides#

GFW Common more complex functionality is organized into subpackages. These are summarized in the following table, with their user guide linked in the Description and User Guide column (if available):

Subpackage	Description and User Guide
`beam`	Apache Beam (gfw.common.beam)
`bigquery`	BigQuery utilities.
`cli`	CLI framework.

Modules#

Simpler and miscleneous functionality is organized into modules of the main package. Go directly to the API Reference to check available modules.