er-smart-sync

Synchronize SMART Connect wildlife-monitoring data with EarthRanger.

📖 Full documentation

https://padas.github.io/earthranger-smart-utils/

Includes install instructions, step-by-step workflows for every sync flow, a complete CLI reference, conceptual background, and troubleshooting.

What it does

• Datamodel sync (SMART → ER) — turn SMART data models into EarthRanger event categories and event types.
• Event sync (ER → SMART) — poll EarthRanger events and forward them via message broker.
• Patrol sync (ER → SMART) — poll EarthRanger patrols with track points and attached files.
• Event-type copy (ER → ER) — copy a single event type (and the v2 choices its schema references) from one EarthRanger site to another via the copy-event-type CLI subcommand.

Quick install

uv pip install er-smart-sync
er-smart-sync --help

Or install from source (for development):

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

See the Installation page for prerequisites, optional extras, and verification steps.

For contributors

Working on the codebase itself? Start with:

• CLAUDE.md — codebase conventions: Pydantic v1 API, SMART version-gating (<7.5.3 needs smart_observation_uuid patching), the bracketed-CA-label convention, and the protocol-based dependency-injection pattern.
• USAGE.md — developer-oriented CLI reference and the bracketed-CA-label convention as it affects the codebase.
• docs/superpowers/specs/ — design specs for non-trivial features (v2 event types, choices population, etc.).
• docs/superpowers/plans/ — implementation plans for recent feature work.

The user-facing documentation at the link above covers what er-smart-sync does and how to use it; the references in this section cover how it's built.

License

Apache License 2.0. See LICENSE.