Added pybamm-cookiecutter CLI

.github/workflows/test_on_push.yml

@@ -58,9 +58,6 @@ jobs:
       - name: Test template generation
         run: nox -s template-tests
 
-      - name: Test project
-        run: nox -s project-tests
-
       - name: Run coverage tests
         if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
         run: nox -s coverage
@@ -121,7 +118,7 @@ jobs:
         - name: Install copier and generate a project
           run: |
             python -m pip install copier jinja2_time
-            copier copy . ./pybamm-example-project --trust --defaults
+            copier copy . . --trust --defaults
 
         - name: Set up uv
           uses: yezz123/setup-uv@v4

LICENSES-bundled.txt

@@ -3,5 +3,8 @@ compatibly licensed.
 
 
 Name: PyBaMM
-Files: src/pybamm_cookiecutter/parameters/*
+Files: - src/{{ project_slug }}/parameters/input/Chen2020.py
+       - src/{{ project_slug }}/models/input/BasicReservoir.py
+       - src/{{ project_slug }}/models/input/SPM.py
+       - src/{{ project_slug }}/entry_point.py
 License: BSD-3-Clause

README.md

@@ -31,19 +31,31 @@ This repository contains a `copier` template for battery modeling projects using
 
 ## 📄 Using `pybamm-cookiecutter`
 
-### Generating projects with `pybamm-cookiecutter` manually using copier
+### Generating projects with `pybamm-cookiecutter`
 
-This template is not on PyPI yet, so it cannot be installed through `pip` until the first release. Meanwhile, it can be used by cloning this repository and using `copier` to generate a project with this template.
+#### Manually using copier
 
 Install `copier` and `jinja2_time` extension using `pip`.
 ```bash
 pip install copier jinja2-time
 ```
 Generate a project from the `pybamm-cookiecutter` template.
-**Note:** This requires an internet connection. You could manually clone the git repository and run the copy command, or just execute the copy command with the URL to the git repository.
 
 ```bash
-copier copy https://github.com/pybamm-team/pybamm-cookiecutter.git name_of_your_project/ --trust
+copier copy https://github.com/pybamm-team/pybamm-cookiecutter.git . --trust
+# this will generate the project in the current working directory
+copier copy https://github.com/pybamm-team/pybamm-cookiecutter.git path_to_copy_to/ --trust
+# this will generate the project in the specified path
+```
+#### Using pipx
+
+Install the `pybamm-cookiecutter` package.
+```bash
+pipx install pybamm-cookiecutter
+```
+Navigate into the directory you want your project directory to reside in, or use `--path` argument to explicitly mention the path where you want your project to be generated.
+```bash
+pybamm-cookiecutter --path /path_to_copy_to
 ```
 
 Copier will prompt you with various configurations and you may choose the ones that suit your use case.

copier.yml

@@ -87,6 +87,9 @@ _jinja_extensions:
 _subdirectory: template
 
 _tasks:
-  - git init -b {{branch}}
-  - git config user.name {{full_name}}
-  - git config user.email {{email}}
+  - command: git init -b {{branch}}
+    working_directory: "{{project_name}}"
+  - command: git config user.name {{full_name}}
+    working_directory: "{{project_name}}"
+  - command: git config user.email {{email}}
+    working_directory: "{{project_name}}"

noxfile.py

@@ -46,11 +46,6 @@ def run_template_generation(session):
     """Run tests for the template generation."""
     install_and_run_tests(session, "tests/template_tests")
 
-@nox.session(name="project-tests")
-def run_project_tests(session):
-    """Run the tests for testing project units"""
-    install_and_run_tests(session, "tests/project_tests")
-
 @nox.session(name="coverage")
 def run_coverage(session):
     """Run the coverage tests and generate an XML report."""

pyproject.toml

@@ -30,7 +30,7 @@ classifiers = [
   "Typing :: Typed",
 ]
 dynamic = ["version"]
-dependencies = ["pybamm", "copier", "jinja2-time"]
+dependencies = ["copier", "jinja2-time", "colorama"]
 
 [project.optional-dependencies]
 dev = [
@@ -55,19 +55,18 @@ docs = [
   "sphinx-gallery",
 ]
 
+[project.scripts]
+pybamm-cookiecutter = "pybamm_cookiecutter.cli:pybamm_cookiecutter_cli"
+
+[project.entry-points."pipx.run"]
+pybamm-cookiecutter = "pybamm_cookiecutter.cli:pybamm_cookiecutter_cli"
+
 [project.urls]
 Homepage = "https://github.com/pybamm-team/pybamm-cookiecutter"
 "Bug Tracker" = "https://github.com/pybamm-team/pybamm-cookiecutter/issues"
 Discussions = "https://github.com/pybamm-team/pybamm-cookiecutter/discussions"
 Changelog = "https://github.com/pybamm-team/pybamm-cookiecutter/releases"
 
-[project.entry-points."parameter_sets"]
-Chen2020 = "pybamm_cookiecutter.parameters.input.Chen2020:get_parameter_values"
-
-[project.entry-points."models"]
-SPM = "pybamm_cookiecutter.models.input.SPM:SPM"
-BasicReservoir = "pybamm_cookiecutter.models.input.BasicReservoir:BasicReservoir"
-
 [tool.hatch]
 version.source = "vcs"
 build.hooks.vcs.version-file = "src/pybamm_cookiecutter/_version.py"

src/pybamm_cookiecutter/__init__.py

@@ -5,15 +5,10 @@
 """
 from __future__ import annotations
 
-import pybamm
-
 from ._version import version as __version__
-from .entry_point import Model, parameter_sets, models
+from .cli import pybamm_cookiecutter_cli
 
 __all__ : list[str] = [
     "__version__",
-    "pybamm",
-    "parameter_sets",
-    "Model",
-    "models",
+    "pybamm_cookiecutter_cli",
 ]

src/pybamm_cookiecutter/__main__.py

@@ -0,0 +1,3 @@
+if __name__ == "__main__":
+    from pybamm_cookiecutter.cli import pybamm_cookiecutter_cli
+    pybamm_cookiecutter_cli()

src/pybamm_cookiecutter/cli.py

@@ -0,0 +1,40 @@
+import copier
+import argparse
+from pathlib import Path
+from colorama import Fore
+import os
+
+TEMPLATE = str(Path.cwd())
+
+def pybamm_cookiecutter_cli():
+    """
+    Command Line Interface (CLI) for generating PyBaMM based projects using copier.
+
+    Parameters
+    ----------
+    --path: pathlib.Path
+
+    Examples
+    -------
+    $ pybamm-cookiecutter
+    Generates a project in the current working directory of the terminal.
+    $ pybamm-cookiecutter --path /myproject
+    Generates a project in the `myproject` directory.
+    """
+    try:
+        parser = argparse.ArgumentParser(description = "A copier template generator for PyBaMM based projects")
+        parser.add_argument("--path", type = str, required = False, default = os.getcwd(),
+                            help = "The destination path for project generation")
+
+        args = parser.parse_args()
+        destination_path = Path(args.path)
+
+        copier.run_copy(src_path = TEMPLATE, dst_path = destination_path, unsafe=True)
+
+    except Exception as error:
+        print(Fore.RED + "Error caused by an exception: " + Fore.RESET, error)
+        print(Fore.CYAN + "If you are unsure what the error is, feel free to open an issue at" + Fore.YELLOW +" - https://github.com/pybamm-team/pybamm-cookiecutter/issues" + Fore.RESET)
+
+if __name__ == '__main__':
+
+    pybamm_cookiecutter_cli()