Merge pull request #48 from danfimov/feat-granian

feat: use graninan instead of uvicorn

Author: danfimov

Dockerfile

@@ -1,18 +1,18 @@
-FROM python:3.12-slim AS builder
+FROM python:3.13-slim AS builder
 
 COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
 
 ENV UV_LINK_MODE=copy \
     UV_COMPILE_BYTECODE=1 \
     UV_PYTHON_DOWNLOADS=never \
-    UV_PYTHON=python3.12 \
+    UV_PYTHON=python3.13 \
     UV_PROJECT_ENVIRONMENT="/app/.venv"
 
 # Install dependencies
 COPY ./pyproject.toml ./uv.lock ./
-RUN uv sync --no-dev --locked --no-install-project
+RUN uv sync --extra server --no-dev --locked --no-install-project
 
-FROM python:3.12-slim
+FROM python:3.13-slim
 
 ENV PATH="/app/.venv/bin:$PATH"
 

docs/examples/example_with_broker.py

@@ -42,14 +42,16 @@ async def best_task_ever(*args, **kwargs) -> dict[str, tp.Any]:
     }
 
 
-def run_admin_panel() -> None:
+async def run_admin_panel() -> None:
     app = TaskiqDashboard(
         api_token='supersecret',
+        storage_type='postgres',
+        database_dsn=dsn.replace('postgres://', 'postgresql+asyncpg://'),
         broker=broker,
-        host='0.0.0.0',
+        address='0.0.0.0',
         port=8000,
     )
-    app.run()
+    await app.run()
 
 
 async def send_task() -> None:
@@ -62,7 +64,7 @@ async def send_task() -> None:
 if __name__ == '__main__':
     if sys.argv[1] == 'admin_panel':
         print('Starting admin panel...')
-        run_admin_panel()
+        asyncio.run(run_admin_panel())
     elif sys.argv[1] == 'send_task':
         print('Sending task to the broker...')
         asyncio.run(send_task())

docs/examples/example_with_scheduler.py

@@ -56,16 +56,18 @@ async def best_task_ever(*args, **kwargs) -> dict[str, tp.Any]:
     }
 
 
-def run_admin_panel() -> None:
+async def run_admin_panel() -> None:
     app = TaskiqDashboard(
         api_token='supersecret',
+        storage_type='postgres',
+        database_dsn=dsn.replace('postgres://', 'postgresql+asyncpg://'),
         broker=broker,
         scheduler=scheduler,
-        host='0.0.0.0',
+        address='0.0.0.0',
         port=8000,
     )
-    app.run()
+    await app.run()
 
 
 if __name__ == '__main__':
-    run_admin_panel()
+    asyncio.run(run_admin_panel())

docs/index.md

@@ -105,6 +105,19 @@ docker pull ghcr.io/danfimov/taskiq-dashboard:latest
 
 You can also pass `broker` or `scheduler` instances directly to the `TaskiqDashboard` constructor and get additional features like actions with tasks or schedule configuration. Read more about it in the [tutorial](./tutorial/run_with_broker.md) section.
 
+!!! note "Dashboard can be a part of your existing API server"
+
+    If you already have an API server running, you can mount admin panel routes to it:
+
+    ```python
+    from taskiq_dashboard import TaskiqDashboard
+    import fastapi
+
+    app = fastapi.FastAPI(...)
+    admin_dashboard = TaskiqDashboard(...)
+    app.mount('/admin', admin_dashboard.application)
+    ```
+
 ### Run with docker compose
 
 === "postgres"

pyproject.toml

