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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ankor-0.5.127.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.127.tar.gz
Algorithm Hash digest
SHA256 df1a0e455ceb78ed8aa07da86114a4294bee8b0c6603ebab55a036e838c53b89
MD5 c982ea84617fcb3b3f695a7e66f3a478
BLAKE2b-256 651f82933e8cf0044ea3b1691c254890d18606656be597d1811d0b85fbf7b2d6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ankor-0.5.127-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.127-py3-none-any.whl
Algorithm Hash digest
SHA256 65278d2d9ecf871cf4340be159a3cf113fdd673c7e53e8c3fb7a98631c217108
MD5 5b1387dddf4e73ff3ac28266ba8d8bfa
BLAKE2b-256 b38a268a76739ce47df1f54f661001efe9a186df1a84aabce1252e087cfda576

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