Skip to main content

Framework for building Gundi integration action runners

Project description

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]"

The current release is a release candidate — until the first stable release, pin it exactly: pip install "gundi-action-runner[cli]==0.1.0rc2" (avoid --pre, which cascades pre-releases to all dependencies).

What you get

  • gundi-runner new — scaffold a complete connector project interactively (copier-backed; generated projects can pull template updates later)
  • gundi-runner run / register / add-action — local dev server, Gundi registration, and handler codegen
  • Pytest fixtures — installing the package registers a pytest plugin with ready-made Gundi mocks (integration_v2, mock_gundi_client_v2, ...)
  • Local dev stack — scaffolds include a docker-compose environment (connector + redis + Pub/Sub emulator with sub-action loopback)
  • Two auth modes — service client credentials, or your own Gundi login via the OAuth2 password grant for local development

Documentation

Apache-2.0. Maintained by the Gundi team at EarthRanger.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gundi_action_runner-0.1.0rc2.tar.gz (57.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gundi_action_runner-0.1.0rc2-py3-none-any.whl (62.4 kB view details)

Uploaded Python 3

File details

Details for the file gundi_action_runner-0.1.0rc2.tar.gz.

File metadata

  • Download URL: gundi_action_runner-0.1.0rc2.tar.gz
  • Upload date:
  • Size: 57.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gundi_action_runner-0.1.0rc2.tar.gz
Algorithm Hash digest
SHA256 e1c6745db62b07612c5badd18e8cf1f6c8e920f64b6292a5f2329343c16f5704
MD5 4352e4497bd8f74d4e72adc84da00a45
BLAKE2b-256 9dc3a428bf2f2566331ca1682ecaed22098352a9da8a88fe33bedbc4d061e4bb

See more details on using hashes here.

Provenance

The following attestation bundles were made for gundi_action_runner-0.1.0rc2.tar.gz:

Publisher: publish.yaml on PADAS/gundi-integration-action-runner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gundi_action_runner-0.1.0rc2-py3-none-any.whl.

File metadata

File hashes

Hashes for gundi_action_runner-0.1.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 588926cb2f53192ed91e6ecf07cedf2a1090da650a6858926f1d41b3bde97cfd
MD5 eab354aea454534d1efa7447609f392f
BLAKE2b-256 96d2026f024304e2406318fde981db95f87d5c1f856342080e370a601ad8177e

See more details on using hashes here.

Provenance

The following attestation bundles were made for gundi_action_runner-0.1.0rc2-py3-none-any.whl:

Publisher: publish.yaml on PADAS/gundi-integration-action-runner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page