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.kick(...)- 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:
# main.py
from kicker import Kicker
app = Kicker(
logger_fmt="[%(levelname)s] %(message)s at %(asctime)s"
)
@app.kick(day_of_week='mon-fri', hour='9-20/2', minute=0)
async def job_echo(logger):
logger.info("job_echo executed")
# run the app
# uv run uvicorn package.module:app --reload
To see logs in the UI, declare a logger parameter — kicker injects it automatically. Jobs without it work fine but won't produce UI logs.
Splitting jobs across files
Like FastAPI's APIRouter, Coworker lets you define jobs in separate files and include them in the main app — no circular imports, no shared app instance.
# jobs/weekly_report.py
from kicker import Coworker
worker = Coworker()
@worker.kick(hour=8, minute=0)
async def weekly_report(logger):
logger.info("weekly_report executed")
# main.py
from kicker import Kicker
from jobs.weekly_report import worker
app = Kicker()
app.include_coworker(worker)
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kicker-0.3.2.tar.gz.
File metadata
- Download URL: kicker-0.3.2.tar.gz
- Upload date:
- Size: 4.8 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ab038355c5359874ff894b67133dbada442c328a63e7bbc2dc624532cc740564
|
|
| MD5 |
89a5d206bce1c5e056d505d00684cf4b
|
|
| BLAKE2b-256 |
d638057a2d92fda714417a6e0c5b841202c75176e93a15c15dfd9dfa34788a6c
|
File details
Details for the file kicker-0.3.2-py3-none-any.whl.
File metadata
- Download URL: kicker-0.3.2-py3-none-any.whl
- Upload date:
- Size: 6.4 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
897369dbf416015c2d26e973371e2c49cbc808e0dd6eee6e21747a683ed1efc9
|
|
| MD5 |
ad62a8c765c732ad23e14e7a9dae891b
|
|
| BLAKE2b-256 |
929e90f02320807705be597d263c2c19c6f134472daa1fb0e535856d83c00eda
|