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.2.2.tar.gz (14.9 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.2.2-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: quiv-0.2.2.tar.gz
  • Upload date:
  • Size: 14.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","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.2.2.tar.gz
Algorithm Hash digest
SHA256 8899706a93c86f85260aa817713ee305650e8d726d3eabe6097fea996f48c136
MD5 58ec4b28983c6091c8d569de8ffe0a3b
BLAKE2b-256 b535142f18cceedef80d1dfeb626265ff8b6c49d6cc75d02cce1264c450021b9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: quiv-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 19.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","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.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b84bf293ed0dc67f957999c229479e738bbb09d3225d90d7d813376b9e88d3c4
MD5 bc3a807a11a8ef8bb28d0f63f08ea4bd
BLAKE2b-256 cad61b77db3a8b51a172b2cccad0266fdda13a0b6b9ded5a0ba53dc1c058483d

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