pyqt-reactive 0.1.3__tar.gz

pyqt_reactive-0.1.3/.github/workflows/ci.yml

@@ -0,0 +1,108 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master, claude/**]
+  pull_request:
+    branches: [main, master]
+  workflow_dispatch:
+
+jobs:
+  # Test across Python versions and OSes
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install system dependencies (Linux)
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xfixes0 x11-utils libegl1
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run tests with coverage
+        run: |
+          pytest --cov=pyqt_reactive --cov-report=xml --cov-report=html --cov-report=term-missing -v
+
+      - name: Upload coverage to Codecov
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v3
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false
+
+  # Code quality checks
+  code-quality:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff black mypy
+
+      - name: Run ruff (linting)
+        run: |
+          ruff check src/ --output-format=github
+
+      - name: Run black (formatting check)
+        run: |
+          black --check src/
+
+      - name: Run mypy (type checking)
+        run: |
+          mypy src/ --ignore-missing-imports
+
+  # Documentation build check
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[docs]"
+
+      - name: Build documentation
+        run: |
+          cd docs
+          make html
+
+      - name: Check for build warnings
+        run: |
+          cd docs
+          make html SPHINXOPTS="-W --keep-going"
+

pyqt_reactive-0.1.3/.github/workflows/publish.yml

@@ -0,0 +1,51 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: write
+  id-token: write  # Required for trusted publishing
+
+jobs:
+  build-and-publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pyqt-reactive
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check distribution
+        run: |
+          pip install twine
+          twine check dist/*
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pyqt_reactive-0.1.3/.gitignore

@@ -0,0 +1,102 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Ruff
+.ruff_cache/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+

pyqt_reactive-0.1.3/.readthedocs.yml

@@ -0,0 +1,20 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

pyqt_reactive-0.1.3/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+## [0.1.0] - 2025-01-10
+
+### Added
+- Initial release extracted from OpenHCS
+- Core utilities layer (DebounceTimer, ReorderableListWidget, BackgroundTask, etc.)
+- Theming system (ColorScheme, PaletteManager, StyleSheetGenerator)
+- Widget protocols and adapters (ABC-based contracts)
+- Extended widgets (NoScrollSpinBox, NoneAwareCheckBox, etc.)
+- Animation system (FlashMixin, WindowFlashOverlay, GlobalFlashCoordinator)
+- Service layer (SignalService, WidgetService, ValueCollectionService, etc.)
+- Widget factory infrastructure
+- ParameterFormManager with ObjectState integration
+- Comprehensive test suite
+- Sphinx documentation
+
+### Dependencies
+- PyQt6 >= 6.4.0
+- objectstate >= 0.1.0
+- python-introspect >= 0.1.0

pyqt_reactive-0.1.3/JOSS_READINESS.md

@@ -0,0 +1,65 @@
+# JOSS Readiness Assessment for pyqt-reactor
+
+## Summary
+**Status**: ~70% ready for JOSS submission. Strong paper and documentation, but needs improvements in testing and contribution guidelines.
+
+## ✅ Strengths
+
+### Paper (paper.md)
+- ✅ Clear statement of need with comparison table
+- ✅ Well-articulated software design sections
+- ✅ Real-world application (OpenHCS) demonstrates impact
+- ✅ AI disclosure included
+- ✅ Proper YAML frontmatter with author/affiliation
+- ✅ References section (though needs expansion)
+
+### Documentation
+- ✅ Comprehensive Sphinx docs with multiple sections
+- ✅ Quick start guide with working examples
+- ✅ Architecture documentation
+- ✅ API reference (auto-generated from docstrings)
+- ✅ State management and undo/redo guides
+- ✅ Multiple usage examples
+- ✅ ReadTheDocs integration
+
+### Code Quality
+- ✅ MIT License
+- ✅ Python 3.11+ support
+- ✅ Type hints throughout
+- ✅ Proper package structure
+- ✅ Dependencies clearly specified
+
+## ⚠️ Critical Gaps
+
+### 1. Testing (CRITICAL)
+**Current**: Only 7 test functions across 95 lines
+**Needed**: Expand to 20+ tests covering:
+- Form generation from dataclasses
+- Widget creation and value collection
+- FieldChangeDispatcher
+- WindowManager
+- Theming system
+- ObjectState integration
+
+### 2. Contributing Guidelines (IMPORTANT)
+**Current**: README mentions CONTRIBUTING.md but file doesn't exist
+**Needed**: Create CONTRIBUTING.md with development setup, code style, testing requirements
+
+### 3. Paper References (IMPORTANT)
+**Current**: Only 3 references
+**Needed**: Add citations for PyQt6, ObjectState, python-introspect, related frameworks
+
+### 4. CI/CD Workflows (IMPORTANT)
+**Current**: None
+**Needed**: GitHub Actions for testing, coverage, linting
+
+## Recommendation
+
+**Ready to submit after addressing**:
+1. Expand test suite (minimum 20+ tests)
+2. Create CONTRIBUTING.md
+3. Expand paper.bib with 5+ additional references
+4. Add GitHub Actions CI workflow
+
+**Estimated effort**: 10-17 hours to reach 90%+ readiness
+

pyqt_reactive-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tristan Simas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyqt_reactive-0.1.3/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: pyqt-reactive
+Version: 0.1.3
+Summary: React-quality reactive form generation framework for PyQt6
+Project-URL: Homepage, https://github.com/OpenHCSDev/pyqt-reactive
+Project-URL: Documentation, https://pyqt-reactive.readthedocs.io
+Project-URL: Repository, https://github.com/OpenHCSDev/pyqt-reactive
+Project-URL: Issues, https://github.com/OpenHCSDev/pyqt-reactive/issues
+Author-email: Tristan Simas <tristan.simas@mail.mcgill.ca>
+License: MIT
+License-File: LICENSE
+Keywords: dataclass,forms,gui,pyqt6,reactive,widgets
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.11
+Requires-Dist: objectstate>=0.1.0
+Requires-Dist: pyqt6>=6.4.0
+Requires-Dist: python-introspect>=0.1.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0; extra == 'dev'
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest-qt>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: sphinx-autodoc-typehints>=1.25; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'docs'
+Requires-Dist: sphinx>=7.0; extra == 'docs'
+Provides-Extra: magicgui
+Requires-Dist: magicgui>=0.7.0; extra == 'magicgui'
+Description-Content-Type: text/markdown
+
+# pyqt-reactor
+
+**React-quality reactive form generation framework for PyQt6**
+
+[![PyPI version](https://badge.fury.io/py/pyqt-reactor.svg)](https://badge.fury.io/py/pyqt-reactor)
+[![Documentation Status](https://readthedocs.org/projects/pyqt-reactor/badge/?version=latest)](https://pyqt-reactor.readthedocs.io/en/latest/?badge=latest)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- **Dataclass-Driven Forms**: Automatically generate UI forms from Python dataclasses
+- **ObjectState Integration**: First-class support for lazy configuration and hierarchical inheritance
+- **ABC-Based Protocols**: Type-safe widget contracts with clean interfaces
+- **Reactive Updates**: React-style lifecycle hooks with cross-window synchronization
+- **Theming System**: ColorScheme-based styling with dynamic theme switching
+- **Flash Animations**: Game-engine inspired visual feedback for value changes
+- **Window Management**: Scoped window registry with navigation support
+
+## Quick Start
+
+```python
+from dataclasses import dataclass
+from PyQt6.QtWidgets import QApplication
+from pyqt_reactive.forms import ParameterFormManager
+
+@dataclass
+class ProcessingConfig:
+    input_path: str = ""
+    output_path: str = ""
+    num_workers: int = 4
+    enable_gpu: bool = False
+
+app = QApplication([])
+form = ParameterFormManager(ProcessingConfig)
+form.show()
+app.exec()
+```
+
+## Installation
+
+```bash
+pip install pyqt-reactor
+```
+
+For development:
+```bash
+git clone https://github.com/trissim/pyqt-reactor.git
+cd pyqt-reactor
+pip install -e ".[dev]"
+```
+
+## Architecture
+
+The package is organized in layers:
+
+```
+pyqt_reactive/
+├── core/        # Tier 1: Pure PyQt6 utilities
+├── protocols/   # Tier 2: Widget ABCs and adapters
+├── services/    # Tier 3: Reusable service layer
+├── forms/       # Tier 4: ParameterFormManager
+├── theming/     # Color schemes and styling
+├── widgets/     # Extended widget implementations
+└── animation/   # Flash effects and visual feedback
+```
+
+## Key Components
+
+### ParameterFormManager
+
+Auto-generates forms from dataclasses with full type support:
+
+```python
+from pyqt_reactive.forms import ParameterFormManager
+
+form = ParameterFormManager(MyConfig)
+config = form.collect_values()  # Get typed config back
+```
+
+### WindowManager
+
+Singleton window registry with scope-based navigation:
+
+```python
+from pyqt_reactive.services import WindowManager
+
+window = WindowManager.show_or_focus("config:plate1", lambda: ConfigWindow(...))
+WindowManager.navigate_to("config:plate1", field="exposure_time")
+```
+
+### Theming
+
+Dynamic theme switching with consistent styling:
+
+```python
+from pyqt_reactive.theming import ColorScheme, apply_theme
+
+apply_theme(widget, ColorScheme.DARK)
+```
+
+## Documentation
+
+Full documentation available at [pyqt-reactor.readthedocs.io](https://pyqt-reactor.readthedocs.io)
+
+## License
+
+MIT License - see LICENSE file for details
+
+## Contributing
+
+Contributions welcome! Please see CONTRIBUTING.md for guidelines.
+
+## Credits
+
+Developed by Tristan Simas. Extracted from [OpenHCS](https://github.com/trissim/openhcs) for general-purpose use.

pyqt_reactive-0.1.3/README.md

@@ -0,0 +1,116 @@
+# pyqt-reactor
+
+**React-quality reactive form generation framework for PyQt6**
+
+[![PyPI version](https://badge.fury.io/py/pyqt-reactor.svg)](https://badge.fury.io/py/pyqt-reactor)
+[![Documentation Status](https://readthedocs.org/projects/pyqt-reactor/badge/?version=latest)](https://pyqt-reactor.readthedocs.io/en/latest/?badge=latest)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- **Dataclass-Driven Forms**: Automatically generate UI forms from Python dataclasses
+- **ObjectState Integration**: First-class support for lazy configuration and hierarchical inheritance
+- **ABC-Based Protocols**: Type-safe widget contracts with clean interfaces
+- **Reactive Updates**: React-style lifecycle hooks with cross-window synchronization
+- **Theming System**: ColorScheme-based styling with dynamic theme switching
+- **Flash Animations**: Game-engine inspired visual feedback for value changes
+- **Window Management**: Scoped window registry with navigation support
+
+## Quick Start
+
+```python
+from dataclasses import dataclass
+from PyQt6.QtWidgets import QApplication
+from pyqt_reactive.forms import ParameterFormManager
+
+@dataclass
+class ProcessingConfig:
+    input_path: str = ""
+    output_path: str = ""
+    num_workers: int = 4
+    enable_gpu: bool = False
+
+app = QApplication([])
+form = ParameterFormManager(ProcessingConfig)
+form.show()
+app.exec()
+```
+
+## Installation
+
+```bash
+pip install pyqt-reactor
+```
+
+For development:
+```bash
+git clone https://github.com/trissim/pyqt-reactor.git
+cd pyqt-reactor
+pip install -e ".[dev]"
+```
+
+## Architecture
+
+The package is organized in layers:
+
+```
+pyqt_reactive/
+├── core/        # Tier 1: Pure PyQt6 utilities
+├── protocols/   # Tier 2: Widget ABCs and adapters
+├── services/    # Tier 3: Reusable service layer
+├── forms/       # Tier 4: ParameterFormManager
+├── theming/     # Color schemes and styling
+├── widgets/     # Extended widget implementations
+└── animation/   # Flash effects and visual feedback
+```
+
+## Key Components
+
+### ParameterFormManager
+
+Auto-generates forms from dataclasses with full type support:
+
+```python
+from pyqt_reactive.forms import ParameterFormManager
+
+form = ParameterFormManager(MyConfig)
+config = form.collect_values()  # Get typed config back
+```
+
+### WindowManager
+
+Singleton window registry with scope-based navigation:
+
+```python
+from pyqt_reactive.services import WindowManager
+
+window = WindowManager.show_or_focus("config:plate1", lambda: ConfigWindow(...))
+WindowManager.navigate_to("config:plate1", field="exposure_time")
+```
+
+### Theming
+
+Dynamic theme switching with consistent styling:
+
+```python
+from pyqt_reactive.theming import ColorScheme, apply_theme
+
+apply_theme(widget, ColorScheme.DARK)
+```
+
+## Documentation
+
+Full documentation available at [pyqt-reactor.readthedocs.io](https://pyqt-reactor.readthedocs.io)
+
+## License
+
+MIT License - see LICENSE file for details
+
+## Contributing
+
+Contributions welcome! Please see CONTRIBUTING.md for guidelines.
+
+## Credits
+
+Developed by Tristan Simas. Extracted from [OpenHCS](https://github.com/trissim/openhcs) for general-purpose use.

pyqt_reactive-0.1.3/docs/Makefile

@@ -0,0 +1,18 @@
+# Minimal makefile for Sphinx documentation
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)