calkit-python 0.14.4__tar.gz → 0.14.5__tar.gz

calkit_python-0.14.5/.github/workflows/docs.yml

@@ -0,0 +1,31 @@
+name: Publish docs
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

{calkit_python-0.14.4 → calkit_python-0.14.5}/.gitignore

@@ -2,3 +2,4 @@ dev.ipynb
 *.pyc
 .DS_Store
 .vscode
+site

{calkit_python-0.14.4 → calkit_python-0.14.5}/PKG-INFO

@@ -1,8 +1,9 @@
 Metadata-Version: 2.4
 Name: calkit-python
-Version: 0.14.4
+Version: 0.14.5
 Summary: Reproducibility simplified.
-Project-URL: Homepage, https://github.com/calkit/calkit
+Project-URL: Homepage, https://calkit.org
+Project-URL: Repository, https://github.com/calkit/calkit
 Project-URL: Issues, https://github.com/calkit/calkit/issues
 Author-email: Pete Bachant <petebachant@gmail.com>
 License-File: LICENSE
@@ -29,6 +30,11 @@ Requires-Dist: uvicorn
 Provides-Extra: data
 Requires-Dist: pandas; extra == 'data'
 Requires-Dist: polars; extra == 'data'
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == 'docs'
+Requires-Dist: mkdocs-material; extra == 'docs'
 Description-Content-Type: text/markdown
 
 <p align="center">

{calkit_python-0.14.4 → calkit_python-0.14.5}/calkit/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.14.4"
+__version__ = "0.14.5"
 
 from .core import *
 from . import git

{calkit_python-0.14.4 → calkit_python-0.14.5}/calkit/cli/main.py

@@ -8,7 +8,6 @@ import hashlib
 import json
 import os
 import platform as _platform
-import shlex
 import subprocess
 import sys
 import time
