calkit-python 0.17.4__tar.gz → 0.17.5__tar.gz

{calkit_python-0.17.4 → calkit_python-0.17.5}/PKG-INFO

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

{calkit_python-0.17.4 → calkit_python-0.17.5}/calkit/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.17.4"
+__version__ = "0.17.5"
 
 from .core import *
 from . import git

{calkit_python-0.17.4 → calkit_python-0.17.5}/calkit/cli/config.py

@@ -4,9 +4,12 @@ from __future__ import annotations
 
 import subprocess
 
+import git
 import typer
 from git.exc import InvalidGitRepositoryError
+from typing_extensions import Annotated
 
+import calkit
 from calkit import config
 from calkit.cli.core import raise_error
 from calkit.dvc import configure_remote, get_remotes, set_remote_auth
@@ -44,7 +47,14 @@ def get_config_value(key: str) -> None:
 
 @config_app.command(name="setup-remote", help="Alias for 'remote'.")
 @config_app.command(name="remote")
-def setup_remote():
+def setup_remote(
+    no_commit: Annotated[
+        bool,
+        typer.Option(
+            "--no-commit", help="Do not commit changes to DVC config."
+        ),
+    ] = False,
+):
     """Setup the Calkit cloud as the default DVC remote and store a token in
     the local config.
     """
@@ -55,6 +65,13 @@ def setup_remote():
         raise_error("DVC remote config failed; have you run `dvc init`?")
     except InvalidGitRepositoryError:
         raise_error("Current directory is not a Git repository")
+    if not no_commit:
+        repo = git.Repo()
+        repo.git.reset()
+        repo.git.add(".dvc/config")
+        if calkit.git.get_staged_files():
+            typer.echo("Committing changes to DVC config")
+            repo.git.commit(["-m", "Set DVC remote"])
 
 
 @config_app.command(name="setup-remote-auth", help="Alias for 'remote-auth'.")

{calkit_python-0.17.4 → calkit_python-0.17.5}/docs/calkit-yaml.md

@@ -31,6 +31,8 @@ showcase:
   - text: Here is some text.
   - figure: figures/my-figure.png
   - text: There is a figure above.
+  - markdown: "### This is a Markdown heading"
+  - publication: paper/paper.pdf
 ```
 
 [This project](https://calkit.io/petebachant/strava-analysis)