calkit-python 0.11.1__tar.gz → 0.11.3__tar.gz

{calkit_python-0.11.1 → calkit_python-0.11.3}/PKG-INFO

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

{calkit_python-0.11.1 → calkit_python-0.11.3}/calkit/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.11.1"
+__version__ = "0.11.3"
 
 from .core import *
 from . import git

{calkit_python-0.11.1 → calkit_python-0.11.3}/calkit/cli/main.py

@@ -7,6 +7,7 @@ import functools
 import hashlib
 import json
 import os
+import platform as _platform
 import subprocess
 import sys
 import time
@@ -93,9 +94,9 @@ def clone(
     if location is not None:
         cmd.append(location)
     try:
-        subprocess.call(cmd)
-    except Exception as e:
-        raise_error(str(e))
+        subprocess.check_call(cmd)
+    except subprocess.CalledProcessError:
+        raise_error("Failed to clone with Git")
     if location is None:
         location = url.split("/")[-1].removesuffix(".git")
     typer.echo(f"Moving into repo dir: {location}")
@@ -109,7 +110,10 @@ def clone(
                 calkit.dvc.set_remote_auth(remote_name=name)
     # DVC pull
     if not no_dvc_pull:
-        subprocess.call(["dvc", "pull"])
+        try:
+            subprocess.check_call(["dvc", "pull"])
+        except subprocess.CalledProcessError:
+            raise_error("Failed to pull from DVC remote(s)")
 
 
 @app.command(name="status")
@@ -654,7 +658,6 @@ def run_in_env(
         except subprocess.CalledProcessError:
             raise_error(f"Failed to run in {env['kind']} environment")
     elif env["kind"] == "uv-venv":
-        # TODO: This doesn't work on Windows
         if "prefix" not in env:
             raise_error("uv-venv environments require a prefix")
         if "path" not in env:
@@ -673,8 +676,12 @@ def run_in_env(
                     raise_error(f"Failed to create uv-venv at {prefix}")
             fname, ext = os.path.splitext(path)
             lock_fpath = fname + "-lock" + ext
+            if _platform.system() == "Windows":
+                activate_cmd = f"{prefix}\\Scripts\\activate"
+            else:
+                activate_cmd = f". {prefix}/bin/activate"
             check_cmd = (
-                f". {prefix}/bin/activate "
+                f"{activate_cmd} "
                 f"&& uv pip install -q -r {path} "
                 f"&& uv pip freeze > {lock_fpath} "
                 "&& deactivate"
@@ -686,7 +693,7 @@ def run_in_env(
             except subprocess.CalledProcessError:
                 raise_error("Failed to check uv-venv")
         # Now run the command
-        cmd = f". {prefix}/bin/activate && {shell_cmd} && deactivate"
+        cmd = f"{activate_cmd} && {shell_cmd} && deactivate"
         if verbose:
             typer.echo(f"Running command: {cmd}")
         try:

{calkit_python-0.11.1 → calkit_python-0.11.3}/calkit/cli/new.py

@@ -827,7 +827,7 @@ def new_publication(
     else:
         template_type = None
     # Check all of our inputs
-    if template_type not in ["latex"]:
+    if template_type is not None and template_type not in ["latex"]:
         raise_error(f"Unknown template type '{template_type}'")
     if env_name is not None and template_type != "latex":
         raise_error("Environments can only be created for latex templates")
@@ -1035,3 +1035,67 @@ def new_conda_env(
         repo.git.add("dvc.yaml")
     if not no_commit and repo.git.diff("--staged"):
         repo.git.commit(["-m", f"Add Conda environment {name}"])
+
+
+@new_app.command("uv-venv")
+def new_uv_venv(
+    packages: Annotated[
+        list[str],
+        typer.Argument(help="Packages to include in the environment."),
+    ],
+    name: Annotated[
+        str, typer.Option("--name", "-n", help="Environment name.")
+    ],
+    path: Annotated[
+        str, typer.Option("--path", help="Path for requirements file.")
+    ] = "requirements.txt",
+    prefix: Annotated[
+        str, typer.Option("--prefix", help="Prefix for environment location.")
+    ] = ".venv",
+    description: Annotated[
+        str, typer.Option("--description", help="Description.")
+    ] = None,
+    overwrite: Annotated[
+        bool,
+        typer.Option(
+            "--overwrite",
+            "-f",
+            help="Overwrite any existing environment with this name.",
+        ),
+    ] = False,
+    no_commit: Annotated[
+        bool, typer.Option("--no-commit", help="Do not commit changes.")
+    ] = False,
+):
+    """Create a new uv virtual environment."""
+    if os.path.isfile(path) and not overwrite:
+        raise_error("Output path already exists (use -f to overwrite)")
+    repo = git.Repo()
+    # Add environment to Calkit info
+    ck_info = calkit.load_calkit_info()
+    # If environments is a list instead of a dict, reformulate it
+    envs = ck_info.get("environments", {})
+    if isinstance(envs, list):
+        typer.echo("Converting environments from list to dict")
+        envs = {env.pop("name"): env for env in envs}
+    if name in envs and not overwrite:
+        raise_error(
+            f"Environment with name {name} already exists "
+            "(use -f to overwrite)"
+        )
+    packages_txt = "\n".join(packages)
+    # Write environment to path
+    with open(path, "w") as f:
+        f.write(packages_txt)
+    repo.git.add(path)
+    typer.echo("Adding environment to calkit.yaml")
+    env = dict(path=path, kind="uv-venv", prefix=prefix)
+    if description is not None:
+        env["description"] = description
+    envs[name] = env
+    ck_info["environments"] = envs
+    with open("calkit.yaml", "w") as f:
+        ryaml.dump(ck_info, f)
+    repo.git.add("calkit.yaml")
+    if not no_commit and repo.git.diff("--staged"):
+        repo.git.commit(["-m", f"Add uv venv {name}"])

{calkit_python-0.11.1 → calkit_python-0.11.3}/calkit/cloud.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-import os
+import warnings
 from functools import partial
 from typing import Literal
 
@@ -35,6 +35,7 @@ def get_token() -> str:
         _tokens[get_base_url()] = token
     # TODO: Check for expiration
     if token is None:
+        warnings.warn("No token found; attempting email+password auth")
         return auth()
     return token
 
@@ -50,10 +51,12 @@ def get_headers(headers: dict | None = None) -> dict:
 def auth() -> str:
     """Authenticate with the server and save a token."""
     cfg = config.read()
+    if cfg.email is None or cfg.password is None:
+        raise ValueError("Config is missing email or password")
     base_url = get_base_url()
     resp = requests.post(
         base_url + "/login/access-token",
-        data=dict(username=cfg.username, password=cfg.password),
+        data=dict(username=cfg.email, password=cfg.password),
     )
     token = resp.json()["access_token"]
     _tokens[base_url] = token

{calkit_python-0.11.1 → calkit_python-0.11.3}/calkit/config.py

@@ -48,6 +48,7 @@ class Settings(BaseSettings):
         env_prefix="CALKIT" + get_env_suffix(sep="_") + "_",
     )
     username: str | None = None
+    email: str | None = None
     token: str | None = None
     dvc_token: str | None = None
     dataframe_engine: Literal["pandas", "polars"] = "pandas"

{calkit_python-0.11.1 → calkit_python-0.11.3}/calkit/core.py

@@ -16,13 +16,14 @@ except ImportError:
     UTC = _timezone.utc
 
 from datetime import datetime
-
 from typing import Literal
 
 import ruamel.yaml
 from git import Repo
 from git.exc import InvalidGitRepositoryError
 
+from calkit.models import ProjectInfo
+
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__package__)
 
@@ -60,8 +61,10 @@ def find_project_dirs(relative=False, max_depth=3) -> list[str]:
 
 
 def load_calkit_info(
-    wdir=None, process_includes: bool | str | list[str] = False
-) -> dict:
+    wdir=None,
+    process_includes: bool | str | list[str] = False,
+    as_pydantic: bool = False,
+) -> dict | ProjectInfo:
     """Load Calkit project information.
 
     Parameters
@@ -99,6 +102,8 @@ def load_calkit_info(
                         with open(include_fpath) as f:
                             include_data = ryaml.load(f)
                         info[kind][obj_name] |= include_data
+    if as_pydantic:
+        return ProjectInfo.model_validate(info)
     return info
 
 

{calkit_python-0.11.1 → calkit_python-0.11.3}/calkit/models.py

@@ -42,6 +42,7 @@ class Publication(_CalkitObject):
         "journal-article",
         "conference-paper",
         "presentation",
+        "proposal",
         "poster",
         "report",
         "blog",
@@ -62,7 +63,15 @@ class ReferenceCollection(BaseModel):
 
 class Environment(BaseModel):
     kind: Literal[
-        "conda", "docker", "pip", "poetry", "npm", "yarn", "remote-ssh"
+        "conda",
+        "docker",
+        "poetry",
+        "npm",
+        "yarn",
+        "remote-ssh",
+        "uv",
+        "pixi",
+        "uv-venv",
     ]
     path: str | None = None
     description: str | None = None
@@ -70,8 +79,13 @@ class Environment(BaseModel):
     default: bool | None = None
 
 
+class UvVenvEnvironment(Environment):
+    kind: Literal["uv-venv"]
+    prefix: str
+
+
 class DockerEnvironment(Environment):
-    kind: str = "docker"
+    kind: Literal["docker"]
     image: str
     layers: list[str] | None = None
     shell: Literal["bash", "sh"] = "sh"
@@ -106,6 +120,7 @@ class ProcedureInput(BaseModel):
     description : str
         Optional longer description of the input.
     """
+
     name: str | None = None
     dtype: Literal["int", "bool", "str", "float"] = None
     units: str | None = None
@@ -143,6 +158,32 @@ class Procedure(BaseModel):
     imported_from: str | None = None
 
 
+class Release(BaseModel):
+    kind: Literal["project", "publication", "dataset", "model", "figure"]
+    url: str | None = None
+    doi: str | None = None
+    has_suffix: bool = False
+
+
+class ProjectRelease(Release):
+    kind: Literal["project"]
+
+
+class PublicationRelease(Release):
+    kind: Literal["publication"]
+    path: str
+
+
+class DatasetRelease(Release):
+    kind: Literal["dataset"]
+    path: str
+
+
+class ModelRelease(Release):
+    kind: Literal["model"]
+    path: str
+
+
 class ProjectInfo(BaseModel):
     """All of the project's information or metadata, written to the
     ``calkit.yaml`` file.
@@ -174,7 +215,13 @@ class ProjectInfo(BaseModel):
     figures: list[Figure] = []
     publications: list[Publication] = []
     references: list[ReferenceCollection] = []
-    environments: dict[str, Environment | DockerEnvironment] = {}
+    environments: dict[
+        str, Environment | DockerEnvironment | UvVenvEnvironment
+    ] = {}
     software: list[Software] = []
     notebooks: list[Notebook] = []
     procedures: dict[str, Procedure] = {}
+    releases: dict[
+        str,
+        ProjectRelease | PublicationRelease | DatasetRelease | ModelRelease,
+    ] = {}

{calkit_python-0.11.1 → calkit_python-0.11.3}/calkit/tests/cli/test_main.py

@@ -89,6 +89,23 @@ def test_run_in_env(tmp_dir):
     ck_info = calkit.load_calkit_info()
     env = ck_info["environments"]["py3.10"]
     assert env.get("path") is None
+    # Test uv venv
+    subprocess.check_call(
+        ["calkit", "new", "uv-venv", "-n", "uv1", "polars==1.18.0"]
+    )
+    out = subprocess.check_output(
+        [
+            "calkit",
+            "runenv",
+            "-n",
+            "uv1",
+            "--",
+            "python",
+            "-c",
+            "'import polars; print(polars.__version__)'",
+        ]
+    ).decode().strip()
+    assert out == "1.18.0"
 
 
 def test_check_call():

{calkit_python-0.11.1 → calkit_python-0.11.3}/calkit/tests/cli/test_new.py

@@ -169,3 +169,46 @@ def test_new_publication(tmp_dir):
         "calkit runenv -n my-latex-env "
         '"cd my-paper && latexmk -interaction=nonstopmode -pdf paper.tex"'
     )
+
+
+def test_new_uv_venv(tmp_dir):
+    subprocess.check_call(["git", "init"])
+    subprocess.check_call(["dvc", "init"])
+    subprocess.check_call(
+        [
+            "calkit",
+            "new",
+            "uv-venv",
+            "-n",
+            "my-uv-venv",
+            "pandas>=2.0",
+            "matplotlib",
+        ]
+    )
+    ck_info = calkit.load_calkit_info(as_pydantic=True)
+    envs = ck_info.environments
+    env = envs["my-uv-venv"]
+    assert env.path == "requirements.txt"
+    assert env.prefix == ".venv"
+    assert env.kind == "uv-venv"
+    subprocess.check_call(
+        [
+            "calkit",
+            "new",
+            "uv-venv",
+            "-n",
+            "my-uv-venv2",
+            "--path",
+            "requirements-2.txt",
+            "--prefix",
+            ".venv2",
+            "pandas>=2.0",
+            "matplotlib",
+        ]
+    )
+    ck_info = calkit.load_calkit_info(as_pydantic=True)
+    envs = ck_info.environments
+    env = envs["my-uv-venv2"]
+    assert env.path == "requirements-2.txt"
+    assert env.prefix == ".venv2"
+    assert env.kind == "uv-venv"