Installation¶

Prerequisites¶

Python 3.10 or newer. Check with python3 --version.
uv (recommended) or pip for installing the package.
Read access to the PADAS/earthranger-smart-utils GitHub repository.

Install from PyPI (recommended)¶

uv pip install er-smart-sync

That's it. The CLI is registered as er-smart-sync. Use er-smart-sync==X.Y.Z to pin to a specific version.

Install from a GitHub Release¶

Each tagged release also attaches a wheel to its GitHub Release page. Useful if you need an offline installer or want to pin to a specific build URL. Pick the latest release on the releases page, copy the wheel URL, and install it (replacing vX.Y.Z / X.Y.Z with the actual version):

uv pip install https://github.com/PADAS/earthranger-smart-utils/releases/download/vX.Y.Z/er_smart_sync-X.Y.Z-py3-none-any.whl

Install from source (for development)¶

Clone the repository and install in editable mode:

git clone git@github.com:PADAS/earthranger-smart-utils.git
cd earthranger-smart-utils
uv pip install -e ".[dev]"

The CLI is registered as er-smart-sync. Verify it installed:

er-smart-sync --help

You should see the list of subcommands (datamodel, choices, events, patrols, inspect-datamodel, validate-config, list-cas, config-template).

Optional extras¶

Extra	When to install	Command
`gcp`	Production runs using GCP Pub/Sub + GCS storage	`uv pip install -e ".[gcp]"`
`tracing`	OpenTelemetry tracing	`uv pip install -e ".[tracing]"`
`docs`	Local preview of this documentation site	`uv pip install -e ".[docs]"`

Combine multiple: uv pip install -e ".[dev,gcp,docs]".

Verify¶

Run the test suite to confirm the install works end-to-end:

pytest -q

You should see all tests passing.

Next¶

→ First run — confirm your credentials work and preview a sync without making any writes.