calkit-python 0.35.1__tar.gz → 0.35.2__tar.gz

{calkit_python-0.35.1 → calkit_python-0.35.2}/PKG-INFO

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

{calkit_python-0.35.1 → calkit_python-0.35.2}/calkit/cli/main.py

@@ -1472,6 +1472,12 @@ def run_in_env(
     if env["kind"] == "docker":
         if "image" not in env:
             raise_error("Image must be defined for Docker environments")
+        command_mode = env.get("command_mode", "shell")
+        if command_mode not in ["shell", "entrypoint"]:
+            raise_error(
+                "Invalid Docker environment 'command_mode': "
+                f"{command_mode}; Use 'shell' or 'entrypoint'"
+            )
         if not no_check:
             check_docker_env(
                 tag=env["image"],
@@ -1489,7 +1495,6 @@ def run_in_env(
                 args=env.get("args", []),
                 quiet=not verbose,
             )
-        shell_cmd = _to_shell_cmd(cmd)
         docker_cmd = [
             "docker",
             "run",
@@ -1536,10 +1541,17 @@ def run_in_env(
             "-v",
             f"{os.getcwd()}:{docker_wdir_mount}",
             image_name,
-            shell,
-            "-c",
-            shell_cmd,
         ]
+        if command_mode == "shell":
+            shell_cmd = _to_shell_cmd(cmd)
+            docker_cmd += [shell, "-c", shell_cmd]
+        else:
+            if not cmd:
+                raise_error(
+                    "No command provided for Docker environment in "
+                    "'entrypoint' command mode"
+                )
+            docker_cmd += cmd
         if verbose:
             typer.echo(f"Running command: {docker_cmd}")
         try:

{calkit_python-0.35.1 → calkit_python-0.35.2}/calkit/cli/new.py

@@ -650,6 +650,17 @@ def new_docker_env(
     wdir: Annotated[
         str, typer.Option("--wdir", help="Working directory.")
     ] = "/work",
+    command_mode: Annotated[
+        str,
+        typer.Option(
+            "--command-mode",
+            help=(
+                "How to execute commands in the container: "
+                "'shell' runs shell -c, 'entrypoint' passes args "
+                "directly to the image entrypoint."
+            ),
+        ),
+    ] = "shell",
     user: Annotated[
         str | None,
         typer.Option(
@@ -703,6 +714,8 @@ def new_docker_env(
         )
         _, project_name = calkit.detect_project_name().split("/")
         image_name = f"{project_name}-{name}"
+    if command_mode not in ["shell", "entrypoint"]:
+        raise_error("--command-mode must be one of: shell, entrypoint")
     repo = git.Repo()
     if base and path is not None:
         txt = "FROM " + base + "\n\n"
@@ -746,6 +759,8 @@ def new_docker_env(
         env["user"] = user
     if gpus:
         env["gpus"] = gpus
+    if command_mode != "shell":
+        env["command_mode"] = command_mode
     if env_vars:
         env["env_vars"] = {}  # type: ignore
         for var in env_vars:

{calkit_python-0.35.1 → calkit_python-0.35.2}/calkit/models/core.py

@@ -110,6 +110,7 @@ class DockerEnvironment(Environment):
     image: str
     layers: list[str] | None = None
     shell: Literal["bash", "sh"] = "sh"
+    command_mode: Literal["shell", "entrypoint"] = "shell"
     platform: str | None = None
 
 

{calkit_python-0.35.1 → calkit_python-0.35.2}/calkit/models/pipeline.py

@@ -611,6 +611,15 @@ class DockerCommandStage(Stage):
         return self.command
 
 
+class CommandStage(Stage):
+    kind: Literal["command"] = "command"
+    command: str
+
+    @property
+    def dvc_cmd(self) -> str:
+        return f"{self.xenv_cmd} {self.command}"
+
+
 class RScriptStage(Stage):
     kind: Literal["r-script"]
     script_path: RelativeChildPathString
@@ -919,6 +928,7 @@ class Pipeline(BaseModel):
                 | ShellCommandStage
                 | ShellScriptStage
                 | DockerCommandStage
+                | CommandStage
                 | RScriptStage
                 | WordToPdfStage
                 | JupyterNotebookStage

{calkit_python-0.35.1 → calkit_python-0.35.2}/docs/environments.md

@@ -173,6 +173,30 @@ You can similarly jump into an interactive `bash` terminal with:
 calkit xenv -n foam bash
 ```
 
+Some Docker images are CLI tools with an image entrypoint already defined
+(for example `minlag/mermaid-cli`).
+In that case, use `command_mode: entrypoint` so Calkit passes your command
+arguments directly to the container entrypoint instead of running
+`shell -c ...`.
+
+```yaml
+# In calkit.yaml
+environments:
+  mermaid:
+    kind: docker
+    image: minlag/mermaid-cli
+    wdir: /data
+    command_mode: entrypoint
+```
+
+Then execute with:
+
+```sh
+calkit xenv -n mermaid -- \
+  -i figures/my-mermaid-diagram.mmd \
+  -o figures/my-mermaid-diagram.pdf
+```
+
 But what if there isn't an image out there that has everything you need
 already installed into it?
 In this case, you can define and build a new derived image in the project