calkit-python 0.37.2__tar.gz → 0.37.4__tar.gz

{calkit_python-0.37.2 → calkit_python-0.37.4}/Makefile

@@ -37,15 +37,12 @@ test-docs: sync-docs ## Test if documentation can be built without warnings or e
 	@uv run mkdocs build -s
 
 .PHONY: sync-docs
-sync-docs: cli-reference ## Sync documentation content from docs/*.md into README.md.
+sync-docs: ## Sync documentation content from docs/*.md into README.md.
+	@echo "🚀 Generating docs references"
+	@uv run python scripts/generate-docs-references.py
 	@echo "🚀 Syncing documentation"
 	@uv run python scripts/sync-docs.py
 
-.PHONY: cli-reference
-cli-reference: ## Generate docs/cli-reference.md from CLI help output.
-	@echo "🚀 Generating CLI reference"
-	@uv run python scripts/generate-cli-reference.py
-
 .PHONY: docs
 docs: sync-docs ## Build and serve the documentation.
 	@uv run mkdocs serve --livereload

{calkit_python-0.37.2 → calkit_python-0.37.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: calkit-python
-Version: 0.37.2
+Version: 0.37.4
 Summary: Reproducibility simplified.
 Project-URL: Homepage, https://calkit.org
 Project-URL: Issues, https://github.com/calkit/calkit/issues
@@ -76,56 +76,67 @@ Description-Content-Type: text/markdown
   </a>
 </p>
 
-Calkit makes it easy to create
-["single button"](https://doi.org/10.1190/1.1822162)
-reproducible research projects.
-
-Instead of a loosely related collection of files
-and manual instructions,
-turn your project into a version-controlled,
-self-contained "calculation kit,"
-tying together all phases or stages of the project:
-data collection, analysis, visualization, and writing,
-each of which can make use of the latest and greatest computational
-tools and languages.
-In other words, you, your collaborators, and readers will be able to go
-from raw data to research article with a single command,
-improving efficiency via faster iteration cycle time,
-reducing the likelihood of mistakes,
-and allowing others to more effectively build upon your work.
-
-Calkit makes this level of automation possible without extensive software
-engineering expertise by providing a project framework and toolset that unifies
-and simplifies the use of powerful enabling technologies like Git,
-DVC, Conda, Docker, and more,
-while guiding users away from common reproducibility pitfalls.
+<!-- INCLUDE: docs/index.md -->
+
+Calkit helps you manage and automate research projects like a software
+engineer.
+
+Define computational environments,
+steps that process your data, create figures,
+presentations, and publications, connect to external tools,
+then iterate quickly and painlessly until your research questions are
+answered, tracking changes to all files along the way.
+At the end, deliver your entire project as a self-contained, self-documenting,
+version-controlled, and
+[single button reproducible](https://doi.org/10.1190/1.1822162)
+"calculation kit" so you and others can easily verify
+and build upon the results.
+
+## Guiding principles
+
+- Quality comes from iteration. Automation reduces the time and effort
+  needed to iterate, thereby increasing iteration and quality.
+- Automating a step can and should take roughly
+  the same amount of time as doing it once manually,
+  therefore it's almost always worth it.
+- Working in a "quick and dirty" way can easily become _not quick_ when
+  the dirtiness results in mistakes and/or discourages working in small steps.
 
 ## Features
 
-- A declarative pipeline that guides users to define an environment
-  for every stage, so long lists of instructions in a README and
-  "but it works on my machine" are things of the past.
-- A CLI to run the project's pipeline to verify it's reproducible,
-  regenerating outputs as needed and
-  ensuring all
-  computational environments
-  (e.g., [Conda](https://docs.conda.io/en/latest/),
-  [Docker](https://docker.com), uv, Julia)
-  match their specification.
-- A schema to store structured metadata describing the
-  project's important outputs (in its `calkit.yaml` file)
-  and how they are created
-  (its computational environments and pipeline).
-- A command line interface (CLI) to simplify keeping code, text, and larger
-  data files backed up in the same project repo using both
-  [Git](https://git-scm.com/) and [DVC](https://dvc.org/).
+- A simplified [version control](https://docs.calkit.org/version-control)
+  interface that unifies Git and DVC (Data Version Control),
+  so all materials can be kept in the same project repository.
+  This way, code doesn't need to be siloed away from other
+  important artifacts like datasets, models, figures, or article PDFs,
+  allowing you to work on all parts of a project without hopping around to
+  different tools.
+- [Computational environment management](https://docs.calkit.org/environments) with support for many
+  languages and environment managers: Conda, Docker, uv, Julia, Renv, and more.
+  No need to create and update environments on your own. Calkit will handle
+  them as needed.
+- An environment-aware build system or [pipeline](https://docs.calkit.org/pipeline) with
+  a simple declarative syntax and
+  output caching so you don't need to think about which steps or stages
+  need to be rerun after changing any part of the project.
+  Simply call `calkit run`.
+  Compose your pipeline from many different kinds of stages,
+  including simple scripts, commands, Jupyter Notebooks, LaTeX, and more.
 - A complementary self-hostable and GitHub-integrated
-  [cloud system](https://github.com/calkit/calkit-cloud)
+  [cloud platform](https://github.com/calkit/calkit-cloud)
   to facilitate backup, collaboration,
   and sharing throughout the entire research lifecycle.
-- [Overleaf integration](https://docs.calkit.org/overleaf/), so code,
-  data, and LaTeX documents can all live in the same repo and be part of a
-  single pipeline (no more manual uploads!)
+- [Overleaf integration](https://docs.calkit.org/overleaf/), so
+  analysis, visualization, and writing can all stay in sync
+  (no more manual uploads!)
+- Support for running on high performance computing (HPC) systems that use
+  [SLURM schedulers](https://docs.calkit.org/pipeline/slurm).
+- Support for running with [GitHub Actions](https://docs.calkit.org/tutorials/github-actions).
+- Extensions for doing all of the above graphically in
+  [JupyterLab](https://docs.calkit.org/jupyterlab) and
+  [VS Code](https://marketplace.visualstudio.com/items?itemName=Calkit.calkit-vscode).
+
+<!-- END INCLUDE -->
 
 ## Installation
 

{calkit_python-0.37.2 → calkit_python-0.37.4}/README.md

@@ -17,56 +17,67 @@
   </a>
 </p>
 
-Calkit makes it easy to create
-["single button"](https://doi.org/10.1190/1.1822162)
-reproducible research projects.
-
-Instead of a loosely related collection of files
-and manual instructions,
-turn your project into a version-controlled,
-self-contained "calculation kit,"
-tying together all phases or stages of the project:
-data collection, analysis, visualization, and writing,
-each of which can make use of the latest and greatest computational
-tools and languages.
-In other words, you, your collaborators, and readers will be able to go
-from raw data to research article with a single command,
-improving efficiency via faster iteration cycle time,
-reducing the likelihood of mistakes,
-and allowing others to more effectively build upon your work.
-
-Calkit makes this level of automation possible without extensive software
-engineering expertise by providing a project framework and toolset that unifies
-and simplifies the use of powerful enabling technologies like Git,
-DVC, Conda, Docker, and more,
-while guiding users away from common reproducibility pitfalls.
+<!-- INCLUDE: docs/index.md -->
+
+Calkit helps you manage and automate research projects like a software
+engineer.
+
+Define computational environments,
+steps that process your data, create figures,
+presentations, and publications, connect to external tools,
+then iterate quickly and painlessly until your research questions are
+answered, tracking changes to all files along the way.
+At the end, deliver your entire project as a self-contained, self-documenting,
+version-controlled, and
+[single button reproducible](https://doi.org/10.1190/1.1822162)
+"calculation kit" so you and others can easily verify
+and build upon the results.
+
+## Guiding principles
+
+- Quality comes from iteration. Automation reduces the time and effort
+  needed to iterate, thereby increasing iteration and quality.
+- Automating a step can and should take roughly
+  the same amount of time as doing it once manually,
+  therefore it's almost always worth it.
+- Working in a "quick and dirty" way can easily become _not quick_ when
+  the dirtiness results in mistakes and/or discourages working in small steps.
 
 ## Features
 
-- A declarative pipeline that guides users to define an environment
-  for every stage, so long lists of instructions in a README and
-  "but it works on my machine" are things of the past.
-- A CLI to run the project's pipeline to verify it's reproducible,
-  regenerating outputs as needed and
-  ensuring all
-  computational environments
-  (e.g., [Conda](https://docs.conda.io/en/latest/),
-  [Docker](https://docker.com), uv, Julia)
-  match their specification.
-- A schema to store structured metadata describing the
-  project's important outputs (in its `calkit.yaml` file)
-  and how they are created
-  (its computational environments and pipeline).
-- A command line interface (CLI) to simplify keeping code, text, and larger
-  data files backed up in the same project repo using both
-  [Git](https://git-scm.com/) and [DVC](https://dvc.org/).
+- A simplified [version control](https://docs.calkit.org/version-control)
+  interface that unifies Git and DVC (Data Version Control),
+  so all materials can be kept in the same project repository.
+  This way, code doesn't need to be siloed away from other
+  important artifacts like datasets, models, figures, or article PDFs,
+  allowing you to work on all parts of a project without hopping around to
+  different tools.
+- [Computational environment management](https://docs.calkit.org/environments) with support for many
+  languages and environment managers: Conda, Docker, uv, Julia, Renv, and more.
+  No need to create and update environments on your own. Calkit will handle
+  them as needed.
+- An environment-aware build system or [pipeline](https://docs.calkit.org/pipeline) with
+  a simple declarative syntax and
+  output caching so you don't need to think about which steps or stages
+  need to be rerun after changing any part of the project.
+  Simply call `calkit run`.
+  Compose your pipeline from many different kinds of stages,
+  including simple scripts, commands, Jupyter Notebooks, LaTeX, and more.
 - A complementary self-hostable and GitHub-integrated
-  [cloud system](https://github.com/calkit/calkit-cloud)
+  [cloud platform](https://github.com/calkit/calkit-cloud)
   to facilitate backup, collaboration,
   and sharing throughout the entire research lifecycle.
-- [Overleaf integration](https://docs.calkit.org/overleaf/), so code,
-  data, and LaTeX documents can all live in the same repo and be part of a
-  single pipeline (no more manual uploads!)
+- [Overleaf integration](https://docs.calkit.org/overleaf/), so
+  analysis, visualization, and writing can all stay in sync
+  (no more manual uploads!)
+- Support for running on high performance computing (HPC) systems that use
+  [SLURM schedulers](https://docs.calkit.org/pipeline/slurm).
+- Support for running with [GitHub Actions](https://docs.calkit.org/tutorials/github-actions).
+- Extensions for doing all of the above graphically in
+  [JupyterLab](https://docs.calkit.org/jupyterlab) and
+  [VS Code](https://marketplace.visualstudio.com/items?itemName=Calkit.calkit-vscode).
+
+<!-- END INCLUDE -->
 
 ## Installation