labnotes 0.0.5__tar.gz → 0.0.7__tar.gz

{labnotes-0.0.5 → labnotes-0.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: labnotes
-Version: 0.0.5
+Version: 0.0.7
 Summary: Browse experiment designs, notes, and run data from a folder.
 Project-URL: Repository, https://github.com/thekevinscott/labnotes
 Author-email: Kevin Scott <me@thekevinscott.com>

{labnotes-0.0.5 → labnotes-0.0.7}/src/labnotes/create_app.py

@@ -52,7 +52,10 @@ def create_app(experiments_folder: Path, data_folder: Path) -> Starlette:
     async def experiment(request: Request) -> Response:
         state = request.app.state
         loaded = await load_experiment(
-            state.experiments, state.runs, request.path_params["name"]
+            state.experiments,
+            state.runs,
+            request.path_params["name"],
+            request.query_params,
         )
         if loaded is None:
             raise HTTPException(404, "No such experiment")

labnotes-0.0.7/src/labnotes/list_runs.py

@@ -0,0 +1,29 @@
+from dirsql import DirSQL
+
+from labnotes.models import RunView
+from labnotes.sql_quote import quote_identifier, quote_string
+
+
+async def list_runs(
+    runs: DirSQL, study: str, completed_run: str, view: RunView
+) -> list[dict[str, object]]:
+    where = [f"study = {quote_string(study)}"]
+    if view.status:
+        negate = {"complete": "", "incomplete": "NOT "}[view.status]
+        where.append(f"{negate}({completed_run})")
+    where += [
+        f"instr(lower(CAST({quote_identifier(column)} AS TEXT)),"
+        f" lower({quote_string(value)})) > 0"
+        for column, value in view.filters.items()
+    ]
+    direction = "DESC" if view.descending else "ASC"
+    if view.sort == "status":
+        order = f"labnotes_completed {direction}"
+    elif view.sort:
+        order = f"{quote_identifier(view.sort)} {direction}"
+    else:
+        order = "2 DESC"
+    return await runs.query(
+        f"SELECT ({completed_run}) AS labnotes_completed, * FROM runs"
+        f" WHERE {' AND '.join(where)} ORDER BY {order}"
+    )

{labnotes-0.0.5 → labnotes-0.0.7}/src/labnotes/load_experiment.py

@@ -1,18 +1,21 @@
 import json
+from collections.abc import Mapping
 from typing import cast
 
 from dirsql import DirSQL
 
 from labnotes.list_runs import list_runs
+from labnotes.parse_run_view import parse_run_view
 from labnotes.render_markdown import render_markdown
 from labnotes.run_columns import run_columns
+from labnotes.sort_href import sort_href
 from labnotes.sql_quote import quote_string
 from labnotes.study_progress import study_progress
 from labnotes.summarize_design import summarize_design
 
 
 async def load_experiment(
-    experiments: DirSQL, runs: DirSQL, name: str
+    experiments: DirSQL, runs: DirSQL, name: str, params: Mapping[str, str]
 ) -> dict[str, object] | None:
     found = await experiments.query(
         f"SELECT name, study, design FROM experiments WHERE name = {quote_string(name)}"
@@ -29,10 +32,12 @@ async def load_experiment(
     study = None if row["study"] is None else str(row["study"])
     columns = await run_columns(runs)
     progress = await study_progress(runs, study, summary, columns)
+    shown = columns[:1] + [key for key in varies if key in columns[1:]]
+    view = parse_run_view(params, shown)
     listed = (
         []
         if study is None
-        else await list_runs(runs, study, str(summary["completed_run"]))
+        else await list_runs(runs, study, str(summary["completed_run"]), view)
     )
     return {
         "name": row["name"],
@@ -44,5 +49,9 @@ async def load_experiment(
             for note in notes
         ],
         "runs_list": listed,
-        "run_columns": columns[:1] + [key for key in varies if key in columns[1:]],
+        "run_columns": shown,
+        "run_view": view,
+        "sort_hrefs": {
+            column: sort_href(view, column) for column in ["status", *shown]
+        },
     }

labnotes-0.0.7/src/labnotes/models.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass, field
+
+
+@dataclass(frozen=True)
+class RunView:
+    sort: str | None = None
+    descending: bool = False
+    status: str | None = None
+    filters: dict[str, str] = field(default_factory=dict)

labnotes-0.0.7/src/labnotes/parse_run_view.py

@@ -0,0 +1,20 @@
+from collections.abc import Mapping
+
+from labnotes.models import RunView
+
+STATUSES = {"complete", "incomplete"}
+
+
+def parse_run_view(params: Mapping[str, str], columns: list[str]) -> RunView:
+    sort = params.get("sort")
+    status = params.get("status")
+    return RunView(
+        sort=sort if sort in columns or sort == "status" else None,
+        descending=params.get("order") == "desc",
+        status=status if status in STATUSES else None,
+        filters={
+            column: value
+            for column in columns
+            if (value := params.get(f"f.{column}", "").strip())
+        },
+    )

labnotes-0.0.7/src/labnotes/sort_href.py

@@ -0,0 +1,13 @@
+from urllib.parse import urlencode
+
+from labnotes.models import RunView
+
+
+def sort_href(view: RunView, column: str) -> str:
+    params = {"sort": column}
+    if view.sort == column and not view.descending:
+        params["order"] = "desc"
+    if view.status:
+        params["status"] = view.status
+    params.update({f"f.{name}": value for name, value in view.filters.items()})
+    return f"?{urlencode(params)}#runs"

{labnotes-0.0.5 → labnotes-0.0.7}/src/labnotes/static/labnotes.css

@@ -163,9 +163,8 @@ h3 {
 }
 .ledger td { padding: 1.1rem 1.25rem; border-bottom: 1px solid var(--rule); vertical-align: middle; }
 .ledger tbody tr:last-child td { border-bottom: 0; }
-.ledger tbody tr { position: relative; cursor: pointer; }
+.ledger tbody tr { cursor: pointer; }
 .ledger tbody tr:hover { background: color-mix(in srgb, var(--accent) 4%, transparent); }
-.ledger .title-link::after { content: ""; position: absolute; inset: 0; }
 .ledger .num { text-align: right; }
 .ledger th.num { text-align: right; }
 
@@ -291,14 +290,14 @@ h3 {
 
 /* Runs */
 .runs {
-  --row: 1.5rem repeat(var(--columns), minmax(0, 1fr));
+  --row: 2.75rem repeat(var(--columns), minmax(0, 1fr));
   background: var(--surface);
   border: 1px solid var(--rule);
   border-radius: 10px;
   overflow: hidden;
   font-size: 0.86rem;
 }
-.run-head, .run summary {
+.run-head, .run summary, .run-filters {
   display: grid;
   grid-template-columns: var(--row);
   gap: 1rem;
@@ -313,6 +312,25 @@ h3 {
   color: var(--ink-3);
   border-bottom: 1px solid var(--rule);
 }
+.run-head .sort { color: inherit; text-decoration: none; white-space: nowrap; overflow: hidden; text-overflow: ellipsis; }
+.run-head .sort:hover, .run-head .sorted { color: var(--ink); }
+.run-head .arrow { margin-left: 0.3rem; color: var(--accent); }
+.run-filters { padding-top: 0.5rem; padding-bottom: 0.5rem; border-bottom: 1px solid var(--rule); background: var(--paper); }
+.run-filters input, .run-filters select {
+  width: 100%;
+  min-width: 0;
+  font: inherit;
+  font-size: 0.82rem;
+  padding: 0.2rem 0.45rem;
+  color: var(--ink);
+  background: var(--surface);
+  border: 1px solid var(--rule);
+  border-radius: 5px;
+}
+.run-filters select { padding: 0.2rem 0; }
+.run-filters input:focus, .run-filters select:focus { outline: none; border-color: var(--accent); }
+.run-empty { margin: 0; padding: 1rem 1.25rem; }
+h2 .clear { font-family: var(--sans); font-size: 0.82rem; margin-left: 0.8rem; color: var(--ink-3); }
 .run { border-bottom: 1px solid var(--rule); }
 .run:last-child { border-bottom: 0; }
 .run summary { cursor: pointer; list-style: none; }
@@ -338,6 +356,49 @@ h3 {
 .record code { background: none; padding: 0; word-break: break-word; }
 .record pre { margin: 0; white-space: pre-wrap; word-break: break-word; max-height: 22rem; overflow: auto; font-size: 0.78rem; color: var(--ink-2); }
 
+/* Index view toggle */
+.view-toggle {
+  float: right;
+  display: inline-flex;
+  margin-top: 0.6rem;
+  border: 1px solid var(--rule-strong);
+  border-radius: 7px;
+  overflow: hidden;
+}
+.view-toggle button {
+  font: inherit;
+  font-size: 0.82rem;
+  padding: 0.3rem 0.8rem;
+  border: 0;
+  background: var(--surface);
+  color: var(--ink-2);
+  cursor: pointer;
+}
+.view-toggle button + button { border-left: 1px solid var(--rule-strong); }
+.view-toggle button[aria-pressed="true"] { background: var(--accent-soft); color: var(--ink); }
+
+/* Index as cards: the same table, laid out as a grid. */
+.ledger[data-view="cards"] { display: block; background: none; border: 0; border-radius: 0; overflow: visible; }
+.ledger[data-view="cards"] thead { display: none; }
+.ledger[data-view="cards"] tbody {
+  display: grid;
+  grid-template-columns: repeat(auto-fill, minmax(17rem, 1fr));
+  gap: 1rem;
+}
+.ledger[data-view="cards"] tbody tr {
+  display: flex;
+  flex-direction: column;
+  gap: 0.7rem;
+  padding: 1.1rem 1.25rem;
+  background: var(--surface);
+  border: 1px solid var(--rule);
+  border-radius: 10px;
+}
+.ledger[data-view="cards"] tbody tr:hover { background: var(--surface); border-color: var(--accent); }
+.ledger[data-view="cards"] td { display: block; padding: 0; border: 0; text-align: left; }
+.ledger[data-view="cards"] .progress-col { width: auto; }
+.ledger[data-view="cards"] td[data-label]::before { content: attr(data-label) " "; color: var(--ink-3); font-size: 0.82rem; }
+
 @media (max-width: 52rem) {
   main, .masthead { padding-left: 1.1rem; padding-right: 1.1rem; }
   h1 { font-size: 2rem; }

labnotes-0.0.7/src/labnotes/static/row-link.js

@@ -0,0 +1,9 @@
+// Safari ignores position: relative on <tr>, so a stretched ::after link covers the whole page.
+for (const row of document.querySelectorAll(".ledger tbody tr")) {
+  const link = row.querySelector(".title-link");
+  row.addEventListener("click", (event) => {
+    if (event.target.closest("a") || getSelection().toString()) return;
+    if (event.metaKey || event.ctrlKey) window.open(link.href, "_blank");
+    else location.href = link.href;
+  });
+}

labnotes-0.0.7/src/labnotes/static/view-toggle.js

@@ -0,0 +1,15 @@
+const ledger = document.querySelector(".ledger");
+const buttons = document.querySelectorAll(".view-toggle button");
+
+function show(view) {
+  ledger.dataset.view = view;
+  for (const button of buttons) {
+    button.setAttribute("aria-pressed", String(button.dataset.view === view));
+  }
+  localStorage.setItem("labnotes.view", view);
+}
+
+for (const button of buttons) {
+  button.addEventListener("click", () => show(button.dataset.view));
+}
+show(localStorage.getItem("labnotes.view") ?? "table");

{labnotes-0.0.5 → labnotes-0.0.7}/src/labnotes/templates/experiment.html

@@ -121,13 +121,29 @@
 
 {% if e.study %}
 <section id="runs" class="block">
-  <h2>Runs <span class="count num">{{ e.runs_list | length }}</span></h2>
-  {% if e.runs_list %}
+  {% set view = e.run_view %}
+  {% set narrowed = view.status or view.filters %}
+  <h2>Runs <span class="count num">{{ e.runs_list | length }}{% if narrowed %} of {{ e.runs }}{% endif %}</span>
+    {% if narrowed %}<a class="clear" href="{{ '?sort=' ~ (view.sort | urlencode) ~ ('&order=desc' if view.descending else '') if view.sort else '?' }}#runs">Clear filters</a>{% endif %}</h2>
+  {% if e.runs %}
   <div class="runs" style="--columns: {{ e.run_columns | length }}">
     <div class="run-head">
-      <span></span>
-      {% for column in e.run_columns %}<span>{{ column }}</span>{% endfor %}
+      {% for column in ['status'] + e.run_columns %}
+      {% set sorted = view.sort == column %}
+      <a class="sort{{ ' sorted' if sorted }}" href="{{ e.sort_hrefs[column] }}"{% if sorted %} aria-sort="{{ 'descending' if view.descending else 'ascending' }}"{% endif %} title="Sort by {{ column }}">{{ '' if column == 'status' else column }}{% if sorted %}<span class="arrow">{{ '↓' if view.descending else '↑' }}</span>{% endif %}</a>
+      {% endfor %}
     </div>
+    <form class="run-filters" method="get" action="#runs">
+      {% if view.sort %}<input type="hidden" name="sort" value="{{ view.sort }}">{% endif %}
+      {% if view.descending %}<input type="hidden" name="order" value="desc">{% endif %}
+      <select name="status" aria-label="Filter by status" onchange="this.form.requestSubmit()">
+        <option value=""{{ ' selected' if not view.status }}>all</option>
+        <option value="complete"{{ ' selected' if view.status == 'complete' }}>✓</option>
+        <option value="incomplete"{{ ' selected' if view.status == 'incomplete' }}>✕</option>
+      </select>
+      {% for column in e.run_columns %}<input type="search" name="f.{{ column }}" value="{{ view.filters.get(column, '') }}" placeholder="filter" aria-label="Filter {{ column }}">{% endfor %}
+      <button type="submit" hidden>Filter</button>
+    </form>
     {% for run in e.runs_list %}
     <details class="run">
       <summary>
@@ -142,6 +158,8 @@
         {% endfor %}
       </dl>
     </details>
+    {% else %}
+    <p class="empty run-empty">No runs match these filters.</p>
     {% endfor %}
   </div>
   {% else %}

{labnotes-0.0.5 → labnotes-0.0.7}/src/labnotes/templates/index.html

@@ -3,13 +3,19 @@
 {% block crumbs %}<span class="crumb">{{ folder }}</span>{% endblock %}
 {% block main %}
 <section class="intro">
+  {% if experiments %}
+  <div class="view-toggle" role="group" aria-label="View">
+    <button type="button" data-view="table" aria-pressed="true">Table</button>
+    <button type="button" data-view="cards" aria-pressed="false">Cards</button>
+  </div>
+  {% endif %}
   <h1>Experiments</h1>
   <p class="lede">{{ experiments | length }} experiment{{ '' if experiments | length == 1 else 's' }},
     {{ experiments | sum(attribute='runs') }} runs recorded.</p>
 </section>
 
 {% if experiments %}
-<table class="ledger">
+<table class="ledger" data-view="table">
   <thead>
     <tr>
       <th scope="col">Experiment</th>
@@ -29,7 +35,7 @@
         {% for key, values in experiment.varies.items() %}<span class="factor">{{ key }} <b>{{ values | length }}</b>{% if not loop.last or experiment.runs_per_cell %}<span class="times">×</span>{% endif %}</span> {% endfor %}
         {% if experiment.runs_per_cell %}<span class="factor">runs <b>{{ experiment.runs_per_cell }}</b></span>{% endif %}
       </td>
-      <td class="num">{{ experiment.runs }}</td>
+      <td class="num" data-label="Runs">{{ experiment.runs }}</td>
       <td class="progress-col">
         {% if experiment.filled is not none and experiment.target %}
         <div class="progress-line">
@@ -43,6 +49,8 @@
     {% endfor %}
   </tbody>
 </table>
+<script src="{{ url_for('static', path='view-toggle.js') }}" defer></script>
+<script src="{{ url_for('static', path='row-link.js') }}" defer></script>
 {% else %}
 <p class="empty">No experiments found. Each experiment is a folder holding a <code>design.yaml</code> and its markdown notes.</p>
 {% endif %}

labnotes-0.0.5/src/labnotes/list_runs.py

@@ -1,12 +0,0 @@
-from dirsql import DirSQL
-
-from labnotes.sql_quote import quote_string
-
-
-async def list_runs(
-    runs: DirSQL, study: str, completed_run: str
-) -> list[dict[str, object]]:
-    return await runs.query(
-        f"SELECT ({completed_run}) AS labnotes_completed, * FROM runs"
-        f" WHERE study = {quote_string(study)} ORDER BY 2 DESC"
-    )