calkit-python 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

calkit/__init__.py

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

calkit/cli.py

@@ -1,21 +1,26 @@
 """The command line interface."""
 
+from __future__ import annotations
+
 import os
 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")
@@ -100,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/cloud.py

@@ -1,5 +1,7 @@
 """The REST API client."""
 
+from __future__ import annotations
+
 import os
 from functools import partial
 from typing import Literal

calkit/config.py

@@ -1,5 +1,7 @@
 """Configuration."""
 
+from __future__ import annotations
+
 import os
 from typing import Literal
 

calkit/core.py

@@ -1,11 +1,23 @@
 """Core functionality."""
 
+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/data.py

@@ -1,4 +1,11 @@
-"""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
 
 from typing import Literal, Union
 

calkit/dvc.py

@@ -1,5 +1,7 @@
 """Working with DVC."""
 
+from __future__ import annotations
+
 import logging
 import subprocess
 

calkit/git.py

@@ -1,5 +1,7 @@
 """Git-related functionality."""
 
+from __future__ import annotations
+
 import git
 
 

calkit/jupyter.py

@@ -1,5 +1,7 @@
 """Functionality for working with Jupyter."""
 
+from __future__ import annotations
+
 import subprocess
 
 from pydantic import BaseModel

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/server.py

@@ -1,5 +1,7 @@
 """A local server for interacting with project repos."""
 
+from __future__ import annotations
+
 import os
 
 import dvc

{calkit_python-0.0.1.dist-info → calkit_python-0.0.3.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.3
 Name: calkit-python
-Version: 0.0.1
-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>
@@ -11,16 +11,18 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.8
 Requires-Dist: dvc
+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.3.dist-info/RECORD

@@ -0,0 +1,20 @@
+calkit/__init__.py,sha256=WCAC5nhZD6Wzwgm3VMpKFCm3aGvtYoHqy3pt7kIgI9k,142
+calkit/cli.py,sha256=DpYo_EKLBbLZfbFFihGo3L3uXlKURWwv_QUOgSkCUoo,4901
+calkit/cloud.py,sha256=CnQKms4mBQo4X8jVLIa-70-3jPDl38zRNFyK5TjiaHM,2209
+calkit/config.py,sha256=NPFRk5inn66Wy44pyx8WppyqvIzkW1sO6VjXwIcCacE,2044
+calkit/core.py,sha256=qLNjBwlECzMitL85pMGIHzne4j7FpQAR9-ukYtdIMig,1225
+calkit/data.py,sha256=DZDkj-BLFWXz56R-A9XZeSKSgXpm3aKtiqD6JstfmnY,1631
+calkit/dvc.py,sha256=tX5172Ahw0mHcuJIrMenz1oGYxCrMzMURJJMHEHenbg,1506
+calkit/git.py,sha256=NLd7A32dPbfVnZLa8xbmviJ-ChGZcdkcd6wcOOnsSKQ,350
+calkit/gui.py,sha256=2UCrMyosc5v4CLlDcHO7oDwW9eLn5_WbNaLaG5bjMTc,23
+calkit/jupyter.py,sha256=S6HUOVafaLQJ7_ZfC1ddBwF3fT5q3GcbouLHdlH-oSo,1034
+calkit/models.py,sha256=TYllDbTutcODMUCLK2oCKivbJrtjwDu9t-5GyON9dq0,1339
+calkit/server.py,sha256=gq3643ABKTQu1eVR_OqJ-SdQh2dPLHSFsipmmAK5ttA,5959
+calkit/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+calkit/tests/test_core.py,sha256=CdRqvYnq3MidyTknvfIbkmmhMfydpyKtTW9hakAvzsc,167
+calkit/tests/test_jupyter.py,sha256=YTL6zI740UM2KUjskSipzvSKxsyQ8rVPFQIX5cb2tMQ,114
+calkit_python-0.0.3.dist-info/METADATA,sha256=NDjQb1WNaMJcEx-s4RTJyB-hNkGS3O7xy2Q6eCCn67Q,2449
+calkit_python-0.0.3.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+calkit_python-0.0.3.dist-info/entry_points.txt,sha256=tiPfbDDZNB-YStw5YVO_4Gww0W3Dcdy8Mh6muX_GWnY,42
+calkit_python-0.0.3.dist-info/licenses/LICENSE,sha256=9ZamCaSUTZk9rcrnf-sWFKLOHr3ws-S_dgKMegW4nw8,1056
+calkit_python-0.0.3.dist-info/RECORD,,

calkit_python-0.0.1.dist-info/RECORD

@@ -1,19 +0,0 @@
-calkit/__init__.py,sha256=3QZKwXecsbiUn-TsKW90NGAxGaVKOjG1q_EhB9lF_7Q,142
-calkit/cli.py,sha256=G23OBAAEHt-gE9lEDQFJ45RGobPyC-tt_xHnCh8GNvs,2993
-calkit/cloud.py,sha256=DLhds45nFFuXE9k6VpWMh4toxKZdy4yp2jfdAkl6Nzg,2173
-calkit/config.py,sha256=UqgWHrsQgM_bODCrmOEJZY6gxpBs_jFbEdT-ZQLjLSQ,2008
-calkit/core.py,sha256=44S3Ql3x6uJraoss9ha-FWbZeSfW2YOxU81p16k80h0,954
-calkit/data.py,sha256=G_dFLUCE7tMqGfg7NV7-197NrOYATSgI1eTdcz2HCyI,1411
-calkit/dvc.py,sha256=a5X8MeAr9rDmY70MZo4BHh2LfHocj0u4WAiqPXGGEos,1470
-calkit/git.py,sha256=2BcfdyGaCxoN25S5aFGMRMmIfWHCrCoFY3hNrGsu2yM,314
-calkit/gui.py,sha256=2UCrMyosc5v4CLlDcHO7oDwW9eLn5_WbNaLaG5bjMTc,23
-calkit/jupyter.py,sha256=VYONwhc_2orwjlki0oNYxy1dYkDBFWvi02Tl8-Tnw-c,998
-calkit/server.py,sha256=NgJuUcc8tZOY5wIH86xFA7Bs1Ji61JYcMUEB7VXlwkw,5923
-calkit/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-calkit/tests/test_core.py,sha256=CdRqvYnq3MidyTknvfIbkmmhMfydpyKtTW9hakAvzsc,167
-calkit/tests/test_jupyter.py,sha256=YTL6zI740UM2KUjskSipzvSKxsyQ8rVPFQIX5cb2tMQ,114
-calkit_python-0.0.1.dist-info/METADATA,sha256=ryO4XQ0MNWArJsunUIEAWjM_oFcqUJ3VO7BIToD8jrk,2334
-calkit_python-0.0.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-calkit_python-0.0.1.dist-info/entry_points.txt,sha256=tiPfbDDZNB-YStw5YVO_4Gww0W3Dcdy8Mh6muX_GWnY,42
-calkit_python-0.0.1.dist-info/licenses/LICENSE,sha256=9ZamCaSUTZk9rcrnf-sWFKLOHr3ws-S_dgKMegW4nw8,1056
-calkit_python-0.0.1.dist-info/RECORD,,