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.115.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.115-py3-none-any.whl (4.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ankor-0.5.115.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.115.tar.gz
Algorithm Hash digest
SHA256 3e3aeeb16aa45918faf1778317d4be56d0083d9baa3eac6edc83c6bfcea3484d
MD5 326070841f7cf16a8e8d3b9819f576c9
BLAKE2b-256 fe871c3c59b64ab610266530bb4d229b40685c6d5d078d36c4f1811dbbed42c8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ankor-0.5.115-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.115-py3-none-any.whl
Algorithm Hash digest
SHA256 0d13d5e30c149467f64671b0376a13e4eaeca920417a548eb366bd0aaef1b074
MD5 c275ab804e4ce0838bac8d728e65cb4b
BLAKE2b-256 d5f1164a6ce8fa9e4ba22def4273b247192ddcb4f35e95f938d16c4ac469ded3

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