@@ -34,8 +34,7 @@ authors = [
 requires-python = ">=3.10"
 dependencies = [
     # api
-    "fastapi>=0.120.0",
-    "uvicorn[standard]>=0.40.0",
+    "fastapi>=0.128.0",
     # html templates
     "jinja2>=3.1.6",
     # db
@@ -50,6 +49,11 @@ dependencies = [
     "taskiq>=0.12.1",
 ]
 
+[project.optional-dependencies]
+server = [
+    "granian>=2.6.0",
+]
+
 [project.urls]
 "Bug Tracker" = "https://github.com/danfimov/taskiq-dashboard/issues"
 "Repository" = "https://github.com/danfimov/taskiq-dashboard/"

taskiq_dashboard/api/__main__.py

@@ -1,16 +1,24 @@
+import asyncio
+
 from taskiq_dashboard import TaskiqDashboard
 from taskiq_dashboard.infrastructure import get_settings
 
 
-if __name__ == '__main__':
+async def main() -> None:
     settings = get_settings()
     storage_type = settings.storage_type
-    TaskiqDashboard(
+    dashboard = TaskiqDashboard(
         api_token=settings.api.token.get_secret_value(),
         storage_type=storage_type,
         database_dsn=(
-            settings.postgres.dsn.get_secret_value() if storage_type == 'postgres'
+            settings.postgres.dsn.get_secret_value()
+            if storage_type == 'postgres'
             else settings.sqlite.dsn.get_secret_value()
         ),
         **settings.api.model_dump(exclude='token'),  # type: ignore[arg-type]
-    ).run()
+    )
+    await dashboard.run()
+
+
+if __name__ == '__main__':
+    asyncio.run(main())

taskiq_dashboard/api/routers/action.py

@@ -101,11 +101,13 @@ async def handle_task_rerun(
     name='Delete task',
 )
 async def handle_task_delete(
+    request: fastapi.Request,
     task_id: uuid.UUID,
     repository: dishka_fastapi.FromDishka[AbstractTaskRepository],
 ) -> Response:
     await repository.delete_task(task_id)
+    mount_prefix = request.url.path.rsplit('/actions/delete/', 1)[0]
     return RedirectResponse(
-        url='/',
+        url=mount_prefix if mount_prefix else '/',
         status_code=status.HTTP_307_TEMPORARY_REDIRECT,
     )

taskiq_dashboard/api/routers/event.py

@@ -40,8 +40,6 @@ async def handle_task_event(
         task_id: The unique identifier of the task.
         event: The type of event (e.g., 'queued', 'started', 'executed').
     """
-    # Here you would implement the logic to handle the task event,
-    # such as updating a database record or logging the event.
     task_arguments: QueuedTask | StartedTask | ExecutedTask
     match event:
         case 'queued':

taskiq_dashboard/api/templates/task_details.html

@@ -119,7 +119,7 @@ <h3 class="mb-2">Started at</h3>
                     {% if task.started_at %}
                         <p class="font-light">{{ task.started_at.strftime('%Y-%m-%d %H:%M:%S') }}</p>
                     {% else %}
-                        <p class="font-light">Not started yet</p>
+                        <p class="font-light">-</p>
                     {% endif %}
                 </div>
                 <div>
@@ -128,7 +128,7 @@ <h3 class="mb-2">Finished at</h3>
                         {% if task.finished_at %}
                             {{ task.finished_at.strftime('%Y-%m-%d %H:%M:%S') }}
                         {% else %}
-                            <span class="font-light">Not finished yet</span>
+                            <span class="font-light">-</span>
                         {% endif %}
                     </p>
                 </div>

taskiq_dashboard/infrastructure/database/schemas.py

@@ -42,8 +42,7 @@ class PostgresTask(BaseTableSchema):
 
     queued_at: Mapped[dt.datetime] = mapped_column(
         sa.DateTime(timezone=True),
-        nullable=False,
-        default=dt.datetime.now,
+        nullable=True,
     )
     started_at: Mapped[dt.datetime] = mapped_column(
         sa.DateTime(timezone=True),
@@ -77,8 +76,7 @@ class SqliteTask(BaseTableSchema):
 
     queued_at: Mapped[dt.datetime] = mapped_column(
         sa.DateTime(timezone=True),
-        nullable=False,
-        default=dt.datetime.now,
+        nullable=True,
     )
     started_at: Mapped[dt.datetime] = mapped_column(
         sa.DateTime(timezone=True),