gfw-common
Common place for GFW reusable Python components.
Introduction
The following table shows a summary of the current supported features:
| Module/Package | Description |
|---|---|
| gfw.common.beam | Common utilities and wrappers for Apache Beam pipelines. |
| gfw.common.cli | Lightweight framework around argparse for building CLIs more easily. |
| gfw.common.bigquery | Common utilities and wrappers for BigQuery interactions. |
| gfw.common.datetime | Simple helper functions around stdlib datetime module. |
| gfw.common.decorators.py | Basic function decorators. |
| gfw.common.dictionaries.py | Simple helper functions for dictionary manipulation. |
| gfw.common.io.py | Basic IO functions. |
| gfw.common.iterables.py | Iterables utilities. |
| gfw.common.logging.py | Basic logging configuration. |
| gfw.common.serialization.py | Basic serialization utilities. |
For more information and API reference, check the documentation pages.
Installation
The package offers extras to avoid installing unnecessary dependencies:
beam: includes dependencies for thegfw.common.beampackage.bq: includes dependencies for BigQuery utilities.
For a default installation without extras, run:
pip install gfw-common
To install all extras, run:
pip install gfw-common[bq,beam]
Usage
You can see examples in the examples folder.
How to Contribute
Preparing the environment
First, clone the repository.
git clone https://github.com/GlobalFishingWatch/gfw-common.git
Install uv for faster installs:
./install-uv.sh
Create virtual environment and activate it:
make venv
source .venv/bin/activate
Install pre-commit hooks for local development:
make install-pre-commit
Install dependencies and package in editable mode for local development:
make install
Make sure you can run unit tests:
make test
Development Workflow
Regarding the git workflow, we follow GitHub Flow. See GITHUB-FLOW.md for a quick summary.
Try to write good commit messages. See How to Write a Git Commit Message guide for details.
The pre-commit hooks will take care of validating your code before a commit
in terms of PEP8 standards, type-checking, miss-pellings, missing documentation, etc.
If you want/need to do it manually, you have commands in the Makefile.
To see options, type make.
How to Release
Creating a tag will automatically trigger a GitHub Action (release.yaml) to publish the package to PyPI.
The tag must match the version declared in pyproject.toml; this will be validated by the action.
The tag name must follow the format vX.Y.Z.
In this context, X, Y and Z refer to MAJOR, MINOR and PATCH of Semantic Versioning.
1 maintainer
Metadata
1 maintainer
Release files for gfw-common 0.24.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| gfw_common-0.24.0.tar.gz | 112.4 kB | Without provenance | Details for gfw_common-0.24.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| gfw_common-0.24.0-py3-none-any.whl | Python 3 | none | any | Details for gfw_common-0.24.0-py3-none-any.whl |
Total release size: 200.5 kB
Release files / gfw_common-0.24.0.tar.gz
| Download URL | gfw_common-0.24.0.tar.gz |
|---|---|
| Size | 112.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a615b6fe5472426c62a317791adbbe13bed9e9a4ec766e6522ce53cf8975ec46
|
|
BLAKE2b-256 checksum How to use checksums |
968fe3eb1d94e79fe00d051833fa45fe660acb1bbbf7e7e89391202ede342fdd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / gfw_common-0.24.0-py3-none-any.whl
| Download URL | gfw_common-0.24.0-py3-none-any.whl |
|---|---|
| Size | 88.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4ce08b8d3264d8bbe6543716fe779af1ca315858826d5ca9b758de0a7b5e6813
|
|
BLAKE2b-256 checksum How to use checksums |
1b1837aae2a16b70aad837472e57afc9bca2e8984df1705a2befc7c7cd539383
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Security for gfw-common 0.24.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
