kicker 0.1.0__tar.gz

kicker-0.1.0/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.3
+Name: kicker
+Version: 0.1.0
+Summary: Lightweight job runner framework built on FastAPI and APScheduler with a simple web UI.
+Author: ANdrey Morozov
+Author-email: ANdrey Morozov <andrey@morozov.lv>
+Requires-Dist: apscheduler>=3.11.2
+Requires-Dist: fastapi>=0.136.1
+Requires-Dist: uvicorn>=0.46.0
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# kicker
+
+Lightweight job runner built on FastAPI and APScheduler with a simple web UI.
+
+## Features
+
+* Schedule jobs with APScheduler
+* Run jobs manually from UI
+* Pause/resume scheduler and individual jobs
+* Supports both sync and async functions
+* Simple HTML interface (no frontend framework)
+
+---
+
+## Installation
+
+```bash
+pip install kicker
+```
+
+---
+
+## Quick Start
+
+Create a project and define your jobs:
+
+```python
+# jobs.py
+import logging
+
+logger = logging.getLogger("kicker")
+
+def my_job():
+    logger.info("Hello from job")
+```
+
+Run the app:
+
+```python
+# main.py
+from fastapi import FastAPI
+from kicker import create_app
+
+app = create_app()
+```
+
+Or use your current pattern:
+
+```bash
+uvicorn main:app --reload
+```
+
+---
+
+## Usage
+
+Open in browser:
+
+```
+http://localhost:8000/kicker
+```
+
+From UI you can:
+
+* Start / pause scheduler
+* Run jobs manually
+* Pause / resume individual jobs
+* View execution logs
+
+---
+
+## Writing Jobs
+
+### Sync job
+
+```python
+def my_job():
+    print("sync job")
+```
+
+### Async job
+
+```python
+async def my_job():
+    await some_async_call()
+```
+
+Both are supported. Sync jobs are executed in a thread pool automatically.
+
+---
+
+## Scheduling Jobs
+
+Example:
+
+```python
+scheduler.add_job(
+    my_job,
+    trigger="cron",
+    minute="*/5",
+    id="my_job"
+)
+```
+
+---
+
+## Project Structure (example)
+
+```
+my_project/
+├── main.py
+└── jobs.py
+```
+
+---
+
+## Notes
+
+* Scheduler runs in-process (not distributed)
+* Running with multiple workers will duplicate job execution
+* Designed for simple internal tools and automation
+
+---
+
+## Roadmap
+
+* Job registration decorators
+* Plugin system
+* Persistent job stores
+* Better UI
+
+---
+
+## License
+
+MIT

kicker-0.1.0/README.md

@@ -0,0 +1,136 @@
+# kicker
+
+Lightweight job runner built on FastAPI and APScheduler with a simple web UI.
+
+## Features
+
+* Schedule jobs with APScheduler
+* Run jobs manually from UI
+* Pause/resume scheduler and individual jobs
+* Supports both sync and async functions
+* Simple HTML interface (no frontend framework)
+
+---
+
+## Installation
+
+```bash
+pip install kicker
+```
+
+---
+
+## Quick Start
+
+Create a project and define your jobs:
+
+```python
+# jobs.py
+import logging
+
+logger = logging.getLogger("kicker")
+
+def my_job():
+    logger.info("Hello from job")
+```
+
+Run the app:
+
+```python
+# main.py
+from fastapi import FastAPI
+from kicker import create_app
+
+app = create_app()
+```
+
+Or use your current pattern:
+
+```bash
+uvicorn main:app --reload
+```
+
+---
+
+## Usage
+
+Open in browser:
+
+```
+http://localhost:8000/kicker
+```
+
+From UI you can:
+
+* Start / pause scheduler
+* Run jobs manually
+* Pause / resume individual jobs
+* View execution logs
+
+---
+
+## Writing Jobs
+
+### Sync job
+
+```python
+def my_job():
+    print("sync job")
+```
+
+### Async job
+
+```python
+async def my_job():
+    await some_async_call()
+```
+
+Both are supported. Sync jobs are executed in a thread pool automatically.
+
+---
+
+## Scheduling Jobs
+
+Example:
+
+```python
+scheduler.add_job(
+    my_job,
+    trigger="cron",
+    minute="*/5",
+    id="my_job"
+)
+```
+
+---
+
+## Project Structure (example)
+
+```
+my_project/
+├── main.py
+└── jobs.py
+```
+
+---
+
+## Notes
+
+* Scheduler runs in-process (not distributed)
+* Running with multiple workers will duplicate job execution
+* Designed for simple internal tools and automation
+
+---
+
+## Roadmap
+
+* Job registration decorators
+* Plugin system
+* Persistent job stores
+* Better UI
+
+---
+
+## License
+
+MIT

