labnotes 0.0.3__tar.gz → 0.0.5__tar.gz

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

@@ -1,11 +1,12 @@
 Metadata-Version: 2.5
 Name: labnotes
-Version: 0.0.3
+Version: 0.0.5
 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>
 License-Expression: MIT
 Requires-Python: >=3.12
+Requires-Dist: click>=8.5.0
 Requires-Dist: dirsql>=0.4.110
 Requires-Dist: jinja2>=3.1.6
 Requires-Dist: markdown-it-py>=4.2.0
@@ -37,5 +38,9 @@ shows new runs and edited notes.
 of values), `runs_per_cell`, and `completed_run`, a SQL condition over the
 `runs` table that marks a run as complete. Anything else shows up as-is.
 
-`--host` and `--port` change where it listens. `--json` prints the experiments
-as JSON and exits.
+`-h`/`--host` and `-p`/`--port` change where it listens; `-h 0.0.0.0` (or a
+Tailscale IP) serves beyond localhost. Every other uvicorn option passes
+through: `--reload`, `--workers`, `--proxy-headers`, `--root-path`, the
+`--ssl-*` set, and the rest. `labnotes --help` lists them. The folders can also
+come from `LABNOTES_EXPERIMENTS_FOLDER` and `LABNOTES_DATA_FOLDER`. `--json`
+prints the experiments as JSON and exits.

{labnotes-0.0.3 → labnotes-0.0.5}/README.md

@@ -21,5 +21,9 @@ shows new runs and edited notes.
 of values), `runs_per_cell`, and `completed_run`, a SQL condition over the
 `runs` table that marks a run as complete. Anything else shows up as-is.
 
-`--host` and `--port` change where it listens. `--json` prints the experiments
-as JSON and exits.
+`-h`/`--host` and `-p`/`--port` change where it listens; `-h 0.0.0.0` (or a
+Tailscale IP) serves beyond localhost. Every other uvicorn option passes
+through: `--reload`, `--workers`, `--proxy-headers`, `--root-path`, the
+`--ssl-*` set, and the rest. `labnotes --help` lists them. The folders can also
+come from `LABNOTES_EXPERIMENTS_FOLDER` and `LABNOTES_DATA_FOLDER`. `--json`
+prints the experiments as JSON and exits.

{labnotes-0.0.3 → labnotes-0.0.5}/pyproject.toml

@@ -11,6 +11,7 @@ requires-python = ">=3.12"
 license = "MIT"
 authors = [{ name = "Kevin Scott", email = "me@thekevinscott.com" }]
 dependencies = [
+    "click>=8.5.0",
     "dirsql>=0.4.110",
     "jinja2>=3.1.6",
     "markdown-it-py>=4.2.0",

labnotes-0.0.5/src/labnotes/cli.py

@@ -0,0 +1,69 @@
+import asyncio
+import json
+import os
+from pathlib import Path
+
+import click
+from uvicorn.main import main as uvicorn_main
+
+from labnotes.dump_experiments import dump_experiments
+from labnotes.serve_app import DATA_FOLDER, EXPERIMENTS_FOLDER
+
+# labnotes owns these; the rest of uvicorn's options pass straight through.
+OWN_OPTIONS = {"app", "factory", "app_dir", "version", "host", "port"}
+
+
+@click.command(help="Browse experiments and their run data.")
+@click.version_option(package_name="labnotes")
+@click.option(
+    "--experiments-folder",
+    type=click.Path(path_type=Path),
+    required=True,
+    envvar=EXPERIMENTS_FOLDER,
+    help="One subfolder per experiment, each with a design.yaml and markdown notes.",
+)
+@click.option(
+    "--data-folder",
+    type=click.Path(path_type=Path),
+    required=True,
+    envvar=DATA_FOLDER,
+    help="Run data, with a .dirsql.toml declaring a runs table that has a study column.",
+)
+@click.option(
+    "--json",
+    "as_json",
+    is_flag=True,
+    help="Print experiments as JSON instead of serving.",
+)
+@click.option(
+    "-h",
+    "--host",
+    default="127.0.0.1",
+    show_default=True,
+    help="Bind to this host. 0.0.0.0 or a Tailscale IP serves beyond localhost.",
+)
+@click.option("-p", "--port", type=int, default=8000, show_default=True)
+@click.pass_context
+def main(
+    ctx: click.Context,
+    experiments_folder: Path,
+    data_folder: Path,
+    as_json: bool,
+    **server_options: object,
+) -> None:
+    if as_json:
+        experiments = asyncio.run(dump_experiments(experiments_folder, data_folder))
+        click.echo(json.dumps(experiments, indent=2))
+        return
+    # Through the environment so --reload and --workers child processes see them.
+    os.environ[EXPERIMENTS_FOLDER] = str(experiments_folder.resolve())
+    os.environ[DATA_FOLDER] = str(data_folder.resolve())
+    ctx.invoke(
+        uvicorn_main,
+        app="labnotes.serve_app:serve_app",
+        factory=True,
+        **server_options,
+    )
+
+
+main.params += [p for p in uvicorn_main.params if p.name not in OWN_OPTIONS]

labnotes-0.0.5/src/labnotes/serve_app.py

@@ -0,0 +1,15 @@
+import os
+from pathlib import Path
+
+from starlette.applications import Starlette
+
+from labnotes.create_app import create_app
+
+EXPERIMENTS_FOLDER = "LABNOTES_EXPERIMENTS_FOLDER"
+DATA_FOLDER = "LABNOTES_DATA_FOLDER"
+
+
+def serve_app() -> Starlette:
+    return create_app(
+        Path(os.environ[EXPERIMENTS_FOLDER]), Path(os.environ[DATA_FOLDER])
+    )

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

@@ -163,7 +163,9 @@ 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: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; }
 

