Merge pull request #28 from UlysseDurand/serve-version

jourdain · web-flow · commit 6b278330a707 · 2026-05-11T18:42:01.000-06:00
Put project version in the served umd.js file url
diff --git a/README.md b/README.md
@@ -41,11 +41,10 @@ The **project_type** can be only one of the following options:
     By default a simple vtk.js application is used as reference to provide
     the trame basic while demonstrating an interactive application with code
     separation between the Python core and the web frontend.
-    Whithin that Python package, a jupyter helper module will also be available
-    to run and show your application within a jupyter environment.
-    On top of that Python package, you will have access to several bundling
-    option ranging from a standalone executable to a docker image for cloud
-    deployment.
+    Within that Python package, a jupyter helper module will also be available
+    to run and show your application within a jupyter environment.  On top of
+    that Python package, you will have access to several bundling option ranging
+    from a standalone executable to a docker image for cloud deployment.
 * **App with Components**
     This will provide the same infrastructure as above but with an additional
     directory that will contain a vue.js project for defining new UI elements
diff --git a/{{cookiecutter.package_name}}/.pre-commit-config.yaml b/{{cookiecutter.package_name}}/.pre-commit-config.yaml
@@ -2,7 +2,7 @@ ci:
   autoupdate_commit_msg: "chore: update pre-commit hooks"
   autofix_commit_msg: "style: pre-commit fixes"
 
-exclude: ^.cruft.json|.copier-answers.yml$
+exclude: ^.cruft.json|.copier-answers.yml$|uv\.lock$
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
diff --git a/{{cookiecutter.package_name}}/README.rst b/{{cookiecutter.package_name}}/README.rst
@@ -26,17 +26,17 @@ Run the application
 
 {%- endif %}
 
-Developement setup
+Development setup
 ----------------------------------------
 
-We recommend using uv for setting up and managing a virtual environement for your development.
+We recommend using uv for setting up and managing a virtual environment for your development.
 
 .. code-block:: console
 
     # Create venv and install all dependencies
     uv sync --all-extras --dev
 
-    # Activate environement
+    # Activate environment
     source .venv/bin/activate
 {% if cookiecutter.include_ci %}
     # Install commit analysis
diff --git a/{{cookiecutter.package_name}}/src/trame/modules/{{cookiecutter.module_short_name}}.py b/{{cookiecutter.package_name}}/src/trame/modules/{{cookiecutter.module_short_name}}.py
@@ -1 +1 @@
-from {{cookiecutter.import_name}}.module import *
+from {{cookiecutter.import_name}}.module import *  # noqa: F403
diff --git a/{{cookiecutter.package_name}}/src/trame/widgets/{{cookiecutter.module_short_name}}.py b/{{cookiecutter.package_name}}/src/trame/widgets/{{cookiecutter.module_short_name}}.py
@@ -1,7 +1,7 @@
-from {{cookiecutter.import_name}}.widgets.{{cookiecutter.module_short_name}} import *
+from {{cookiecutter.import_name}}.widgets.{{cookiecutter.module_short_name}} import *  # noqa: F403
 
 
 def initialize(server):
-    from {{cookiecutter.import_name}} import module
+    from {{cookiecutter.import_name}} import module  # noqa: PLC0415
 
     server.enable_module(module)
diff --git a/{{cookiecutter.package_name}}/src/{{cookiecutter.import_name}}/module/__init__.py b/{{cookiecutter.package_name}}/src/{{cookiecutter.import_name}}/module/__init__.py
@@ -1,17 +1,20 @@
 from pathlib import Path
 
+from {{cookiecutter.import_name}} import __version__
+
 # Compute local path to serve
 serve_path = str(Path(__file__).with_name("serve").resolve())
+serve_directory = f"__{{cookiecutter.import_name}}_{__version__}"
 
 # Serve directory for JS/CSS files
-serve = {"__{{cookiecutter.import_name}}": serve_path}
+serve = {serve_directory: serve_path}
 
 # List of JS files to load (usually from the serve path above)
-scripts = ["__{{cookiecutter.import_name}}/{{cookiecutter.import_name}}.umd.js"]
+scripts = [f"{serve_directory}/{{cookiecutter.import_name}}.umd.js"]
 
 # List of CSS files to load (usually from the serve path above)
 if (Path(serve_path) / "style.css").exists():
-    styles = ["__{{cookiecutter.import_name}}/style.css"]
+    styles = [serve_directory + "/style.css"]
 
 # List of Vue plugins to install/load
 vue_use = ["{{cookiecutter.import_name}}"]
@@ -23,4 +26,3 @@
 # Optional if you want to execute custom initialization at module load
 def setup(app, **kwargs):
     """Method called at initialization with possibly some custom keyword arguments"""
-    pass
diff --git a/{{cookiecutter.package_name}}/tests/test_import.py b/{{cookiecutter.package_name}}/tests/test_import.py
@@ -3,10 +3,10 @@ def test_import():
     from {{ cookiecutter.import_name }}.app import main  # noqa: F401
 {%- endif %}
 {%- if cookiecutter.include_components %}
-    from {{ cookiecutter.import_name }}.widgets.{{ cookiecutter.module_short_name }} import CustomWidget  # noqa: F401
+    from {{ cookiecutter.import_name }}.widgets.{{ cookiecutter.module_short_name }} import CustomWidget  # noqa: F401, PLC0415
 {%- endif %}
 {%- if cookiecutter.include_components_only %}
 
     # For components only, the CustomWidget is also importable via trame
-    from trame.widgets.{{ cookiecutter.import_name }} import CustomWidget  # noqa: F401,F811
+    from trame.widgets.{{ cookiecutter.import_name }} import CustomWidget  # noqa: F401, PLC0415, F811
 {%- endif %}

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-from {{cookiecutter.import_name}}.module import *`
	`1`	`+from {{cookiecutter.import_name}}.module import * # noqa: F403`