Skip to main content

Quiv: threadpool-backed scheduler for Python applications

Project description

quiv Logo


Python Code style: black License: MIT PyPI Pulls

Build Tests Type Check GitHub Issues GitHub last commit

quiv is a lightweight background task scheduler for Python applications.

It is designed to work especially well with FastAPI apps that need predictable, in-process background task orchestration.

Supports Python 3.10 through 3.14.

It provides:

  • threadpool-backed execution
  • support for sync and async task handlers
  • cooperative cancellation (_stop_event)
  • progress callbacks routed to your main async loop (_progress_hook)
  • persistent task/job state via SQLModel + SQLite

When to use quiv

Use quiv when you need in-process background scheduling for app-level jobs, for example:

  • polling APIs every N seconds
  • periodic cleanup tasks
  • one-shot delayed jobs
  • progress-aware long-running workloads

Install

uv add quiv
# or
pip install quiv

Quick start

from contextlib import asynccontextmanager

from fastapi import FastAPI

from quiv import Quiv

scheduler = Quiv(timezone="UTC")


def ping(_progress_hook=None):
    for i in range(30):
        # do some work
        if _progress_hook:
            _progress_hook(message="ping", progress=i, total=30)


async def on_progress(**payload):
    # Replace with websocket broadcast, logging, metrics, etc.
    print("progress", payload)


@asynccontextmanager
async def lifespan(app: FastAPI):
    # Startup
    scheduler.start()
    yield
    # Shutdown
    scheduler.shutdown()


app = FastAPI(lifespan=lifespan)

@app.post("/start-heartbeat")
def start_heartbeat():
    scheduler.add_task(
        task_name="heartbeat",
        func=ping,
        interval=30,
        progress_callback=on_progress,
    )
    return {"message": "Heartbeat started successfully!"}

Documentation

Full documentation is available at nandyalu.github.io/quiv.

License

MIT

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

quiv-0.3.3.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quiv-0.3.3-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

Details for the file quiv-0.3.3.tar.gz.

File metadata

  • Download URL: quiv-0.3.3.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.5 {"installer":{"name":"uv","version":"0.11.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for quiv-0.3.3.tar.gz
Algorithm Hash digest
SHA256 5744fca98142d003f185016d12124ba7d708f1d4a587dca406180b33992d281e
MD5 339bb0f94f1988452f5682755a1f9fd9
BLAKE2b-256 f3f6915176cf27cc89e6988322fa398e6c6bdc04de1e34160224b498dd4854e0

See more details on using hashes here.

File details

Details for the file quiv-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: quiv-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 22.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.5 {"installer":{"name":"uv","version":"0.11.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for quiv-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 765de1501643d3d07a6580deeced2a782020b7a1e24c2278c44d905ddef9c8d5
MD5 aee65eb5e95023c1b09eab6e44c6933d
BLAKE2b-256 a2f9b8d817640adac11fa6c4c22fdb3bf5b168faf6479cd4bc9342b282ebc621

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