calkit-python 0.0.8__tar.gz → 0.0.9__tar.gz

{calkit_python-0.0.8 → calkit_python-0.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: calkit-python
-Version: 0.0.8
+Version: 0.0.9
 Summary: Reproducibility simplified.
 Project-URL: Homepage, https://github.com/calkit/calkit
 Project-URL: Issues, https://github.com/calkit/calkit/issues

{calkit_python-0.0.8 → calkit_python-0.0.9}/calkit/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.0.8"
+__version__ = "0.0.9"
 
 from .core import *
 from . import git

calkit_python-0.0.9/calkit/cli/list.py

@@ -0,0 +1,70 @@
+"""CLI for listing objects."""
+
+from __future__ import annotations
+
+from typing import Literal
+
+import typer
+
+import calkit
+
+list_app = typer.Typer(no_args_is_help=True)
+
+
+def _list_objects(
+    kind: Literal[
+        "notebooks", "datasets", "figures", "references", "publications"
+    ]
+):
+    """List objects.
+
+    TODO: This should probably just use some library to dump YAML to string.
+    """
+    ck_info = calkit.load_calkit_info()
+    objects = ck_info.get(kind, [])
+    for obj in objects:
+        path = obj.pop("path")
+        typer.echo(f"- path: {path}")
+        for k, v in obj.items():
+            if isinstance(v, dict):
+                typer.echo(f"    {k}:")
+                for k1, v1 in v.items():
+                    typer.echo(f"      {k1}: {v1}")
+            elif isinstance(v, list):
+                typer.echo(f"    {k}:")
+                for item in v:
+                    if isinstance(item, dict):
+                        for n, (k1, v1) in enumerate(item.items()):
+                            if n == 0:
+                                typer.echo(f"      - {k1}: {v1}")
+                            else:
+                                typer.echo(f"        {k1}: {v1}")
+                    else:
+                        typer.echo(f"        - {item}")
+            else:
+                typer.echo(f"  {k}: {v}")
+
+
+@list_app.command(name="notebooks")
+def list_notebooks():
+    _list_objects("notebooks")
+
+
+@list_app.command(name="figures")
+def list_figures():
+    _list_objects("figures")
+
+
+@list_app.command(name="datasets")
+def list_datasets():
+    _list_objects("datasets")
+
+
+@list_app.command(name="publications")
+def list_publications():
+    _list_objects("publications")
+
+
+@list_app.command(name="references")
+def list_references():
+    _list_objects("references")

{calkit_python-0.0.8 → calkit_python-0.0.9}/calkit/cli/main.py

@@ -11,6 +11,7 @@ from typing_extensions import Annotated, Optional
 import calkit
 from calkit.cli import print_sep, run_cmd
 from calkit.cli.config import config_app
+from calkit.cli.list import list_app
 from calkit.cli.new import new_app
 from calkit.cli.notebooks import notebooks_app
 
@@ -25,6 +26,7 @@ app.add_typer(
     new_app, name="new", help="Add new Calkit object (to calkit.yaml)."
 )
 app.add_typer(notebooks_app, name="nb", help="Work with Jupyter notebooks.")
+app.add_typer(list_app, name="list", help="List Calkit objects.")
 
 
 @app.callback()
@@ -293,11 +295,7 @@ def run_dvc_repro(
                 )
     # Now that we've extracted Calkit objects from stage metadata, we can put
     # them into the calkit.yaml file, overwriting objects with the same path
-    if os.path.isfile("calkit.yaml"):
-        with open("calkit.yaml") as f:
-            ck_info = calkit.ryaml.load(f)
-    else:
-        ck_info = {}
+    ck_info = calkit.load_calkit_info()
     for obj in objects:
         cktype = obj.pop("type")
         cktype_plural = cktype + "s"

{calkit_python-0.0.8 → calkit_python-0.0.9}/calkit/cli/new.py

@@ -8,6 +8,7 @@ import git
 import typer
 from typing_extensions import Annotated
 
+import calkit
 from calkit.core import ryaml
 
 new_app = typer.Typer(no_args_is_help=True)
@@ -21,11 +22,7 @@ def new_figure(
     commit: Annotated[bool, typer.Option("--commit")] = False,
 ):
     """Add a new figure."""
-    if os.path.isfile("calkit.yaml"):
-        with open("calkit.yaml") as f:
-            ck_info = ryaml.load(f)
-    else:
-        ck_info = {}
+    ck_info = calkit.load_calkit_info()
     figures = ck_info.get("figures", [])
     paths = [f.get("path") for f in figures]
     if path in paths:
@@ -49,11 +46,7 @@ def new_question(
     commit: Annotated[bool, typer.Option("--commit")] = False,
 ):
     """Add a new question."""
-    if os.path.isfile("calkit.yaml"):
-        with open("calkit.yaml") as f:
-            ck_info = ryaml.load(f)
-    else:
-        ck_info = {}
+    ck_info = calkit.load_calkit_info()
     questions = ck_info.get("questions", [])
     if question in questions:
         raise ValueError("Question already exists")
@@ -85,11 +78,7 @@ def new_notebook(
         raise ValueError("Path does not have .ipynb extension")
     # TODO: Add option to create stages that run `calkit nb clean` and
     # `calkit nb execute`
-    if os.path.isfile("calkit.yaml"):
-        with open("calkit.yaml") as f:
-            ck_info = ryaml.load(f)
-    else:
-        ck_info = {}
+    ck_info = calkit.load_calkit_info()
     notebooks = ck_info.get("notebooks", [])
     paths = [f.get("path") for f in notebooks]
     if path in paths:

{calkit_python-0.0.8 → calkit_python-0.0.9}/calkit/core.py

@@ -44,3 +44,10 @@ def find_project_dirs(relative=False, max_depth=3) -> list[str]:
             continue
         final_res.append(path)
     return final_res
+
+
+def load_calkit_info() -> dict:
+    if os.path.isfile("calkit.yaml"):
+        with open("calkit.yaml") as f:
+            return ryaml.load(f)
+    return {}