Ensure project names with dashes are converted for python code (#21)

* ensure python package name is compliant

* update to include py 3.14 in tests for template

* Update .pre-commit-config.yaml

Author: d33bs

.github/workflows/run-tests.yml.jinja

@@ -28,7 +28,7 @@ jobs:
   run_tests:
     strategy:
       matrix:
-        python_version: ["3.10", "3.11", "3.12", "3.13"]
+        python_version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
         os: [ubuntu-24.04, macos-14]
     runs-on: ${{ matrix.os }}
     env:

.pre-commit-config.yaml

@@ -34,12 +34,12 @@ repos:
         additional_dependencies:
         -   mdformat-gfm
 -   repo: https://github.com/adrienverge/yamllint
-    rev: v1.37.1
+    rev: v1.38.0
     hooks:
     -   id: yamllint
         exclude: pre-commit-config.yaml
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.14.11"
+    rev: "v0.14.13"
     hooks:
     -   id: ruff-format
     -   id: ruff-check

copier.yaml

@@ -4,9 +4,9 @@ project_name:
   help: >-
     What is the name of your project?
     This will be used in the package name
-    and other places. Please use "_"
-    underscores instead of spaces where
-    necessary, e.g. "my_project".
+    and other places. Dashes will be converted
+    to underscores for the Python package/module
+    name (e.g. "my-project" -> "my_project").
 
 project_description:
   type: str
@@ -15,6 +15,11 @@ project_description:
     This will be used in the package metadata
     and other places.
 
+python_package_name:
+  type: str
+  default: "{{ project_name|replace('-', '_') }}"
+  when: false
+
 author_name:
   type: str
   default: "Your Name"

docs/src/python-api.md.jinja

@@ -1,9 +1,9 @@
 # Python API
 
 ```{eval-rst}
-{{ project_name }}.main
+{{ python_package_name }}.main
 -------------------
-.. automodule:: src.{{ project_name }}.main
+.. automodule:: src.{{ python_package_name }}.main
    :members:
    :private-members:
    :undoc-members:

pyproject.toml

@@ -62,4 +62,4 @@ pythonpath = [ "." ]
 
 [tool.vulture]
 min_confidence = 90
-paths = [ "src/{{ project_name }}", "tests" ]
+paths = [ "src/{{ python_package_name }}", "tests" ]

pyproject.toml.jinja

@@ -22,7 +22,7 @@ dependencies = [
   "fire>=0.7.0",
   "jinja2>=3.1.6",
 ]
-scripts.{{ project_name }} = "{{ project_name }}.cli:trigger"
+scripts.{{ project_name }} = "{{ python_package_name }}.cli:trigger"
 
 [dependency-groups]
 dev = [
@@ -46,7 +46,7 @@ notebooks = [
 root = "."
 version_scheme = "no-guess-dev"
 local_scheme = "no-local-version"
-version_file = "src/{{ project_name }}/_version.py"
+version_file = "src/{{ python_package_name }}/_version.py"
 
 [tool.ruff]
 target-version = "py311"
@@ -95,4 +95,4 @@ formats = "ipynb,py:light"
 
 [tool.vulture]
 min_confidence = 90
-paths = [ "src/{{ project_name }}", "tests" ]
+paths = [ "src/{{ python_package_name }}", "tests" ]

src/notebooks/example_notebook.ipynb.jinja

@@ -31,7 +31,7 @@
    "outputs": [],
    "source": [
     "# show an import from a local package\n",
-    "from {{ project_name }} import show_message"
+    "from {{ python_package_name }} import show_message"
    ]
   },
   {

src/notebooks/example_notebook.py.jinja

@@ -30,7 +30,7 @@
 # Clicking it applies the formatting to the notebook.
 
 # show an import from a local package
-from {{ project_name }} import show_message
+from {{ python_package_name }} import show_message
 
 # use the function within the notebook to show it works
 show_message("Hello, notebook!")

src/{{ project_name }}/__init__.py src/{{ python_package_name }}/__init__.pysrc/{{ project_name }}/__init__.py renamed to src/{{ python_package_name }}/__init__.py

@@ -1,13 +1,13 @@
 """
-CLI for nviz
+CLI for {{ python_package_name }}
 """
 
 import fire
 
-from {{ project_name }}.main import show_message
+from {{ python_package_name }}.main import show_message
 
 
-class {{ project_name }}CLI:
+class {{ python_package_name }}CLI:
     def show_message(
         self,
         message: str = "Hello, world!",
@@ -33,4 +33,4 @@ def trigger() -> None:
     """
     Trigger the CLI to run.
     """
-    fire.Fire({{ project_name }}CLI)
+    fire.Fire({{ python_package_name }}CLI)