fastapi-task-manager 1.0.0rc1

A task manager for Fastapi. Robust Scheduling, Distributed Safety

Lightweight, efficient and fast to code scheduled task management system built on FastAPI

Lightweight, efficient and fast to code scheduled task management system built on FastAPI.

---

Documentation: https://fastapi-task-manager.morando.uk

Source Code: https://github.com/Morry98/fastapi-task-manager

---

Overview

FastAPI Task Manager is a lightweight and efficient scheduled task management system built on top of FastAPI and Redis. It is designed to help developers easily create, manage, and execute scheduled tasks within their FastAPI applications.

Key Features

• FastAPI Extension - Built as an extension to FastAPI, making it easy to integrate into existing FastAPI applications and leverage its features
• Redis-Based - Uses Redis as the backend for storing task information, ensuring high performance and single-instance execution
• Fast to Code - Increase the speed to develop scheduled tasks by about 400% to 500%, only a wrapper function is needed*
• Fewer Bugs - Reduce about 60% of human (developer) induced errors managing lock, Redis keys and task execution*
• Scheduled Tasks - Provides a simple and intuitive API for defining and scheduling tasks to run at specific intervals or times
• Task Management - Includes FastAPI router to manage tasks, such as pausing, resuming, and monitoring execution information
• Easy to Use - Designed to be easy to use and learn. Less time reading docs
• Robust - Get production-ready code

* estimation based on real production task migrated to FastAPI task manager from custom "cron job" solution.

Requirements

FastAPI Task Manager stands on the shoulders of giants:

• FastAPI - Modern, fast web framework for building APIs
• Redis - In-memory data structure store for task storage and locking

Installation

You need to have a FastAPI project set up. If you don't have one, check the FastAPI installation tutorial.

Install FastAPI Task Manager using pip:

pip install fastapi-task-manager

Quick Example

Here's a simple example to get you started:

from fastapi import FastAPI
from fastapi_task_manager import TaskManager, task, TaskGroup
from fastapi_task_manager import Config as ManagerConfig
from pydantic_settings import BaseSettings, SettingsConfigDict


class Config(BaseSettings):
    model_config = SettingsConfigDict(
        # `.env.prod` takes priority over `.env`
        env_file=(".env", ".env.prod"),
        extra="forbid",
    )

    # --------- Redis config variables ---------
    redis_host: str | None = None
    redis_port: int = 6379
    redis_password: str | None = None
    redis_db: int = 0
    # --------- End of redis config variables ---------

    # --------- App config variables ---------
    app_name: str = "my_fastapi_app"
    concurrent_tasks: int = 3
    # --------- End of app config variables ---------

CONFIG = Config()

app = FastAPI()
router = APIRouter()

task_manager = TaskManager(
    config=ManagerConfig(
        redis_host=CONFIG.redis_host,
        redis_port=CONFIG.redis_port,
        redis_password=CONFIG.redis_password,
        redis_db=CONFIG.redis_db,
        concurrent_tasks=CONFIG.concurrent_tasks,
        redis_key_prefix=CONFIG.app_name,
    ),
    app=app,
)
my_example_task_group = TaskGroup(
  tags=["example"],
  name="My Example Task Group",
)
task_manager.add_task_group(my_example_task_group)

manager_router = task_manager.get_manager_router()
router.include_router(
  manager_router,
  prefix="/task-manager",
  tags=["task-manager"],
)

app.include_router(router)

@my_example_task_group.add_task(
  "*/5 * * * *",  # Run every 5 minutes
  name="my_scheduled_task",
  description="This is my scheduled task"
)
async def my_scheduled_task():
    print("Task executed!")
    # Your task logic here

License

This project is licensed under the terms of the MIT license.