@@ -458,6 +457,8 @@ def run_dvc_repro(
     objects = []
     with open("dvc.yaml") as f:
         pipeline = calkit.ryaml.load(f)
+        if pipeline is None:
+            raise_error("Pipeline is empty")
         for stage_name, stage_info in pipeline.get("stages", {}).items():
             ckmeta = stage_info.get("meta", {}).get("calkit")
             if ckmeta is not None:

{calkit_python-0.14.4 → calkit_python-0.14.5}/calkit/core.py

@@ -255,9 +255,11 @@ def check_dep_exists(
         # Fall back to simply calling ``--version``
         cmd.append("--version")
     try:
-        subprocess.check_output(cmd)
+        subprocess.run(
+            cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL
+        )
         return True
-    except subprocess.CalledProcessError:
+    except FileNotFoundError:
         return False
 
 

calkit_python-0.14.5/docs/CNAME

@@ -0,0 +1 @@
+docs.calkit.org

calkit_python-0.14.5/docs/img/c-to-the-k-white.svg

@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   width="210mm"
+   height="210mm"
+   viewBox="0 0 210 210"
+   version="1.1"
+   id="svg1"
+   xml:space="preserve"
+   inkscape:version="1.4 (e7c3feb1, 2024-10-09)"
+   sodipodi:docname="c-to-the-k-white.svg"
+   inkscape:export-filename="c-to-the-k.png"
+   inkscape:export-xdpi="36.285713"
+   inkscape:export-ydpi="36.285713"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:xlink="http://www.w3.org/1999/xlink"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg"><sodipodi:namedview
+     id="namedview1"
+     pagecolor="#000000"
+     bordercolor="#000000"
+     borderopacity="0.25"
+     inkscape:showpageshadow="2"
+     inkscape:pageopacity="0.0"
+     inkscape:pagecheckerboard="0"
+     inkscape:deskcolor="#d1d1d1"
+     inkscape:document-units="mm"
+     inkscape:zoom="0.88320437"
+     inkscape:cx="431.94986"
+     inkscape:cy="401.37935"
+     inkscape:window-width="1936"
+     inkscape:window-height="1186"
+     inkscape:window-x="0"
+     inkscape:window-y="25"
+     inkscape:window-maximized="0"
+     inkscape:current-layer="layer1"
+     inkscape:export-bgcolor="#000000ff" /><defs
+     id="defs1"><path
+       id="MJX-7-TEX-I-1D436"
+       d="m 50,252 q 0,115 67,221 67,106 169,168 102,62 204,63 90,0 143,-51 9,-10 15,-17 6,-7 8,-10 l 1,-3 q 3,0 27,26 7,6 15,14 8,8 16,16 8,8 10,11 l 15,15 h 6 q 14,0 14,-7 0,-4 -32,-137 -36,-139 -36,-140 -2,-5 -5,-6 -3,-1 -18,-2 h -16 q -6,6 -6,9 0,1 1,7 1,6 2,20 1,14 1,32 0,71 -32,124 -32,53 -109,54 -26,0 -56,-7 -30,-7 -72,-24 -42,-17 -83,-56 -41,-39 -73,-93 -32,-57 -51,-133 -19,-76 -19,-124 0,-114 76,-164 48,-34 118,-34 91,0 162,68 71,68 94,148 4,13 6,15 2,2 16,2 20,0 20,-9 0,-5 -1,-9 Q 618,132 523,55 428,-22 319,-22 206,-22 128,53 50,128 50,252 Z" /><clipPath
+       id="TRvQCFGpKKLF"><path
+         fill="none"
+         stroke="none"
+         d="M 0,0 H 27 V 36 H 0 Z"
+         id="path1" /></clipPath></defs><g
+     inkscape:label="Layer 1"
+     inkscape:groupmode="layer"
+     id="layer1"><use
+       data-c="1D436"
+       xlink:href="#MJX-7-TEX-I-1D436"
+       id="use1"
+       transform="matrix(0.12756991,0,0,-0.12756991,28.020344,166.98394)"
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:0;stroke-dasharray:0, 0;stroke-miterlimit:4;paint-order:normal;stroke-linejoin:round;stroke-dashoffset:0" /><g
+       transform="matrix(89.090601,0,0,89.090601,-156.44553,-1013.8097)"
+       id="g4"
+       clip-path="url(#clipPath9)"
+       style="stroke-width:0.98653504;stroke-dasharray:none;fill:#ffffff;fill-opacity:1"><g
+         transform="translate(3.2798571,12.382286)"
+         id="g2"
+         style="stroke-width:0.98653504;stroke-dasharray:none;fill:#ffffff;fill-opacity:1"><path
+           fill="#009688"
+           stroke="none"
+           paint-order="stroke fill markers"
+           d="m 0.192,-0.616 q 0,0.031 -0.028,0.046 -0.012,0.007 -0.026,0.007 -0.033,0 -0.048,-0.031 -0.005,-0.011 -0.005,-0.022 0,-0.031 0.028,-0.046 0.012,-0.007 0.026,-0.007 0.033,0 0.048,0.031 0.005,0.011 0.005,0.022 z"
+           id="path2"
+           style="stroke-width:0.98653504;stroke-dasharray:none;fill:#ffffff;fill-opacity:1" /></g><g
+         transform="translate(3.1428571,12.645286)"
+         id="g3"
+         style="stroke-width:0.98653504;stroke-dasharray:none;fill:#ffffff;fill-opacity:1"><path
+           fill="#009688"
+           stroke="none"
+           paint-order="stroke fill markers"
+           d="m 0.287,-0.683 -0.104,0.422 q 0.043,-0.017 0.111,-0.093 0.079,-0.088 0.146,-0.088 0.048,0 0.064,0.04 0.004,0.011 0.004,0.023 0,0.041 -0.034,0.057 -0.011,0.004 -0.021,0.004 -0.031,0 -0.037,-0.027 -0.001,-0.004 -0.001,-0.008 0,-0.028 0.025,-0.044 l 0.001,-0.001 v 0 Q 0.454,-0.406 0.472,-0.407 L 0.468,-0.411 Q 0.46,-0.417 0.447,-0.419 0.445,-0.42 0.438,-0.42 q -0.053,0 -0.129,0.081 -0.004,0.004 -0.008,0.009 l -0.006,0.006 q -0.052,0.054 -0.086,0.074 0.148,0.019 0.148,0.105 0,0.014 -0.004,0.031 -0.008,0.032 -0.008,0.056 0,0.047 0.032,0.047 0.046,0 0.074,-0.083 0.007,-0.017 0.013,-0.041 0.008,-0.017 0.014,-0.018 0.012,0 0.012,0.01 0,0.016 -0.019,0.065 -0.008,0.02 -0.017,0.036 -0.032,0.053 -0.079,0.053 -0.055,0 -0.08,-0.048 -0.012,-0.023 -0.012,-0.051 0,-0.011 0.004,-0.035 Q 0.29,-0.133 0.29,-0.144 0.29,-0.207 0.2,-0.225 0.187,-0.228 0.174,-0.229 0.124,-0.021 0.118,-0.01 0.108,0.009 0.084,0.011 0.06,0.011 0.056,-0.01 0.055,-0.014 0.055,-0.017 q 0,-0.008 0.004,-0.022 l 0.145,-0.576 0.003,-0.02 q 0,-0.011 -0.014,-0.014 v 0 q -0.012,-0.003 -0.036,-0.003 -0.022,0 -0.024,-0.012 0,-0.017 0.019,-0.02 l 0.122,-0.01 q 0.013,0 0.013,0.011 z"
+           id="path3"
+           style="stroke-width:0.98653504;stroke-dasharray:none;fill:#ffffff;fill-opacity:1" /></g></g></g></svg>

calkit_python-0.14.5/docs/index.md

@@ -0,0 +1,8 @@
+# Home
+
+Welcome to the Calkit documentation!
+
+Calkit is a lightweight framework for reproducible research projects.
+A Calkit project is intended to include all digital materials
+used throughout the research.
+This includes code, datasets, figures, publications, notebooks, and more.

calkit_python-0.14.5/mkdocs.yml

@@ -0,0 +1,52 @@
+site_name: Calkit
+repo_name: calkit/calkit
+repo_url: https://github.com/calkit/calkit.git
+theme:
+  name: material
+  logo: img/c-to-the-k-white.svg
+  features:
+    - content.code.copy
+    - navigation.footer
+    - navigation.indexes
+    - navigation.top
+  palette:
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      primary: teal
+      accent: cyan
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: teal
+      accent: cyan
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      primary: teal
+      accent: cyan
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+nav:
+  - Home: index.md
+  - Environments: environments.md
+  - Tutorials:
+      - tutorials/adding-latex-pub-docker.md
+      - tutorials/notebook-pipeline.md
+      - tutorials/procedures.md
+      - tutorials/conda-envs.md
+markdown_extensions:
+  - admonition
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences

{calkit_python-0.14.4 → calkit_python-0.14.5}/pyproject.toml

@@ -40,9 +40,17 @@ data = [
   "pandas",
   "polars",
 ]
+dev = [
+  "pytest",
+]
+docs = [
+  "mkdocs",
+  "mkdocs-material",
+]
 
 [project.urls]
-Homepage = "https://github.com/calkit/calkit"
+Homepage = "https://calkit.org"
+Repository = "https://github.com/calkit/calkit"
 Issues = "https://github.com/calkit/calkit/issues"
 
 [project.scripts]