{labnotes-0.0.3 → labnotes-0.0.5}/uv.lock

@@ -209,6 +209,7 @@ wheels = [
 name = "labnotes"
 source = { editable = "." }
 dependencies = [
+    { name = "click" },
     { name = "dirsql" },
     { name = "jinja2" },
     { name = "markdown-it-py" },
@@ -228,6 +229,7 @@ dev = [
 
 [package.metadata]
 requires-dist = [
+    { name = "click", specifier = ">=8.5.0" },
     { name = "dirsql", specifier = ">=0.4.110" },
     { name = "jinja2", specifier = ">=3.1.6" },
     { name = "markdown-it-py", specifier = ">=4.2.0" },

labnotes-0.0.3/src/labnotes/cli.py

@@ -1,51 +0,0 @@
-import argparse
-import asyncio
-import json
-import sys
-from importlib.metadata import version
-from pathlib import Path
-
-import uvicorn
-
-from labnotes.create_app import create_app
-from labnotes.dump_experiments import dump_experiments
-
-
-def main(argv: list[str] | None = None) -> None:
-    parser = argparse.ArgumentParser(
-        prog="labnotes", description="Browse experiments and their run data."
-    )
-    parser.add_argument("--version", action="version", version=version("labnotes"))
-    parser.add_argument(
-        "--experiments-folder",
-        type=Path,
-        required=True,
-        help="one subfolder per experiment, each with a design.yaml and markdown notes",
-    )
-    parser.add_argument(
-        "--data-folder",
-        type=Path,
-        required=True,
-        help="run data, with a .dirsql.toml declaring a runs table that has a study column",
-    )
-    parser.add_argument("--host", default="127.0.0.1")
-    parser.add_argument("--port", type=int, default=8000)
-    parser.add_argument(
-        "--json",
-        action="store_true",
-        help="print experiments as JSON instead of serving",
-    )
-    args = parser.parse_args(argv)
-    if args.json:
-        experiments = asyncio.run(
-            dump_experiments(args.experiments_folder, args.data_folder)
-        )
-        print(json.dumps(experiments, indent=2))
-        return
-    print(f"labnotes at http://{args.host}:{args.port}", file=sys.stderr)
-    uvicorn.run(
-        create_app(args.experiments_folder, args.data_folder),
-        host=args.host,
-        port=args.port,
-        log_level="warning",
-    )