Skip to main content

Lightweight job runner framework built on FastAPI and APScheduler with a simple web UI.

Project description

kicker

Lightweight job runner built on FastAPI and APScheduler with a simple web UI.

Features

  • FastAPI-style developer experience
    • app = Kicker()
    • @app.job(...)
    • standard uvicorn module:app
  • Schedule jobs with APScheduler
  • Run jobs manually from UI
  • Pause/resume scheduler and individual jobs
  • Supports both sync and async functions
  • Simple HTML interface

Installation

uv add kicker

Usage

Create a project and define your jobs:

import logging
from datetime import datetime
from kicker import Kicker

logger = logging.getLogger("kicker")

app = Kicker(verbose=True)

@app.job(day_of_week='mon-fri', hour='9-20/2', minute=0)
async def job_echo():
    execution_time = datetime.now()
    execution_time_str = execution_time.strftime("%Y-%m-%d %H:%M:%S")
    function_name = job_echo.__name__

    try:
        logger.debug("`%s` starting at %s", function_name, execution_time_str)
        ...
    except BaseException as e:
        logger.exception("Error in `%s`: %s", function_name, str(e))
        return
    else:
        logger.info("`%s` executed as %s", function_name, execution_time_str)


# run the app
# uv run uvicorn package.module:app --reload

Notes

  • Scheduler runs in-process (not distributed)
  • Running with multiple workers will duplicate job execution
  • Designed for simple internal tools and automation

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

kicker-0.2.0.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

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

kicker-0.2.0-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file kicker-0.2.0.tar.gz.

File metadata

  • Download URL: kicker-0.2.0.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Linux Mint","version":"22.3","id":"zena","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for kicker-0.2.0.tar.gz
Algorithm Hash digest
SHA256 da70c8790108c803854dfbbdffc67817852e4255cc586ac5f03da81eff99bc1d
MD5 c59d5ffccea6ec6e849194257250d0a8
BLAKE2b-256 61ea16a63a73223632c4188c68d8c6736f0dc9c2855f33b59b9e2fa20c63125d

See more details on using hashes here.

File details

Details for the file kicker-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: kicker-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Linux Mint","version":"22.3","id":"zena","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for kicker-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0db2e06a9efae71c068d91b77d3a21f480c0cc6c01de0223aba74fad4fae01d0
MD5 3cfba5f02f792efffdc9afeef01c8d93
BLAKE2b-256 acdb1049aadeea0293b17ef0b7ab24600e9f0e56798d45d2b224508b293a6c43

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