0.3.1

Automatically generated by python-semantic-release

CHANGELOG.md

@@ -0,0 +1,78 @@
+# CHANGELOG
+
+
+## v0.3.1 (2025-05-06)
+
+### Bug Fixes
+
+- Modules in the right place
+  ([`e2b1db4`](https://gitea.psi.ch/bec/bec_plugin_copier_template/commit/e2b1db45442eb8dff410477273dace5e55669bbd))
+
+
+## v0.3.0 (2025-05-06)
+
+### Features
+
+- Add missing modules
+  ([`70e8ac0`](https://gitea.psi.ch/bec/bec_plugin_copier_template/commit/70e8ac0891e234ddd9e5e546072f5e13c4aea9e1))
+
+
+## v0.2.3 (2025-05-06)
+
+### Bug Fixes
+
+- Allow empty widget list
+  ([`b2ed638`](https://gitea.psi.ch/bec/bec_plugin_copier_template/commit/b2ed6381237632de6225b1a7b18798388bf83893))
+
+
+## v0.2.2 (2025-05-06)
+
+### Bug Fixes
+
+- Exclude changelog from template
+  ([`4b44b7b`](https://gitea.psi.ch/bec/bec_plugin_copier_template/commit/4b44b7b599c3f27af153120a8529a20d164393f3))
+
+
+## v0.2.1 (2025-05-06)
+
+### Bug Fixes
+
+- Ui xml template
+  ([`3641451`](https://gitea.psi.ch/bec/bec_plugin_copier_template/commit/3641451d1960bca1e1b64d016d4669f053519fc6))
+
+
+## v0.2.0 (2025-05-06)
+
+### Bug Fixes
+
+- Don't include default test widgets
+  ([`45a03e9`](https://gitea.psi.ch/bec/bec_plugin_copier_template/commit/45a03e9dec15dd988f229296f360b764634b6947))
+
+### Features
+
+- Add plugin widget template
+  ([`56b58f5`](https://gitea.psi.ch/bec/bec_plugin_copier_template/commit/56b58f58dbede707ee574fc0cc682b0b3723a11c))
+
+- Add release action
+  ([`ea95f2d`](https://gitea.psi.ch/bec/bec_plugin_copier_template/commit/ea95f2d97002e39dbaa9aec1d48b266b7a019b12))
+
+
+## v0.1.0 (2025-05-02)
+
+### Bug Fixes
+
+- Add branch input to CI template for child pipeline
+  ([`8d13fbd`](https://gitea.psi.ch/bec/bec_plugin_copier_template/commit/8d13fbdcda329f0361e3fcd58a6026a938325f23))
+
+- Fix auto update entry point for v2
+  ([`2270c61`](https://gitea.psi.ch/bec/bec_plugin_copier_template/commit/2270c61e69b2943444eec1158804b9b1598d0a02))
+
+### Build System
+
+- Add copier as dev dependency
+  ([`449dbbc`](https://gitea.psi.ch/bec/bec_plugin_copier_template/commit/449dbbce49f398eb5df44d31e13ec32234284f70))
+
+### Refactoring
+
+- Make a copier template from BEC plugin files
+  ([`a389984`](https://gitea.psi.ch/bec/bec_plugin_copier_template/commit/a389984d25daf978cf6ad1ff3a8664e1d656a6dd))

copier.yml

@@ -1,5 +1,10 @@
 _exclude:
     - ".gitea/"
+    - "CHANGELOG.md"
+# imports
+
+_jinja_extensions:
+- bec_lib.utils.copier_jinja_filters.CopierFilters
 
 # predefined values
 # make sure these have 'when: false' so that the questions are not asked and the items are not saved in answers.yml
@@ -21,7 +26,57 @@ project_name:
     type: str
     help: What is your project name?
 
+widget_plugins_input:
+    # Defines the list of plugin widgets, following:
+    # - name: widget name in snake case
+    #   use_ui: whether to generate a .ui file
+    type: yaml
+    multiline: true
+    default: []
+
+# derived from questions: single point of configuration for plugin class names etc.
+
+widget_plugins:
+    type: yaml
+    multiline: true
+    default: >
+             {% if not widget_plugins_input %} []
+             {% else %}
+             {% for wp in widget_plugins_input %}
+              - module: {{ wp.name }}                         # Module name for the whole plugin
+                class: {{ wp.name | snake_to_pascal }}        # Class name for the plugin widget
+                use_ui: {{ wp.use_ui }}                       # Whether to create a .ui file and import it
+                {% if wp.use_ui %}
+                ui_module: {{ wp.name }}_ui                   # Module name for the compiled python UI
+                ui_class: Ui_{{ wp.name | snake_to_pascal }}  # Class name for the compiled python UI
+                {% endif %}
+             {% endfor %}
+             {% endif %}
+    when: false
+
+
 # other configuration
 
+ui_fileinfo: # would like to save this programatically when generated but don't see how
+    type: yaml
+    multiline: true
+    default: >
+             {% if not widget_plugins %} []
+             {% else %}
+             {% for wp in widget_plugins %}
+              {% if wp.use_ui %}
+              - ui_file: {{ project_name }}/bec_widgets/widgets/{{ wp.module }}/{{ wp.module }}.ui
+                out_file: {{ project_name }}/bec_widgets/widgets/{{ wp.module }}/{{ wp.ui_module }}.py
+              {% endif %}
+             {% endfor %}
+             {% endif %}
+    when: false
+
 _tasks:
-    - "git init --initial-branch=main"
+    - "git init --initial-branch=main"
+    - >
+      {% if not ui_fileinfo %}
+      {% for info in ui_fileinfo %}pyside6-uic {{ info.ui_file }} -o {{ info.out_file }};
+      {% endfor %}
+      {% endif %}
+    - "git add -A; git commit -a -m 'Init repo {{ project_name }} at template version {{ _commit }}'"

{{_copier_conf.answers_file}}.jinja

@@ -1,2 +1,5 @@
-# Changes here will be overwritten by Copier!
+# Do not edit this file!
+# It is needed to track the repo template version, and editing may break things.
+# This file will be overwritten by copier on template updates.
+
 {{ _copier_answers|to_nice_yaml -}}

{{project_name}}/bec_widgets/widgets/{% yield widget_plugin from widget_plugins %}{{ widget_plugin.module }}{% endyield %}/{% if widget_plugin.use_ui %}{{ widget_plugin.module }}.ui{% endif %}.jinja

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+    <class>{{ widget_plugin.class | stash_filename }}</class>
+    <widget class="QWidget" name="{{ widget_plugin.class }}">
+    </widget>
+    <resources />
+    <connections />
+</ui>

{{project_name}}/bec_widgets/widgets/{% yield widget_plugin from widget_plugins %}{{ widget_plugin.module }}{% endyield %}/{{ widget_plugin.module }}.py.jinja

@@ -0,0 +1,11 @@
+from qtpy.QtWidgets import QWidget
+
+from bec_widgets.utils.bec_widget import BECWidget
+
+{% if widget_plugin.use_ui %}
+from {{ project_name }}.bec_widgets.widgets.{{ widget_plugin.module }}.{{ widget_plugin.ui_module }} import {{ widget_plugin.ui_class }}
+{% endif %}
+
+class {{ widget_plugin.class }}(BECWidget, QWidget{% if widget_plugin.use_ui %}, {{ widget_plugin.ui_class }}{% endif %}):
+    def __init__(self, parent=None):
+        super().__init__(parent=parent)