Query by param (#100)

* lazy settings

* Add migs

* Exclude migs from lint

Author: lsbardel

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.defaultInterpreterPath": ".venv/bin/python",
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter",
+        "editor.formatOnSave": true
+    }
+}

docs/reference/task_plugin.md

@@ -8,20 +8,17 @@ and is registered via [TaskManager.with_plugin][fluid.scheduler.TaskManager.with
 
 ```python
 from fluid.scheduler import TaskScheduler, task_manager_fastapi
-from fluid.scheduler.db import TaskDbPlugin, with_task_history_router
+from fluid.scheduler.db import TaskDbPlugin
 
 task_manager = TaskScheduler(...)
 task_manager.with_plugin(TaskDbPlugin(db))
 app = task_manager_fastapi(task_manager)
-with_task_history_router(app)
 ```
 
 ::: fluid.scheduler.TaskManagerPlugin
 
 ::: fluid.scheduler.db.TaskDbPlugin
 
-::: fluid.scheduler.db.with_task_history_router
-
 ## Accessing the plugin from a task
 
 [get_db_plugin][fluid.scheduler.db.get_db_plugin] retrieves the registered
@@ -48,7 +45,7 @@ async def report(context: TaskRun) -> None:
 
 The following models are used when querying task run history via
 [TaskDbPlugin.get_history][fluid.scheduler.db.TaskDbPlugin.get_history]
-or the HTTP endpoints added by [with_task_history_router][fluid.scheduler.db.with_task_history_router].
+or the HTTP endpoints.
 
 They can be imported from `fluid.scheduler.db`:
 

docs/tutorials/task_app.md

@@ -120,26 +120,24 @@ Register the plugin when building your task manager:
 
 ```python
 from fluid.scheduler import TaskScheduler, task_manager_fastapi
-from fluid.scheduler.db import TaskDbPlugin, with_task_history_router
+from fluid.scheduler.db import TaskDbPlugin
 from fluid.db import CrudDB
 
 db = CrudDB.from_env()
 task_manager = TaskScheduler(...)
 task_manager.with_plugin(TaskDbPlugin(db))
 app = task_manager_fastapi(task_manager)
-with_task_history_router(app)
 ```
 
 The plugin creates a `fluid_tasks` table (configurable via `table_name`) and
 persists a row for each task run as it moves through its lifecycle states.
 Tasks tagged with `skip_db` are excluded from persistence.
-
-`with_task_history_router` mounts a `/history` router on the app with two endpoints:
+The plugin mounts a `/tasks-history` router on the app with two endpoints:
 
 | Method | Path | Description |
 |--------|------|-------------|
-| `GET` | `/history` | List task run history with optional filters |
-| `GET` | `/history/{run_id}` | Fetch a single task run by ID |
+| `GET` | `/tasks-history` | List task run history with optional filters |
+| `GET` | `/tasks-history/{run_id}` | Fetch a single task run by ID |
 
 The list endpoint accepts the following query parameters:
 

examples/__main__.py

@@ -1,7 +1,3 @@
-import dotenv
-
-dotenv.load_dotenv()
-
 from examples.cli import task_manager_cli  # isort:skip    # noqa: E402
 
 task_manager_cli()

examples/cli.py

@@ -1,5 +1,9 @@
+import dotenv
+
 from fluid.scheduler.cli import TaskManagerCLI
 
+dotenv.load_dotenv()
+
 task_manager_cli = TaskManagerCLI(
     "examples.tasks:task_app", lazy_subcommands={"db": "examples.db.cli:cli"}
 )

examples/full_cli.py

@@ -0,0 +1,32 @@
+from pathlib import Path
+
+import dotenv
+
+from fluid.db import CrudDB
+from fluid.db.cli import DbGroup
+from fluid.scheduler.cli import DEFAULT_COMMANDS, TaskManagerCLI
+from fluid.scheduler.db import TaskDbPlugin
+
+dotenv.load_dotenv()
+
+MIGRATIONS_PATH = Path(__file__).parent / "tasks" / "migrations"
+
+
+def create_cli() -> TaskManagerCLI:
+    from examples.tasks import task_app
+
+    # create the database for the db plugin
+    db = CrudDB.from_env(migration_path=MIGRATIONS_PATH, db_name="fluid_full_cli")
+    # create the client
+    task_manager_cli = TaskManagerCLI(
+        task_app(plugins=[TaskDbPlugin(db)]),
+        commands=list(DEFAULT_COMMANDS)
+        + [DbGroup(db, help="Task database plugin management")],
+        help="Task Manager CLI with db plugin",
+    )
+    return task_manager_cli
+
+
+if __name__ == "__main__":
+    task_manager_cli = create_cli()
+    task_manager_cli()

examples/simple.py

@@ -1,8 +1,13 @@
 import asyncio
 
-from examples.tasks import task_scheduler
+import dotenv
+
 from fluid.utils import log
 
+dotenv.load_dotenv()
+
 if __name__ == "__main__":
+    from examples.tasks import task_scheduler
+
     log.config()
     asyncio.run(task_scheduler().run())

examples/simple_cli.py

@@ -2,10 +2,13 @@
 
 dotenv.load_dotenv()
 
-from fluid.scheduler.cli import TaskManagerCLI  # isort:skip    # noqa: E402
 
 if __name__ == "__main__":
     from examples.tasks import task_app
+    from fluid.scheduler.cli import TaskManagerCLI
 
-    task_manager_cli = TaskManagerCLI(task_app())
+    task_manager_cli = TaskManagerCLI(
+        task_app(),
+        help="Simple Task Manager CLI with default commands",
+    )
     task_manager_cli()

examples/simple_fastapi.py

@@ -1,8 +1,12 @@
+import dotenv
 import uvicorn
 
-from examples.tasks import task_app
 from fluid.utils import log
 
+dotenv.load_dotenv()
+
 if __name__ == "__main__":
+    from examples.tasks import task_app
+
     log.config()
     uvicorn.run(task_app())

examples/tasks/__init__.py

@@ -48,8 +48,11 @@ def task_scheduler(
     return task_manager
 
 
-def task_app() -> FastAPI:
-    return task_manager_fastapi(task_scheduler(), app=FastAPI(title="Task Manager API"))
+def task_app(plugins: Sequence[TaskManagerPlugin] | None = None) -> FastAPI:
+    return task_manager_fastapi(
+        task_scheduler(plugins=plugins),
+        app=FastAPI(title="Task Manager API"),
+    )
 
 
 class Sleep(BaseModel):