calkit-python 0.0.2__tar.gz → 0.0.3__tar.gz

{calkit_python-0.0.2 → calkit_python-0.0.3}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.3
 Name: calkit-python
-Version: 0.0.2
-Summary: Reproducibility made easy.
+Version: 0.0.3
+Summary: Reproducibility simplified.
 Project-URL: Homepage, https://github.com/calkit/calkit
 Project-URL: Issues, https://github.com/calkit/calkit/issues
 Author-email: Pete Bachant <petebachant@gmail.com>
@@ -15,13 +15,14 @@ Requires-Dist: eval-type-backport; python_version < '3.10'
 Requires-Dist: fastapi
 Requires-Dist: gitpython
 Requires-Dist: keyring
-Requires-Dist: pandas
-Requires-Dist: polars
 Requires-Dist: pydantic-settings
 Requires-Dist: pydantic[email]
 Requires-Dist: pyjwt
 Requires-Dist: requests
 Requires-Dist: typer
+Provides-Extra: data
+Requires-Dist: pandas; extra == 'data'
+Requires-Dist: polars; extra == 'data'
 Description-Content-Type: text/markdown
 
 # Calkit

{calkit_python-0.0.2 → calkit_python-0.0.3}/calkit/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.0.2"
+__version__ = "0.0.3"
 
 from .core import *
 from . import git

{calkit_python-0.0.2 → calkit_python-0.0.3}/calkit/cli.py

@@ -7,17 +7,20 @@ import pty
 import subprocess
 import sys
 
+import git
 import typer
 from typing_extensions import Annotated, Optional
 
-import calkit
+from calkit.core import ryaml
 
 from . import config
 from .dvc import configure_remote, set_remote_auth
 
 app = typer.Typer()
 config_app = typer.Typer()
+new_app = typer.Typer()
 app.add_typer(config_app, name="config", help="Configure Calkit.")
+app.add_typer(new_app, name="new", help="Add new Calkit object.")
 
 
 @config_app.command(name="set")
@@ -102,6 +105,61 @@ def commit(
     raise NotImplementedError
 
 
+@new_app.command(name="figure")
+def new_figure(
+    path: str,
+    title: Annotated[str, typer.Option("--title")],
+    description: Annotated[str, typer.Option("--desc")] = None,
+    commit: Annotated[bool, typer.Option("--commit")] = False,
+):
+    """Add a new figure to ``calkit.yaml``."""
+    if os.path.isfile("calkit.yaml"):
+        with open("calkit.yaml") as f:
+            ck_info = ryaml.load(f)
+    else:
+        ck_info = {}
+    figures = ck_info.get("figures", [])
+    paths = [f.get("path") for f in figures]
+    if path in paths:
+        raise ValueError(f"Figure at path {path} already exists")
+    obj = dict(path=path, title=title)
+    if description is not None:
+        obj["description"] = description
+    figures.append(obj)
+    ck_info["figures"] = figures
+    with open("calkit.yaml", "w") as f:
+        ryaml.dump(ck_info, f)
+    if commit:
+        repo = git.Repo()
+        repo.git.add("calkit.yaml")
+        repo.git.commit(["-m", f"Add figure {path}"])
+
+
+@new_app.command("question")
+def new_question(
+    question: str,
+    commit: Annotated[bool, typer.Option("--commit")] = False,
+):
+    if os.path.isfile("calkit.yaml"):
+        with open("calkit.yaml") as f:
+            ck_info = ryaml.load(f)
+    else:
+        ck_info = {}
+    questions = ck_info.get("questions", [])
+    if question in questions:
+        raise ValueError("Question already exists")
+    if not question.endswith("?"):
+        raise ValueError("Questions must end with a question mark")
+    questions.append(question)
+    ck_info["questions"] = questions
+    with open("calkit.yaml", "w") as f:
+        ryaml.dump(ck_info, f)
+    if commit:
+        repo = git.Repo()
+        repo.git.add("calkit.yaml")
+        repo.git.commit(["-m", "Add question"])
+
+
 @app.command(name="server")
 def run_server():
     import uvicorn

{calkit_python-0.0.2 → calkit_python-0.0.3}/calkit/core.py

@@ -3,11 +3,21 @@
 from __future__ import annotations
 
 import glob
+import logging
 import os
 
+import ruamel.yaml
 from git import Repo
 from git.exc import InvalidGitRepositoryError
 
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__package__)
+
+ryaml = ruamel.yaml.YAML()
+ryaml.indent(mapping=2, sequence=4, offset=2)
+ryaml.preserve_quotes = True
+ryaml.width = 70
+
 
 def find_project_dirs(relative=False, max_depth=3) -> list[str]:
     """Find all Calkit project directories."""

