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.141.tar.gz (4.3 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.141-py3-none-any.whl (4.3 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ankor-0.5.141.tar.gz
  • Upload date:
  • Size: 4.3 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.141.tar.gz
Algorithm Hash digest
SHA256 49090cb1786cc5432fc7d2fedcaa38f79f81f135fbcecc545734fe07c2c38c4a
MD5 e0a72a6fd159d5041ca2b66996fb249e
BLAKE2b-256 868868144b4381cc05b15af551fd0a7b1167a3ce6d1fc5143db82b053373b06e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ankor-0.5.141-py3-none-any.whl
  • Upload date:
  • Size: 4.3 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.141-py3-none-any.whl
Algorithm Hash digest
SHA256 29b4b3f9d196de6b9cdf09f6a82b3cab4c05603c8ba93c5e103497aa332730aa
MD5 e2fd09e37d1d0d724b95ea93e8d48c3e
BLAKE2b-256 24b0d8ea3d9f12d683a0a91ba9c756b969ab432ada561ffdd6a878f9663b9efc

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