ENH: composite widget pipeline

.github/PULL_REQUEST_TEMPLATE.md

@@ -15,6 +15,15 @@
 <!--  Include where the changes made have been documented. -->
 <!--  This can simply be  a comment in the code or updating a docstring -->
 
-<!--
-## Screenshots (if appropriate):
--->
+## Screenshots
+<!--  Include a screenshot of the related widgets in designer and in pydm -->
+
+## Pre-merge Checklist
+- [ ] Screenshots of these widgets in designer are included above (`try_in_designer.sh`)
+- [ ] Screenshots of these widgets working in PyDM are included above (`try_in_pydm.sh`)
+- [ ] Code works interactively
+- [ ] Code contains descriptive docstrings, including context and API
+- [ ] New/changed functions and methods are covered in the test suite where possible
+- [ ] New/changed widgets are part of the test suite (semi-automatic)
+- [ ] Test suite passes locally
+- [ ] Test suite passes on GitHub Actions

.github/workflows/standard.yml

@@ -20,6 +20,8 @@ jobs:
       # Extras to be installed only for conda-based testing:
       conda-testing-extras: ""
       # Extras to be installed only for pip-based testing:
-      pip-testing-extras: ""
+      pip-testing-extras: "PyQt5"
+      # Extras to be installed only for docs builds (pip)
+      docs-build-extras: "PyQt5"
       # Set if using setuptools-scm for the conda-build workflow
       use-setuptools-scm: true

.gitignore

@@ -76,9 +76,6 @@ target/
 # Jupyter Notebook
 .ipynb_checkpoints
 
-# pyenv
-.python-version
-
 # celery beat schedule file
 celerybeat-schedule
 
@@ -106,3 +103,13 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+# setuptools_scm
+*/_version.py
+
+# pyuic5
+**/ui/*.py
+!**/ui/__init__.py
+
+# vscode
+.vscode/*

.pre-commit-config.yaml

@@ -6,28 +6,25 @@ exclude: |
   )$
 
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
-    hooks:
-    -   id: no-commit-to-branch
-    -   id: trailing-whitespace
-    -   id: end-of-file-fixer
-    -   id: check-ast
-    -   id: check-case-conflict
-    -   id: check-json
-    -   id: check-merge-conflict
-    -   id: check-symlinks
-    -   id: check-xml
-    -   id: check-yaml
-        exclude: '^(conda-recipe/meta.yaml)$'
-    -   id: debug-statements
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+  -   id: no-commit-to-branch
+  -   id: trailing-whitespace
+  -   id: end-of-file-fixer
+  -   id: check-ast
+  -   id: check-case-conflict
+  -   id: check-json
+  -   id: check-merge-conflict
+  -   id: check-symlinks
+  -   id: check-xml
+  -   id: check-yaml
+      exclude: '^(conda-recipe/meta.yaml)$'
+  -   id: debug-statements
 
--   repo: https://github.com/pycqa/flake8.git
-    rev: 7.2.0
-    hooks:
-    -   id: flake8
-
--   repo: https://github.com/timothycrosley/isort
-    rev: 6.0.1
-    hooks:
-    -   id: isort
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.15.6
+  hooks:
+  - id: ruff-check  # run the linter
+    args: [ --fix ]  # and the safe fixes
+  - id: ruff-format  # run the formatter

.python-version

@@ -0,0 +1 @@
+3.12

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2023, The Board of Trustees of the Leland Stanford Junior
+Copyright (c) 2026, The Board of Trustees of the Leland Stanford Junior
 University, through SLAC National Accelerator Laboratory (subject to receipt
 of any required approvals from the U.S. Dept. of Energy). All rights reserved.
 Redistribution and use in source and binary forms, with or without

MANIFEST.in

@@ -1,11 +1,5 @@
-include pcdswidgets/_version.py
-
 include AUTHORS.rst
 include CONTRIBUTING.rst
 include LICENSE.md
 include MANIFEST.in
 include README.md
-
-include dev-requirements.txt
-include docs-requirements.txt
-include requirements.txt

Makefile

@@ -0,0 +1,51 @@
+.PHONY: all build inits venv
+
+UI_SOURCE := $(wildcard pcdswidgets/ui/*/*/*.ui)
+PY_SOURCE := $(filter-out pcdswidgets/builder/ui/%.py, $(filter-out pcdswidgets/_version.py, $(shell find pcdswidgets -name "*.py")))
+
+PY_FORM := $(UI_SOURCE:pcdswidgets/ui/%.ui=pcdswidgets/generated/%_form.py)
+PY_BASE := $(UI_SOURCE:pcdswidgets/ui/%.ui=pcdswidgets/generated/%_base.py)
+PY_MAIN := $(UI_SOURCE:pcdswidgets/ui/%.ui=pcdswidgets/%.py)
+
+BIN := .venv/bin
+BUILD_CMD := $(BIN)/python -m pcdswidgets.builder.build
+CHECK_FIX := $(BIN)/ruff check --exit-zero --fix --quiet
+FORMAT := $(BIN)/ruff format --quiet
+
+# We need to update the venv before doing any step and after doing all of them
+# The order matters here, except the py files in the build target could be done in any order
+all:
+	$(MAKE) venv
+	$(MAKE) build
+	$(MAKE) inits
+	$(MAKE) pyproject.toml
+	$(MAKE) venv
+
+build: $(PY_FORM) $(PY_BASE) $(PY_MAIN) inits
+
+# Need to re-run form and base if the ui file is updated
+$(PY_FORM): pcdswidgets/generated/%_form.py: pcdswidgets/ui/%.ui
+	$(BUILD_CMD) uic $^
+	$(CHECK_FIX) $@
+	$(FORMAT) $@
+
+$(PY_BASE): pcdswidgets/generated/%_base.py: pcdswidgets/ui/%.ui
+	$(BUILD_CMD) base $^
+	$(CHECK_FIX) $@
+	$(FORMAT) $@
+
+# Only run if the target is missing: user can edit these
+$(PY_MAIN):
+	$(BUILD_CMD) main $(@:pcdswidgets/%.py=pcdswidgets/ui/%.ui)
+	$(CHECK_FIX) $@
+	$(FORMAT) $@
+
+inits:
+	$(BIN)/python -m pcdswidgets.builder.inits
+
+# Rerun if any python file is updated
+pyproject.toml: $(PY_SOURCE)
+	$(BIN)/python -m pcdswidgets.builder.entrypoint_finder
+
+venv:
+	./build_local_venv.sh