calkit-python 0.41.10__tar.gz → 0.41.11__tar.gz

{calkit_python-0.41.10 → calkit_python-0.41.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: calkit-python
-Version: 0.41.10
+Version: 0.41.11
 Summary: Reproducibility simplified.
 Project-URL: Homepage, https://calkit.org
 Project-URL: Issues, https://github.com/calkit/calkit/issues

calkit_python-0.41.11/calkit/cli/describe.py

@@ -0,0 +1,63 @@
+"""CLI for describing things."""
+
+from __future__ import annotations
+
+import json
+from typing import Annotated
+
+import typer
+
+import calkit
+from calkit.cli import raise_error
+from calkit.environments import get_env_lock_fpath
+
+describe_app = typer.Typer(no_args_is_help=True)
+
+
+@describe_app.command(name="system")
+def describe_system():
+    """Describe the system."""
+    system_info = calkit.get_system_info()
+    typer.echo(json.dumps(system_info, indent=2))
+
+
+@describe_app.command(name="env")
+def describe_env(
+    name: Annotated[
+        str,
+        typer.Option("--name", "-n", help="Environment name."),
+    ],
+):
+    """Describe a single environment, including spec and lock file paths."""
+    ck_info = calkit.load_calkit_info()
+    envs: dict = ck_info.get("environments", {})
+    if name not in envs:
+        raise_error(f"Environment '{name}' not found.")
+    env = envs[name]
+    lock_path = get_env_lock_fpath(env=env, env_name=name)
+    result = {
+        "kind": env.get("kind"),
+        "spec_path": env.get("path"),
+        "lock_path": lock_path,
+        "prefix": env.get("prefix"),
+        "python": env.get("python"),
+    }
+    typer.echo(json.dumps(result, indent=2))
+
+
+@describe_app.command(name="envs")
+def describe_envs():
+    """Describe all environments, including spec and lock file paths."""
+    ck_info = calkit.load_calkit_info()
+    envs: dict = ck_info.get("environments", {})
+    result = {}
+    for env_name, env in envs.items():
+        lock_path = get_env_lock_fpath(env=env, env_name=env_name)
+        result[env_name] = {
+            "kind": env.get("kind"),
+            "spec_path": env.get("path"),
+            "lock_path": lock_path,
+            "prefix": env.get("prefix"),
+            "python": env.get("python"),
+        }
+    typer.echo(json.dumps(result, indent=2))

{calkit_python-0.41.10 → calkit_python-0.41.11}/calkit/cli/list.py

@@ -7,7 +7,7 @@ from typing import Annotated, Literal
 import typer
 
 import calkit
-from calkit.cli import AliasGroup, warn
+from calkit.cli import AliasGroup, raise_error, warn
 
 list_app = typer.Typer(cls=AliasGroup, no_args_is_help=True)
 
@@ -167,12 +167,28 @@ def list_stages(
         list[str] | None,
         typer.Option("--kind", "-k", help="Filter stages by kind."),
     ] = None,
+    stale_only: Annotated[
+        bool, typer.Option("--stale", help="Show only stale stages.")
+    ] = False,
 ):
     """List pipeline stages."""
-    stages = calkit.load_calkit_info().get("pipeline", {}).get("stages", {})
+    ck_info = calkit.load_calkit_info()
+    stages = ck_info.get("pipeline", {}).get("stages", {})
+    # If we only want stale stages, we need to get the status first.
+    # This compiles the pipeline, cleans notebooks, and checks environments,
+    # all of which can affect whether a stage is stale, so we don't skip them.
+    if stale_only:
+        status = calkit.pipeline.get_status(ck_info=ck_info)
+        if status.errors:
+            raise_error(
+                "Failed to determine stale stages: " + "; ".join(status.errors)
+            )
+        stale_stage_names = status.stale_stage_names
     for name, stage in stages.items():
         if kinds is not None and stage.get("kind") not in kinds:
             continue
+        if stale_only and name not in stale_stage_names:
+            continue
         typer.echo(name)
 
 

{calkit_python-0.41.10 → calkit_python-0.41.11}/calkit/cli/main/core.py

@@ -196,7 +196,12 @@ def init(
     repo = calkit.git.get_repo()
     repo.git.add(".dvc")
     repo.git.commit("-m", "Initialize DVC")
-    # TODO: Initialize `calkit.yaml`
+    # Create an empty calkit.yaml if one doesn't already exist
+    if not os.path.isfile("calkit.yaml"):
+        with open("calkit.yaml", "w"):
+            pass
+        repo.git.add("calkit.yaml")
+        repo.git.commit("-m", "Initialize Calkit")
     # TODO: Initialize `dvc.yaml`
     # TODO: Add a sane .gitignore file
     # TODO: Add a sane LICENSE file?