Move to pixi

.gitattributes

@@ -0,0 +1,2 @@
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true

.gitignore

@@ -18,9 +18,14 @@ gurobi.log
 ### Notebooks
 .ipynb_checkpoints
 
-# Mutable folders
+# Mutable / cache folders
 tmp/
 temp/
-
-# Mkdocs
 .cache/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+
+# pixi environments
+.pixi
+*.egg-info

.pre-commit-config.yaml

@@ -24,7 +24,7 @@ repos:
 
   # Python file formatting
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.6
+    rev: v0.9.9
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

CHANGELOG

@@ -1,15 +1,9 @@
 # Changelog
 
-## 0.0.2
+## 0.1.0
 
 ### Added
 
 - Module copier template with testing, automated docs.
 - Added ruff and mypy checks
 - Added testing for the generated template
-
-## 0.0.1 - 2025-02-17
-
-### Added
-
-- Created the repo

CITATION.cff

@@ -5,7 +5,7 @@ cff-version: 1.2.0
 message: If you use this software or data produced by it, please cite it using the metadata from this file.
 title: clio - data module template
 repository: https://github.com/calliope-project/data-module-template
-license: MIT
+license: Apache-2.0
 authors:
   - given-names: Ivan
     family-names: Ruiz Manuel

README.md

@@ -4,15 +4,16 @@ A template for modular data workflows using [snakemake](https://snakemake.readth
 
 ## How to use this template
 
-1. Install [copier](https://copier.readthedocs.io/en/stable/) with your favourite package management system (we'll assume [mamba](https://mamba.readthedocs.io/en/latest/) in this example).
+1. Install [`copier`](https://copier.readthedocs.io/en/stable/) with your favourite package management system (we'll assume [mamba](https://mamba.readthedocs.io/en/latest/) in this example).
 2. Use `copier` to copy this repo.
-3. Answer some questions so we pre-fill licensing, citiation files, etc...
-4. You're all set up!
 
-```bash
-mamba install copier
-copier copy https://github.com/calliope-project/data-module-template.git ./path/to/destination
-```
+    ```bash
+    mamba install copier
+    copier copy https://github.com/calliope-project/data-module-template.git ./path/to/destination
+    ```
+
+3. Answer some questions so can we pre-fill licensing, citiation files, etc...
+4. You're all set up!
 
 ## Features
 

copier.yaml

@@ -12,8 +12,8 @@ module_short_name:
   type: str
   help: Please enter your module's short name as used in snakemake (should be in `snake_case`).
   validator: >-
-    {% if not (module_short_name | regex_search('^[a-z][a-z0-9_]+$')) %}
-    "Only letters, digits and underscores are valid."
+    {% if not (module_short_name | regex_search('^[a-z][a-z0-9_]*$')) %}
+    "Only lowercase letters, digits and underscores are valid."
     {% endif %}
 module_long_name:
   type: str
@@ -23,10 +23,10 @@ module_description:
   help: "Please provide a description of your module."
 author_given_name:
   type: str
-  help: "Please provide your given name(s)."
+  help: "Please provide your given name(s) (e.g., Ursula, Juan, Roald)."
 author_family_name:
   type: str
-  help: "Please provide your family name(s)."
+  help: "Please provide your family name(s) (e.g., Le Guin, Rulfo Vizcaino, Dahl)."
 author_email:
   type: str
   help: Please provide your email address.
@@ -40,8 +40,8 @@ github_org:
     Please provide the name of the github account or organisation where
     this module will be created (e.g., 'calliope-project' in 'github.com/calliope-project').
   validator: >-
-    {% if not (github_org | regex_search('^[a-z][a-z0-9_\-]+$')) %}
-    "Only letters, digits, hyphens and underscores are valid."
+    {% if not (github_org | regex_search('^[a-z][a-z0-9_-]*$')) %}
+    "Only lowercase letters, digits, hyphens and underscores are valid."
     {% endif %}
 license:
   type: str

pyproject.toml

@@ -1,21 +1,49 @@
+### ---
+# Project setup
+### ---
 [project]
-name = "data-module-template"
 authors = [
   { name = "Contributors listed in AUTHORS" },
 ]
+name = "data-module-template"
+requires-python = ">= 3.12"
+version = "0.1.0"
 readme = "README.md"
-requires-python = ">=3.12"
-keywords = ["energy systems", "modelling", "workflows"]
 license = { text = "MIT" }
-dynamic = ["version"]
-
+dependencies = ["mkdocs-mermaid2-plugin>=1.2.1,<2", "mkdocs-git-committers-plugin-2>=2.5.0,<3", "clio-tools @ git+https://github.com/calliope-project/clio.git"]
 
 [project.urls]
 website = "https://clio.readthedocs.io/"
 repository = "https://github.com/calliope-project/data-module-template"
 documentation = "https://clio.readthedocs.io"
 changelog = "https://github.com/calliope-project/data-module-template/CHANGELOG"
 
+
+[tool.pixi.project]
+channels = ["conda-forge", "bioconda"]
+platforms = ["win-64", "linux-64", "osx-64", "osx-arm64"]
+
+[tool.pixi.pypi-dependencies]
+data_module_template = { path = ".", editable = true }
+
+[tool.pixi.tasks]
+
+[tool.pixi.dependencies]
+cffconvert = ">=2.0.0,<3"
+copier = ">=9.5.0,<10"
+graphviz = ">=12.2.1,<13"
+mkdocs-material = ">=9.6.7,<10"
+mypy = ">=1.15.0,<2"
+pytest = ">=8.3.5,<9"
+ruff = ">=0.9.9,<0.10"
+snakefmt = ">=0.10.2,<0.11"
+snakemake-minimal = ">=8.29.0,<9"
+networkx = ">=3.4.2,<4"  # TODO: remove after clio-tools is released
+
+
+### ---
+# Project tooling
+### ---
 [tool.mypy]
 disable_error_code = ["import-untyped"]
 

tests/template_test.py

@@ -55,5 +55,7 @@ def test_snakemake_all_failure(simple_template):
 def test_snakemake_integration_testing(simple_template):
     """The automatic integration test should run by default."""
     assert subprocess.run(
-        ["snakemake", "--use-conda"], check=True, cwd=simple_template / "tests/integration"
+        ["snakemake", "--use-conda"],
+        check=True,
+        cwd=simple_template / "tests/integration",
     )