er-smart-sync 0.2.0__tar.gz

er_smart_sync-0.2.0/.github/workflows/docs.yml

@@ -0,0 +1,53 @@
+name: docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - docs/**
+      - mkdocs.yml
+      - pyproject.toml
+      - .github/workflows/docs.yml
+  # Allow manual triggers from the Actions UI.
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+# Serialize deploys so two pushes to main in quick succession don't race
+# on gh-deploy --force and clobber each other (or fail mid-push to gh-pages).
+concurrency:
+  group: docs-deploy
+  cancel-in-progress: false
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          # gh-deploy needs full history to commit to gh-pages.
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install docs dependencies
+        # Use the [docs] extras declared in pyproject.toml so CI and local
+        # installs stay in sync.
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[docs]"
+
+      # --strict catches broken internal links, missing nav targets, and
+      # missing image files. The screenshot placeholders under docs/images/
+      # ship as 1×1 transparent PNGs so --strict passes; replace them with
+      # real screenshots when ready (docs/images/README.md tracks the slots).
+      - name: Build site
+        run: mkdocs build --strict
+
+      - name: Deploy to gh-pages
+        run: mkdocs gh-deploy --force

er_smart_sync-0.2.0/.github/workflows/release.yml

@@ -0,0 +1,87 @@
+name: release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+# `id-token: write` is required for PyPI Trusted Publishing (OIDC).
+# `contents: write` is required for the GitHub Release upload step.
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  build-and-release:
+    runs-on: ubuntu-latest
+    # Pin to a named environment so the PyPI Trusted Publisher config
+    # can be scoped to `pypi` and PRs from forks cannot trigger a
+    # release.
+    environment:
+      name: pypi
+      url: https://pypi.org/p/er-smart-sync
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          # setuptools-scm derives the version from `git describe`, so it
+          # needs the tag history. fetch-depth: 0 grabs the full history.
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install package + build + test tooling
+        # Install the package with the [dev] extras so we can run the test
+        # suite as a gate before the release is published.
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+          pip install build
+
+      - name: Run tests
+        # Gate the release on the test suite: a tagged commit must pass
+        # tests before its wheel is uploaded to a GitHub Release. Without
+        # this gate, a broken tag would still ship artifacts.
+        run: pytest -q
+
+      - name: Build wheel and sdist
+        run: python -m build
+
+      - name: Show built artifacts
+        run: ls -la dist/
+
+      - name: Verify version matches tag
+        # Sanity check: the wheel's version (derived by setuptools-scm) must
+        # match the pushed tag's version. If git describe ever drifts from
+        # the tag (dirty tree, missing tag in shallow clone), fail loudly
+        # instead of shipping a mislabelled wheel.
+        run: |
+          tag_version="${GITHUB_REF_NAME#v}"
+          wheel_version=$(ls dist/*.whl | sed -E 's/.*er_smart_sync-([^-]+)-.*/\1/' | head -1)
+          if [ "$tag_version" != "$wheel_version" ]; then
+            echo "::error::Tag ($tag_version) and wheel ($wheel_version) versions differ"
+            exit 1
+          fi
+          echo "Tag and wheel both at $wheel_version"
+
+      - name: Publish to PyPI
+        # Trusted Publisher (OIDC) — no API token. Requires a one-time
+        # config on pypi.org: pypi.org/manage/account/publishing/ →
+        # add a trusted publisher for `er-smart-sync` pointing at this
+        # repo, workflow `release.yml`, environment `pypi`.
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Create GitHub Release
+        # Also attach the artifacts to a GitHub Release. Keeps the
+        # existing "install from a release wheel URL" path working
+        # alongside `pip install er-smart-sync`.
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create "$GITHUB_REF_NAME" \
+            --title "$GITHUB_REF_NAME" \
+            --generate-notes \
+            dist/*

er_smart_sync-0.2.0/.gitignore

@@ -0,0 +1,31 @@
+# Virtualenvs
+.venv/
+venv/
+env/
+
+# Python bytecode and packaging
+__pycache__/
+*.py[cod]
+*.egg-info/
+*.egg
+build/
+dist/
+
+# setuptools-scm generated version file
+src/er_smart_sync/_version.py
+
+# Tooling caches
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.ty_cache/
+
+# OS / editor
+.DS_Store
+*.swp
+
+# Local secrets / state
+.env
+state.json
+/tmp/
+site/

er_smart_sync-0.2.0/.python-version

@@ -0,0 +1 @@
+3.10

er_smart_sync-0.2.0/.vscode/launch.json

@@ -0,0 +1,55 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "sync junglekeepers-peru.pamdas.org",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/.venv/bin/er-smart-sync",
+            "args": [
+                "datamodel",
+                "--smart-language",
+                "es",
+                "--er-token",
+                "98ILsqkxMA0R9MSK7Kl6nZLBQ9SKAI",
+                "--er-endpoint",
+                "https://junglekeepers-peru.pamdas.org",
+                "--smart-ca-uuid",
+                "SMART-IMPORT",
+                "--from-file",
+                "/Users/chrisdo/junglekeepers-peru.datamodel.xml",
+                "--ca-label",
+                "[SMART]",
+                "--cm-from-file",
+                "/Users/chrisdo/junglekeepers-peru.cm.xml"
+            ],
+            "console": "integratedTerminal"
+        },
+        {
+            "name": "sync ujugkulan-np.pamdas.org",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/.venv/bin/er-smart-sync",
+            "args": [
+                "datamodel",
+                "--smart-language",
+                "in",
+                "--er-token",
+                "df7cddebb00c8e509ba820022b6c730d3c3414c6",
+                "--er-endpoint",
+                "https://ujungkulon-np.pamdas.org",
+                "--smart-ca-uuid",
+                "SMART-IMPORT",
+                "--from-file",
+                "/Users/chrisdo/uknp-datamodel.xml",
+                "--ca-label",
+                "SMART-IMPORT"
+            ],
+            "console": "integratedTerminal"
+        }
+
+    ]
+}

er_smart_sync-0.2.0/.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+  "python.analysis.extraPaths": ["src"],
+  "python.testing.pytestEnabled": true,
+  "python.testing.pytestArgs": ["tests"],
+  "[python]": {
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll.ruff": "explicit",
+      "source.organizeImports.ruff": "explicit"
+    }
+  },
+  "ruff.configuration": "pyproject.toml",
+  "ty.configurationFile": "pyproject.toml",
+  "python.venvPath": ".venv/bin/python"
+}

er_smart_sync-0.2.0/AGENTS.md

@@ -0,0 +1,62 @@
+# AGENTS.md
+
+This file provides guidance to Codex (Codex.ai/code) when working with code in this repository.
+
+## What This Project Does
+
+er-smart-sync synchronizes data between **SMART Connect** (wildlife conservation monitoring) and **EarthRanger** (real-time data visualization for protected areas). It supports three sync flows:
+
+1. **Datamodel sync** (SMART → ER): Push event categories and event types from SMART conservation areas to EarthRanger
+2. **Event sync** (ER → SMART): Poll EarthRanger events and publish them via message broker (Pub/Sub) for routing to SMART
+3. **Patrol sync** (ER → SMART): Poll EarthRanger patrols (with track points, segment events, files) and publish them
+
+## Commands
+
+```bash
+# Install (editable, with dev dependencies)
+uv pip install -e ".[dev]"
+
+# Run all tests
+pytest
+
+# Run a single test
+pytest tests/test_synchronizer.py::test_synchronize_er_events
+
+# Lint
+ruff check src tests
+
+# Format
+ruff format src tests
+
+# Type check
+ty check
+```
+
+## Architecture
+
+The codebase uses a **protocol-based dependency injection** pattern. `ERSmartSynchronizer` is the core class that accepts pluggable implementations of four protocols (`protocols.py`):
+
+- `MessagePublisher` — publishes events/patrols to a message broker (e.g. Google Pub/Sub)
+- `FileStorage` — stores downloaded attachment files (e.g. Google Cloud Storage)
+- `StateStore` — persists last-poll timestamps for incremental sync
+- `TracingProvider` — distributed tracing spans
+
+Default (null/local) implementations live in `defaults.py` and are used by the CLI. Production implementations (GCP Pub/Sub, GCS, etc.) are injected when running in the Gundi platform.
+
+### Key External Dependencies
+
+- **dasclient** (`DasClient`) — EarthRanger REST API client
+- **smartconnect** (`SmartClient`) — SMART Connect API client; also provides `er_sync_utils` for building ER event types from SMART data models
+- **gundi-core** — shared Pydantic schemas (`EREvent`, `ERPatrol`, `ERObservation`, `ERSubject`)
+
+All three are pinned to specific wheel releases or minimum versions. Uses Pydantic v1 (`<2.0`).
+
+### CLI
+
+The Click CLI (`cli.py`) has three subcommands: `datamodel`, `events`, `patrols`. Each accepts either a `--config` YAML file or individual `--smart-*` / `--er-*` flags.
+
+## Key Conventions
+
+- Pydantic v1 API (`parse_obj_as`, `.json()`, `.dict()`) — do not use v2 patterns
+- SMART versions below 7.5.3 require patching events with `smart_observation_uuid`; this is version-gated
+- Conservation area labels are expected to contain a bracketed identifier like `"Name [CODE]"` — the `[CODE]` is extracted and used as the event category value

er_smart_sync-0.2.0/CLAUDE.md

@@ -0,0 +1,62 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## What This Project Does
+
+er-smart-sync synchronizes data between **SMART Connect** (wildlife conservation monitoring) and **EarthRanger** (real-time data visualization for protected areas). It supports three sync flows:
+
+1. **Datamodel sync** (SMART → ER): Push event categories and event types from SMART conservation areas to EarthRanger
+2. **Event sync** (ER → SMART): Poll EarthRanger events and publish them via message broker (Pub/Sub) for routing to SMART
+3. **Patrol sync** (ER → SMART): Poll EarthRanger patrols (with track points, segment events, files) and publish them
+
+## Commands
+
+```bash
+# Install (editable, with dev dependencies)
+uv pip install -e ".[dev]"
+
+# Run all tests
+pytest
+
+# Run a single test
+pytest tests/test_synchronizer.py::test_synchronize_er_events
+
+# Lint
+ruff check src tests
+
+# Format
+ruff format src tests
+
+# Type check
+ty check
+```
+
+## Architecture
+
+The codebase uses a **protocol-based dependency injection** pattern. `ERSmartSynchronizer` is the core class that accepts pluggable implementations of four protocols (`protocols.py`):
+
+- `MessagePublisher` — publishes events/patrols to a message broker (e.g. Google Pub/Sub)
+- `FileStorage` — stores downloaded attachment files (e.g. Google Cloud Storage)
+- `StateStore` — persists last-poll timestamps for incremental sync
+- `TracingProvider` — distributed tracing spans
+
+Default (null/local) implementations live in `defaults.py` and are used by the CLI. Production implementations (GCP Pub/Sub, GCS, etc.) are injected when running in the Gundi platform.
+
+### Key External Dependencies
+
+- **dasclient** (`DasClient`) — EarthRanger REST API client
+- **smartconnect** (`SmartClient`) — SMART Connect API client; also provides `er_sync_utils` for building ER event types from SMART data models
+- **gundi-core** — shared Pydantic schemas (`EREvent`, `ERPatrol`, `ERObservation`, `ERSubject`)
+
+All three are pinned to specific wheel releases or minimum versions. Uses Pydantic v1 (`<2.0`).
+
+### CLI
+
+The Click CLI (`cli.py`) has three subcommands: `datamodel`, `events`, `patrols`. Each accepts either a `--config` YAML file or individual `--smart-*` / `--er-*` flags.
+
+## Key Conventions
+
+- Pydantic v1 API (`parse_obj_as`, `.json()`, `.dict()`) — do not use v2 patterns
+- SMART versions below 7.5.3 require patching events with `smart_observation_uuid`; this is version-gated
+- Conservation area labels are expected to contain a bracketed identifier like `"Name [CODE]"` — the `[CODE]` is extracted and used as the event category value

er_smart_sync-0.2.0/LICENSE

@@ -0,0 +1,200 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may accept and charge a
+      fee for, or grant rights consistent with this License. However, in
+      accepting such obligations, You may act only on Your own behalf
+      and on Your sole responsibility, not on behalf of any other
+      Contributor, and only if You agree to indemnify, defend, and hold
+      each Contributor harmless for any liability incurred by, or claims
+      asserted against, such Contributor by reason of your accepting any
+      such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 PADAS
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

er_smart_sync-0.2.0/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: er-smart-sync
+Version: 0.2.0
+Summary: Synchronize SMART Connect data models, events, and patrols with EarthRanger
+License: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: earthranger-client
+Requires-Dist: smartconnect-client<2.0,>=1.11.0
+Requires-Dist: gundi-core>=1.11.0
+Requires-Dist: pydantic<2.0,>=1.10
+Requires-Dist: packaging
+Requires-Dist: click
+Requires-Dist: pyyaml
+Provides-Extra: gcp
+Requires-Dist: google-cloud-pubsub; extra == "gcp"
+Requires-Dist: google-cloud-storage; extra == "gcp"
+Provides-Extra: tracing
+Requires-Dist: opentelemetry-api; extra == "tracing"
+Requires-Dist: opentelemetry-sdk; extra == "tracing"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: ty; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.5; extra == "docs"
+Requires-Dist: mkdocs-exclude>=1.0; extra == "docs"
+Dynamic: license-file
+
+# er-smart-sync
+
+Synchronize [SMART Connect](https://smartconservationtools.org/) wildlife-monitoring
+data with [EarthRanger](https://www.earthranger.com/).
+
+## 📖 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.
+
+## Quick install
+
+```bash
+uv pip install er-smart-sync
+er-smart-sync --help
+```
+
+Or install from source (for development):
+
+```bash
+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](https://padas.github.io/earthranger-smart-utils/getting-started/install/)
+for prerequisites, optional extras, and verification steps.
+
+## For contributors
+
+Working on the codebase itself? Start with:
+
+- **[CLAUDE.md](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](USAGE.md)** — developer-oriented CLI reference and the bracketed-CA-label convention as it affects the codebase.
+- **[docs/superpowers/specs/](docs/superpowers/specs/)** — design specs for non-trivial features (v2 event types, choices population, etc.).
+- **[docs/superpowers/plans/](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](LICENSE).