{calkit_python-0.0.2 → calkit_python-0.0.3}/calkit/data.py

@@ -1,4 +1,9 @@
-"""Functionality for working with datasets."""
+"""Functionality for working with datasets.
+
+Since the dependencies here are optional, we need to ensure this isn't imported
+by default, or otherwise ensure ``import calkit`` works when the data
+dependencies are not installed.
+"""
 
 from __future__ import annotations
 

calkit_python-0.0.3/calkit/models.py

@@ -0,0 +1,74 @@
+"""Data models."""
+
+from typing import Literal
+
+from pydantic import BaseModel
+
+
+class _ImportedFrom(BaseModel):
+    project: str
+    path: str = None
+
+
+class _CalkitObject(BaseModel):
+    path: str
+    title: str
+    description: str
+    stage: str | None = None
+
+
+class Dataset(_CalkitObject):
+    pass
+
+
+class Figure(_CalkitObject):
+    pass
+
+
+class Publication(_CalkitObject):
+    kind: Literal[
+        "journal-article",
+        "conference-paper",
+        "presentation",
+        "poster",
+        "report",
+        "blog",
+    ]
+    is_published: bool = False
+    doi: str = None
+
+
+class ReferenceFile(BaseModel):
+    path: str
+    key: str
+
+
+class ReferenceCollection(BaseModel):
+    path: str
+    files: list[ReferenceFile] = []
+
+
+class Environment(BaseModel):
+    name: str
+    kind: Literal["conda", "docker", "pip", "poetry", "npm", "yarn"]
+    path: str
+
+
+class Software(BaseModel):
+    title: str
+    path: str
+    description: str
+
+
+class ProjectInfo(BaseModel):
+    """All of the project's information or metadata, written to the
+    ``calkit.yaml`` file.
+    """
+
+    questions: list[str] = []
+    datasets: list[Dataset] = []
+    figures: list[Figure] = []
+    publications: list[Publication] = []
+    references: list[ReferenceCollection] = []
+    environments: list[Environment] = []
+    software: list[Software] = []

{calkit_python-0.0.2 → calkit_python-0.0.3}/pyproject.toml

@@ -1,34 +1,38 @@
 [build-system]
-requires = ["hatchling"]
 build-backend = "hatchling.build"
+requires = ["hatchling"]
 
 [project]
-name = "calkit-python"
-dynamic = ["version"]
 authors = [
-  { name="Pete Bachant", email="petebachant@gmail.com" },
+  {name = "Pete Bachant", email = "petebachant@gmail.com"},
 ]
-description = "Reproducibility made easy."
-readme = "README.md"
-requires-python = ">=3.8"
 classifiers = [
-    "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: MIT License",
-    "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
 ]
 dependencies = [
-    "dvc",
-    "eval-type-backport; python_version < '3.10'",
-    "fastapi",
-    "gitpython",
-    "keyring",
-    "pandas",
-    "polars",
-    "pydantic[email]",
-    "pydantic-settings",
-    "pyjwt",
-    "requests",
-    "typer",
+  "dvc",
+  "eval-type-backport; python_version < '3.10'",
+  "fastapi",
+  "gitpython",
+  "keyring",
+  "pydantic[email]",
+  "pydantic-settings",
+  "pyjwt",
+  "requests",
+  "typer",
+]
+description = "Reproducibility simplified."
+dynamic = ["version"]
+name = "calkit-python"
+readme = "README.md"
+requires-python = ">=3.8"
+
+[project.optional-dependencies]
+data = [
+  "pandas",
+  "polars",
 ]
 
 [project.urls]