Skip to main content

Workflow monitoring and management for FastAPI apps

Project description

ankor

Workflow monitoring and management for FastAPI apps.

ankor adds a self-hosted dashboard and run-tracking API to any FastAPI application. Decorate Python functions with @gtm.workflow and choose how they are triggered: manually, on a schedule, or via a webhook.

Install

pip install ankor

# Required for scheduled workflows:
pip install apscheduler

Quick start

import os
from fastapi import FastAPI
from ankor import ankor

app = FastAPI()

gtm = ankor(
    app,
    db_url=os.environ["GTM_DB_URL"],
    secret=os.environ["GTM_SECRET"],
)

@gtm.workflow
async def enrich_leads(inputs: dict):
    results = call_some_api(inputs["leads"])
    return {"enriched": results}

@gtm.workflow(schedule="0 9 * * 1-5")
async def daily_sync(inputs: dict):
    return {"synced": sync_database()}

@gtm.workflow(webhook=True)
async def process_event(inputs: dict):
    return handle(inputs)

This mounts the dashboard at /admin/ and the REST API at /api/* on your FastAPI app. See docs/DOCS.md for the full reference — constructor options, workflow decorator options, nodes, config store, data tables (including row filtering with RowFilter, column selection, and ordering with OrderBy), and deployment.

API Routes

See docs/API-ROUTES.md for the full route reference.

Package structure

See docs/PACKAGE-STRUCTURE.md for the full source layout.

Additional docs live in api/docs/.

Local development

For first-time setup (dependencies, .env, migrations) see the repo root README.

uv run python seed.py   # Optional: seed demo data

For dev server commands see the repo root README.md.

Requirements

  • Python 3.11+
  • PostgreSQL database (Supabase, Neon, or self-hosted)
  • FastAPI app

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

ankor-0.5.108.tar.gz (4.1 MB view details)

Uploaded Source

Built Distribution

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

ankor-0.5.108-py3-none-any.whl (4.0 MB view details)

Uploaded Python 3

File details

Details for the file ankor-0.5.108.tar.gz.

File metadata

  • Download URL: ankor-0.5.108.tar.gz
  • Upload date:
  • Size: 4.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for ankor-0.5.108.tar.gz
Algorithm Hash digest
SHA256 eb207a93af55890bf279a7ed6a9a3caea8d5e908baac21b2effa71b04115b076
MD5 6eca096d09066d997aaf8fad6caa4400
BLAKE2b-256 0aada212bd31cfd39c898e2d8d2d9be6b52ff9aaa5c343e79de64d215fd14996

See more details on using hashes here.

File details

Details for the file ankor-0.5.108-py3-none-any.whl.

File metadata

  • Download URL: ankor-0.5.108-py3-none-any.whl
  • Upload date:
  • Size: 4.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for ankor-0.5.108-py3-none-any.whl
Algorithm Hash digest
SHA256 b69bf22ae28c804e7d8b768f77d0edde8c9e11f00ac42f7e19fe969d078d8698
MD5 840891018e14d72944850a23d51df276
BLAKE2b-256 a97d0c0b15aedb5a1c1558d09c11bb4ad538a4e6819e7f62d592c14bca225bb7

See more details on using hashes here.

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