labnotes 0.0.17__tar.gz → 0.0.18__tar.gz

{labnotes-0.0.17 → labnotes-0.0.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: labnotes
-Version: 0.0.17
+Version: 0.0.18
 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>
@@ -69,6 +69,10 @@ labnotes experiments foo runs   # foo's runs, oldest first
 
 Each takes `--format table` (the default) or `--format json`.
 
+`labnotes experiments new [NAME]` creates an experiment folder with a starter
+`experiment.toml`, picking a random name if you give none. `new` itself can't
+be an experiment name.
+
 `labnotes experiments foo run` runs `foo` from its `experiment.toml`, in the
 experiments folder:
 

{labnotes-0.0.17 → labnotes-0.0.18}/README.md

@@ -46,6 +46,10 @@ labnotes experiments foo runs   # foo's runs, oldest first
 
 Each takes `--format table` (the default) or `--format json`.
 
+`labnotes experiments new [NAME]` creates an experiment folder with a starter
+`experiment.toml`, picking a random name if you give none. `new` itself can't
+be an experiment name.
+
 `labnotes experiments foo run` runs `foo` from its `experiment.toml`, in the
 experiments folder:
 

{labnotes-0.0.17 → labnotes-0.0.18}/src/labnotes/context.md

@@ -36,6 +36,10 @@ labnotes experiments foo runs   # foo's runs, oldest first
 
 Each takes `--format table` (the default) or `--format json`; use `--format json` when you parse the output.
 
+`labnotes experiments new [NAME]` creates an experiment folder with a starter
+`experiment.toml`, picking a random name if you give none. `new` itself can't
+be an experiment name.
+
 `labnotes experiments foo run` runs `foo` from its `experiment.toml`, in the
 experiments folder:
 

labnotes-0.0.18/src/labnotes/create_experiment.py

@@ -0,0 +1,32 @@
+from pathlib import Path
+
+from labnotes.models import LabnotesConfig
+from labnotes.runner.new_run_id import new_run_id
+
+STARTER = """\
+# Runs from the project root. {run_dir} becomes the run's folder.
+command = "uv run script.py --output {run_dir}"
+repeats = 1
+
+# Each combination runs `repeats` times, passed as --name value.
+[params]
+# model = ["opus", "sonnet"]
+"""
+
+
+def create_experiment(config: LabnotesConfig, name: str | None) -> Path:
+    def folder(candidate: str) -> Path:
+        return config.root / config.experiments.replace("{experiment}", candidate)
+
+    if name is None:
+        name = new_run_id(lambda candidate: folder(candidate).exists())
+    if name == "new":
+        raise ValueError("new is reserved; pick another name.")
+    if "/" in name or name.startswith("."):
+        raise ValueError(f"{name} can't be an experiment name.")
+    path = folder(name)
+    if path.exists():
+        raise ValueError(f"{name} already exists at {path}.")
+    path.mkdir(parents=True)
+    (path / "experiment.toml").write_text(STARTER, encoding="utf-8")
+    return path

{labnotes-0.0.17 → labnotes-0.0.18}/src/labnotes/experiments.py

@@ -4,6 +4,7 @@ from pathlib import Path
 
 import click
 
+from labnotes.create_experiment import create_experiment
 from labnotes.load_config import load_config
 from labnotes.print_rows import print_rows
 from labnotes.read_config import CONFIG_FILE
@@ -13,9 +14,12 @@ from labnotes.tables.experiment_rows import experiment_rows
 from labnotes.tui.run_tui import run_tui
 
 
-@click.command(help="List experiments, show one, list its runs, or run it.")
+@click.command(
+    help="List experiments, show one, list its runs, or run it."
+    " `new [NAME]` creates one."
+)
 @click.argument("name", required=False)
-@click.argument("action", required=False, type=click.Choice(["runs", "run"]))
+@click.argument("action", required=False, metavar="[runs|run]")
 @click.option(
     "--format",
     "output_format",
@@ -57,6 +61,13 @@ def experiments(
             f"No {CONFIG_FILE} here. Run labnotes init, or pass -c PATH."
         )
     match name, action:
+        case "new", _:
+            try:
+                path = create_experiment(config, action)
+            except ValueError as error:
+                raise click.ClickException(str(error)) from error
+            click.echo(f"Created {path / 'experiment.toml'}")
+            return
         case str(), "run":
             live = sys.stdout.isatty() and sys.stderr.isatty() and not no_tui
             drive = run_tui if live else lambda start, title: run_headless(start)
@@ -69,6 +80,8 @@ def experiments(
             failed = sum(result["exit_code"] != 0 for result in results)
             click.echo(f"{len(results) - failed} passed, {failed} failed.")
             ctx.exit(1 if failed else 0)
+    if action not in (None, "runs"):
+        raise click.UsageError(f"Unknown action {action}. Use runs or run.")
     rows = asyncio.run(experiment_rows(config, name, action))
     if rows is None:
         raise click.ClickException(f"No experiment named {name}.")