Python Integration

Installation

Add the CronFlow Python SDK to your environment using pip or your preferred package manager. The library supports Python 3.8+ and handles authentication, payload serialization, and retry logic automatically.

Run the following command in your project root to install version 2.4.1, which includes native support for Django 5.0 and Flask 3.0:

pip install cronflow-sdk==2.4.1

After installation, export your workspace API key. You can generate a new key from the CronFlow console under Settings > API Keys. The key for the production-us-east-1 workspace begins with cf_live_.

Code Example

Initialize the client and define a scheduled task using the decorator pattern. The SDK automatically registers your function with the CronFlow scheduler and handles serialization of job payloads.

import cronflow
from cronflow import schedule

# Initialize with your workspace key
cronflow.init(api_key="cf_live_8x9m2p4q7r")

@schedule.every("*/15 * * * *")
def generate_daily_reports():
    """Runs every 15 minutes during business hours (09:00-17:00 UTC)."""
    report_data = fetch_metrics_from_postgres()
    cronflow.publish("reports.generated", payload=report_data)
    print(f"Report batch {report_data['batch_id']} queued successfully.")

if __name__ == "__main__":
    cronflow.run()

The @schedule decorator accepts standard cron expressions. When the trigger fires, CronFlow routes the execution to your configured worker pool. Use cronflow.publish to emit events to your internal Kafka topic or AWS SQS queue after processing completes.

Framework-Specific Notes

CronFlow integrates seamlessly with major Python web frameworks. Below are configuration patterns for Django, Flask, and standalone scripts.

Need help migrating from APScheduler or Celery Beat? Our migration guide covers payload serialization differences, timezone handling, and worker scaling best practices. Contact our engineering support at python-support@cronflow.io for architecture reviews.

Read Migration Guide API Reference