Merge pull request #38 from ImperialCollegeLondon/django-tables2

Use Django Tables 2 for the index page

.pre-commit-config.yaml

@@ -23,12 +23,6 @@ repos:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
       - id: ruff-format
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.11.1
-    hooks:
-      - id: mypy
-        exclude: manage.py
-        additional_dependencies: ['django-stubs[compatible-mypy]']
   - repo: https://github.com/igorshubovych/markdownlint-cli
     rev: v0.41.0
     hooks:

README.md

@@ -1,12 +1,6 @@
 # dune_processes
 
-[Description for project.]
-
-This is a Python application that uses [poetry](https://python-poetry.org) for packaging
-and dependency management. It also provides [pre-commit](https://pre-commit.com/) hooks
-(for [ruff](https://pypi.org/project/ruff/) and
-[mypy](https://mypy.readthedocs.io/en/stable/)) and automated tests using
-[pytest](https://pytest.org/) and [GitHub Actions](https://github.com/features/actions).
+This repo defines the web app for the Dune Process Manager web interface.
 
 ## For developers
 
@@ -38,13 +32,24 @@ To get started:
    pre-commit install
    ```
 
-1. Run the main app:
+1. Run the main app (this will not receive any data from the drunc process manager):
 
    ```bash
-   python -m dune_processes
+   python manage.py runserver
    ```
 
-## Publishing
+### Running the App
+
+To run this with a demo version of the drunc process manager, run it with docker compose:
+
+```bash
+docker compose up -d
+```
+
+Dummy processes can be sent to the server with the `scripts/talk_to_process_manager.py` script:
+
+```bash
+docker compose exec app python scripts/talk_to_process_manager.py
+```
 
-The GitHub workflow includes an action to publish on release.
-To run this action, uncomment the commented portion of `publish.yml`, and modify the steps for the desired behaviour (publishing a Docker image, publishing to PyPI, deploying documentation etc.)
+Take the servers down with `docker compose down`

dune_processes/settings/settings.py

@@ -123,7 +123,7 @@
 
 
 # Custom settings
-INSTALLED_APPS += ["main"]
+INSTALLED_APPS += ["main", "django_tables2"]
 
 
 MIDDLEWARE.insert(1, "whitenoise.middleware.WhiteNoiseMiddleware")

main/tables.py

@@ -0,0 +1,14 @@
+"""Tables for the main app."""
+
+import django_tables2 as tables
+
+
+class ProcessTable(tables.Table):
+    """Defines and Process Table for the data from the Process Manager."""
+
+    uuid = tables.Column(verbose_name="UUID")
+    name = tables.Column(verbose_name="Name")
+    user = tables.Column(verbose_name="User")
+    session = tables.Column(verbose_name="Session")
+    status_code = tables.Column(verbose_name="Status Code")
+    exit_code = tables.Column(verbose_name="Exit Code")

main/templates/main/index.html

@@ -1,29 +1,11 @@
 {% extends "main/base.html" %}
+{% load render_table from django_tables2 %}
 
 {% block title %}Home{% endblock title %}
 
 {% block content %}
 Welcome to the index page.
 
-<table border="1">
-    <tr>
-        <th>uuid</th>
-        <th>name</th>
-        <th>user</th>
-        <th>session</th>
-        <th>status code</th>
-        <th>exit code</th>
-    </tr>
-    {% for value in values %}
-    <tr>
-        <td>{{ value.uuid.uuid }}</td>
-        <td>{{ value.process_description.metadata.name }}</td>
-        <td>{{ value.process_description.metadata.user }}</td>
-        <td>{{ value.process_description.metadata.session }}</td>
-        <td>{{ value.status_code }}</td>
-        <td>{{ value.return_code }}</td>
-    </tr>
-    {% endfor %}
-</table>
+{% render_table table %}
 
 {% endblock content %}

main/views.py

@@ -6,7 +6,13 @@
 from django.shortcuts import render
 from drunc.process_manager.process_manager_driver import ProcessManagerDriver
 from drunc.utils.shell_utils import create_dummy_token_from_uname
-from druncschema.process_manager_pb2 import ProcessInstanceList, ProcessQuery
+from druncschema.process_manager_pb2 import (
+    ProcessInstance,
+    ProcessInstanceList,
+    ProcessQuery,
+)
+
+from .tables import ProcessTable
 
 
 async def get_session_info() -> ProcessInstanceList:
@@ -20,6 +26,24 @@ async def get_session_info() -> ProcessInstanceList:
 def index(request: HttpRequest) -> HttpResponse:
     """View that renders the index/home page."""
     val = asyncio.run(get_session_info())
-    context = {"values": val.data.values}
+
+    status_enum_lookup = dict(item[::-1] for item in ProcessInstance.StatusCode.items())
+
+    table = []
+    process_instances = val.data.values
+    for process_instance in process_instances:
+        metadata = process_instance.process_description.metadata
+        table.append(
+            {
+                "uuid": process_instance.uuid.uuid,
+                "name": metadata.name,
+                "user": metadata.user,
+                "session": metadata.session,
+                "status_code": status_enum_lookup[process_instance.status_code],
+                "exit_code": process_instance.return_code,
+            }
+        )
+
+    context = {"table": ProcessTable(table)}
 
     return render(request=request, context=context, template_name="main/index.html")

pyproject.toml

@@ -11,8 +11,9 @@ authors = [
 python = "^3.12"
 django = "^5.1"
 whitenoise = "^6.7.0"
-drunc = {git = "https://github.com/DUNE-DAQ/drunc.git"}
-druncschema = {git = "https://github.com/DUNE-DAQ/druncschema.git"}
+drunc = { git = "https://github.com/DUNE-DAQ/drunc.git" }
+druncschema = { git = "https://github.com/DUNE-DAQ/druncschema.git" }
+django-tables2 = "^2.7.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.2"
@@ -42,7 +43,7 @@ module = "tests.*"
 disallow_untyped_defs = false
 
 [[tool.mypy.overrides]]
-module = ["druncschema.*", "drunc.*"]
+module = ["druncschema.*", "drunc.*", "django_tables2.*"]
 ignore_missing_imports = true
 
 [tool.django-stubs]