kicker-0.1.0/pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "kicker"
+version = "0.1.0"
+description = "Lightweight job runner framework built on FastAPI and APScheduler with a simple web UI."
+readme = "README.md"
+authors = [
+    { name = "ANdrey Morozov", email = "andrey@morozov.lv" }
+]
+requires-python = ">=3.14"
+dependencies = [
+    "apscheduler>=3.11.2",
+    "fastapi>=0.136.1",
+    "uvicorn>=0.46.0",
+]
+
+[project.scripts]
+kicker = "kicker:main"
+
+[build-system]
+requires = ["uv_build>=0.10.4,<0.11.0"]
+build-backend = "uv_build"
+
+[tool.hatch.build]
+include = [
+    "kicker/py.typed",
+]

kicker-0.1.0/src/kicker/jobs/__init__.py

@@ -0,0 +1 @@
+from .echo import job_echo

kicker-0.1.0/src/kicker/jobs/echo.py

@@ -0,0 +1,25 @@
+import asyncio
+import logging
+
+from datetime import datetime
+
+logger = logging.getLogger(__name__)
+
+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)
+
+# ------------------------------------------------------------------------------------
+
+if __name__ == "__main__":
+    asyncio.run(job_echo())

kicker-0.1.0/src/kicker/main.py

@@ -0,0 +1,176 @@
+import asyncio
+import inspect
+import logging
+
+from collections import deque
+from importlib.metadata import version
+__version__ = version("kicker")
+
+from apscheduler.schedulers.asyncio import AsyncIOScheduler
+from apscheduler.schedulers.base import STATE_STOPPED, STATE_RUNNING, STATE_PAUSED
+from contextlib import asynccontextmanager
+from fastapi import FastAPI, Request, status
+from fastapi.responses import HTMLResponse, RedirectResponse
+
+from kicker.jobs import job_echo
+
+def wrap_job(func):
+    if inspect.iscoroutinefunction(func):
+        return func
+
+    async def wrapper(*args, **kwargs):
+        loop = asyncio.get_running_loop()
+        return await loop.run_in_executor(None, func, *args)
+
+    return wrapper
+
+class ExecutionLogHandler(logging.Handler):
+    def __init__(self, fast_api: FastAPI) -> None:
+        super().__init__()
+        self.app = fast_api
+
+    def emit(self, record):
+        msg = self.format(record)
+        self.app.state.execution_log.append(msg)
+
+def setup_logging(verbose: bool, fast_api: FastAPI):
+    logger = logging.getLogger("kicker")
+    logger.setLevel(logging.DEBUG if verbose else logging.INFO)
+
+    handler = ExecutionLogHandler(fast_api)
+    formatter = logging.Formatter("[%(levelname)s] %(message)s")
+    handler.setFormatter(formatter)
+
+    logger.addHandler(handler)
+    logger.propagate = False
+
+
+@asynccontextmanager
+async def lifespan(fast_api: FastAPI):
+    fast_api.state.scheduler = AsyncIOScheduler()
+    fast_api.state.scheduler.start(paused=True)
+    fast_api.state.scheduler.add_job(wrap_job(job_echo), 'cron', day_of_week='mon-fri', hour='9-20/2', minute=0, id='job_echo')
+
+    fast_api.state.execution_log = deque(maxlen=1000)
+
+    setup_logging(True, fast_api)
+    yield
+    fast_api.state.scheduler.shutdown(wait=False)
+app = FastAPI(
+    title="kicker", version=__version__, root_path="/kicker", lifespan=lifespan
+)
+
+@app.get("/", name="index", response_class=HTMLResponse)
+async def index(request: Request):
+    scheduler = request.app.state.scheduler
+    execution_log = request.app.state.execution_log
+
+    scheduler_is_running = scheduler.state == STATE_RUNNING
+    scheduler_is_paused = scheduler.state == STATE_PAUSED
+
+    list_execution_logs_html = []
+    for log in reversed(execution_log):
+        list_execution_logs_html.append(f"<li>{log}</li>")
+
+    table_rows_html: list[str] = []
+    for job in scheduler.get_jobs():
+        table_rows_html.append(f"""
+<tr>
+    <td>{job.name}</td>
+    <td><form action="{request.url_for('run_job', job_id=job.id)}" id="btn_run_{job.id}" method="get" style="display: inline;">
+        <input type="submit" value="run" {'disabled' if scheduler_is_paused else ''}>
+    </form></td>
+    <td><form action="{request.url_for('pause_job', job_id=job.id)}" id="btn_pause_{job.id}" method="get" style="display: inline;">
+        <input type="submit" value="pause" {'disabled' if scheduler_is_paused else ''}>
+    </form></td>
+    <td><form action="{request.url_for('resume_job', job_id=job.id)}" id="btn_resume_{job.id}" method="get" style="display: inline;">
+        <input type="submit" value="resume" {'disabled' if scheduler_is_paused else ''}>
+    </form></td>
+    <td>{job.next_run_time}</td>
+</tr>""")
+
+    content = f"""
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Scheduler {__version__}</title>
+</head>
+<body>
+    <h1>Scheduler Status: {'Running' if scheduler_is_running else 'Paused'}</h1>
+
+    <form action="{request.url_for('start_scheduler')}" id="btn_start_sched" method="get" style="display: inline;">
+        <input type="submit" value="Start Scheduler" {'disabled' if scheduler_is_running else ''}>
+    </form><br><br>
+
+    <table>
+        {'\n'.join(table_rows_html)}
+    </table>
+    <br>
+
+    <form action="{request.url_for('pause_scheduler')}" id="btn_pause_sched" method="get" style="display: inline;">
+        <input type="submit" value="Pause Scheduler" {'disabled' if scheduler_is_paused else ''}>
+    </form>
+    <h2>Job Executions:</h2>
+    <ul>
+        {'\n'.join(list_execution_logs_html) if list_execution_logs_html else '<li>No executions yet.</li>'}
+    </ul>
+
+    <script>
+        document.addEventListener('DOMContentLoaded', function() {{
+
+        }});
+    </script>
+</body>
+</html>"""
+    return HTMLResponse(content=content, status_code=status.HTTP_200_OK)
+
+@app.get("/run/{job_id}", name="run_job")
+async def run_job(request: Request, job_id):
+    scheduler = request.app.state.scheduler
+
+    job = scheduler.get_job(job_id)
+    if job:
+        await job.func()
+    return RedirectResponse(
+        url=request.url_for("index"), status_code=status.HTTP_302_FOUND
+    )
+
+@app.get('/pause/{job_id}', name="pause_job")
+async def pause_job(request: Request, job_id):
+    scheduler = request.app.state.scheduler
+
+    scheduler.pause_job(job_id)
+    return RedirectResponse(
+        url=request.url_for("index"), status_code=status.HTTP_302_FOUND
+    )
+
+@app.get('/resume/{job_id}', name="resume_job")
+async def resume_job(request: Request, job_id):
+    scheduler = request.app.state.scheduler
+
+    scheduler.resume_job(job_id)
+    return RedirectResponse(
+        url=request.url_for("index"), status_code=status.HTTP_302_FOUND
+    )
+
+@app.get('/start_scheduler', name="start_scheduler")
+async def start_scheduler(request: Request):
+    scheduler = request.app.state.scheduler
+
+    if scheduler.state == STATE_STOPPED:
+        scheduler.start()
+    else:
+        scheduler.resume()
+    return RedirectResponse(
+        url=request.url_for("index"), status_code=status.HTTP_302_FOUND
+    )
+
+@app.get('/pause_scheduler', name="pause_scheduler")
+async def pause_scheduler(request: Request):
+    scheduler = request.app.state.scheduler
+
+    if scheduler.state == STATE_RUNNING:
+        scheduler.pause()
+    return RedirectResponse(
+        url=request.url_for("index"), status_code=status.HTTP_302_FOUND
+    )

kicker-0.1.0/src/kicker/py.typed

@@ -0,0 +1 @@
+# Marker file for PEP 561 typing