Skip to content

Gundi Action Runner

A framework for building Gundi integration connectors in Python. Register handlers with decorators, and the framework provides the FastAPI service, scheduling, state, activity logging, portal schemas, and delivery to Gundi.

from gundi_action_runner import action, create_app

@action.pull(config=PullObservationsConfig, title="Pull Observations")
async def pull_observations(integration, action_config):
    ...

app = create_app(handlers_modules=["myconnector.handlers"])

Install

pip install "gundi-action-runner[cli]"

Where to go

  • Quickstart — scaffold, run, and register a connector with gundi-runner.
  • Extension API — the @action.* / @webhook decorators, create_app(), framework services, and testing fixtures.
  • Migrating a Fork — moving an existing template fork onto the library, step by step.

Maintainers: releases are cut per RELEASING.md; source lives on GitHub.