cad-widgets 0.1.0__tar.gz

cad_widgets-0.1.0/.github/workflows/build-publish.yml

@@ -0,0 +1,75 @@
+name: Build and Publish
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Build on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ['3.12']
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build hatchling
+      
+      - name: Build package
+        run: python -m build
+      
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist-${{ matrix.os }}-py${{ matrix.python-version }}
+          path: dist/*
+          retention-days: 7
+
+
+  publish:
+    name: Publish to PyPI
+    needs: [build]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/cad-widgets
+    permissions:
+      contents: read  # Required for actions/checkout
+      id-token: write  # Required for trusted publishing
+    
+    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 hatchling
+      
+      - name: Build package
+        run: python -m build
+      
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true
+          verbose: true

cad_widgets-0.1.0/.gitignore

@@ -0,0 +1,52 @@
+# 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
+
+# Virtual environments
+venv/
+env/
+ENV/
+.venv
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Pytest
+.pytest_cache/
+
+# Coverage
+htmlcov/
+.coverage
+.coverage.*
+coverage.xml
+*.cover

cad_widgets-0.1.0/.python-version

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

cad_widgets-0.1.0/PKG-INFO

@@ -0,0 +1,229 @@
+Metadata-Version: 2.4
+Name: cad-widgets
+Version: 0.1.0
+Summary: OpenCascade PySide6 3D CAD viewer widgets with modular architecture
+Project-URL: Homepage, https://github.com/gcmartins/cad-widgets
+Project-URL: Repository, https://github.com/gcmartins/cad-widgets
+Author: CAD Widgets Contributors
+Keywords: 3d,cad,opencascade,pyside6,viewer,widget
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Requires-Dist: cadquery-ocp-stubs>=7.9.3.1
+Requires-Dist: cadquery-ocp>=7.7.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: pyside6>=6.6.0
+Description-Content-Type: text/markdown
+
+# CAD Widgets
+
+A Python library for building 3D CAD viewers with PySide6 and OpenCascade (OCP). Features a clean, modular architecture with reusable components and signal-based communication.
+
+![Python Version](https://img.shields.io/badge/python-3.12+-blue.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+
+## Features
+
+- 🎨 **Modular Architecture** - Layered design with widgets, services, managers, and models
+- 🖱️ **Smooth Interaction** - Flicker-free rotation, panning, and zooming
+- 🎯 **Multiple View Modes** - Perspective/orthographic projections, standard views
+- 🎨 **Display Modes** - Shaded, wireframe, or combination rendering
+- 🌳 **Geometry Management** - Tree view with visibility controls and property editing
+- ✂️ **Boolean Operations** - Union, subtraction, and intersection operations
+- 🎯 **Advanced Selection** - Volume, surface, edge, and vertex selection modes
+- 🔧 **Shape Creation** - Clean API for boxes, spheres, cylinders, cones, and tori
+- 🧪 **Well Tested** - Comprehensive test suite with >90% coverage
+- 📚 **Documented** - Extensive documentation and examples
+- 🖥️ **Cross-Platform** - Works on Linux (X11), Windows, and macOS
+
+## Quick Start
+
+### Installation
+
+```bash
+# Clone the repository
+git clone <repository-url>
+cd cad_widgets
+
+# Install dependencies using uv (recommended)
+uv sync
+source .venv/bin/activate
+
+# Or using pip
+pip install -e .
+```
+
+### Simple Example
+
+```python
+from PySide6.QtWidgets import QApplication
+from cad_widgets import OCPWidget, GeometryService
+
+app = QApplication([])
+
+viewer = OCPWidget()
+viewer.resize(800, 600)
+
+geo = GeometryService()
+box = geo.create_box(100, 100, 100)
+viewer.display_shape(box, color=(0.8, 0.2, 0.2))
+viewer.fit_all()
+
+viewer.show()
+app.exec()
+```
+
+### Running Examples
+
+```bash
+# Full-featured modular example with all widgets
+python examples/example_modular.py
+```
+
+## Project Structure
+
+```
+cad_widgets/
+├── src/
+│   └── cad_widgets/                     # Main package
+│       ├── __init__.py                  # Package exports
+│       ├── enums.py                     # Enums for display and selection
+│       ├── widgets/                     # UI Widget components
+│       │   ├── ocp_widget.py            # Core 3D viewer
+│       │   ├── view_toolbar.py          # View controls toolbar
+│       │   ├── selection_toolbar.py     # Selection mode toolbar
+│       │   ├── geometry_tree.py         # Geometry tree view
+│       │   └── property_editor.py       # Property editor panel
+│       ├── services/                    # Service layer
+│       │   ├── geometry_service.py      # Shape creation/manipulation
+│       │   ├── view_service.py          # View and display management
+│       │   └── selection_service.py     # Selection handling
+│       ├── managers/                    # Business logic layer
+│       │   └── geometry_manager.py      # Geometry lifecycle management
+│       └── models/                      # Data models
+│           └── shape_properties.py      # Property classes
+├── examples/                            # Example applications
+│   └── example_modular.py               # Full-featured example
+├── tests/                               # Comprehensive test suite
+├── docs/                                # Documentation
+│   └── ARCHITECTURE.md                  # Architecture guide
+└── pyproject.toml                       # Project configuration
+```
+
+## Architecture
+
+CAD Widgets follows a clean, layered architecture with clear separation of concerns:
+
+- **Widget Layer** - UI components (OCPWidget, toolbars, tree view, property editor)
+- **Manager Layer** - High-level orchestration (GeometryManager)
+- **Service Layer** - Business logic (GeometryService, ViewService, SelectionService)
+- **Models Layer** - Data structures (ShapeProperties, Translation, Rotation)
+
+Components communicate through Qt signals for loose coupling and reusability. See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for detailed architectural documentation including patterns, component details, and extension points.
+
+## Mouse Controls
+
+- **Left Click + Drag**: Rotate view
+- **Middle Click + Drag**: Pan view
+- **Scroll Wheel**: Zoom in/out
+
+## API Reference
+
+For a complete API reference including all widget methods, signals, service methods, and enums, see [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md#api-reference).
+
+## Dependencies
+
+- **PySide6** ≥ 6.6.0 - Qt for Python GUI framework
+- **cadquery-ocp** ≥ 7.7.0 - OpenCascade Python bindings
+- **numpy** ≥ 1.24.0 - Numerical operations
+
+## Development
+
+### Quick Start
+
+```bash
+# Run tests
+pytest tests/
+
+# Run with coverage
+pytest tests/ --cov=cad_widgets
+
+# Type check
+mypy src/cad_widgets
+
+# Lint and format
+ruff check src tests examples
+ruff format src tests examples
+
+# Run all checks
+uv run invoke check
+```
+
+For detailed development guidelines, testing strategies, and contributing instructions, see [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md#testing).
+
+## Documentation
+
+- **[Architecture Guide](docs/ARCHITECTURE.md)** - Detailed architecture documentation
+- **Examples** - See `examples/` directory for complete applications
+
+## Troubleshooting
+
+### Qt DBus Warnings (Linux)
+
+Suppress harmless DBus warnings:
+
+```bash
+export QT_LOGGING_RULES='qt.qpa.theme.gnome=false'
+python examples/example_modular.py
+```
+
+Or in code:
+
+```python
+import os
+os.environ['QT_LOGGING_RULES'] = 'qt.qpa.theme.gnome=false'
+```
+
+### Import Errors
+
+Ensure dependencies are installed:
+
+```bash
+uv sync  # or pip install -e .
+```
+
+### Display Issues
+
+- Verify OpenGL support is available on your system
+- Check console for error messages
+- Try different Qt platform plugins if available
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Follow the existing architecture patterns
+2. Use signals for component communication
+3. Add tests for new features
+4. Update documentation
+5. Run `ruff check --fix` before committing
+
+## License
+
+This project is provided as-is for educational and development purposes.
+
+## Resources
+
+- [OCP Documentation](https://github.com/CadQuery/OCP)
+- [PySide6 Documentation](https://doc.qt.io/qtforpython/)
+- [OpenCascade Documentation](https://dev.opencascade.org/)
+
+## Acknowledgments
+
+Built with:
+- [OpenCascade](https://www.opencascade.com/) - 3D modeling kernel
+- [PySide6](https://wiki.qt.io/Qt_for_Python) - Qt for Python
+- [CadQuery OCP](https://github.com/CadQuery/OCP) - Python bindings for OpenCascade

cad_widgets-0.1.0/README.md

@@ -0,0 +1,209 @@
+# CAD Widgets
+
+A Python library for building 3D CAD viewers with PySide6 and OpenCascade (OCP). Features a clean, modular architecture with reusable components and signal-based communication.
+
+![Python Version](https://img.shields.io/badge/python-3.12+-blue.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+
+## Features
+
+- 🎨 **Modular Architecture** - Layered design with widgets, services, managers, and models
+- 🖱️ **Smooth Interaction** - Flicker-free rotation, panning, and zooming
+- 🎯 **Multiple View Modes** - Perspective/orthographic projections, standard views
+- 🎨 **Display Modes** - Shaded, wireframe, or combination rendering
+- 🌳 **Geometry Management** - Tree view with visibility controls and property editing
+- ✂️ **Boolean Operations** - Union, subtraction, and intersection operations
+- 🎯 **Advanced Selection** - Volume, surface, edge, and vertex selection modes
+- 🔧 **Shape Creation** - Clean API for boxes, spheres, cylinders, cones, and tori
+- 🧪 **Well Tested** - Comprehensive test suite with >90% coverage
+- 📚 **Documented** - Extensive documentation and examples
+- 🖥️ **Cross-Platform** - Works on Linux (X11), Windows, and macOS
+
+## Quick Start
+
+### Installation
+
+```bash
+# Clone the repository
+git clone <repository-url>
+cd cad_widgets
+
+# Install dependencies using uv (recommended)
+uv sync
+source .venv/bin/activate
+
+# Or using pip
+pip install -e .
+```
+
+### Simple Example
+
+```python
+from PySide6.QtWidgets import QApplication
+from cad_widgets import OCPWidget, GeometryService
+
+app = QApplication([])
+
+viewer = OCPWidget()
+viewer.resize(800, 600)
+
+geo = GeometryService()
+box = geo.create_box(100, 100, 100)
+viewer.display_shape(box, color=(0.8, 0.2, 0.2))
+viewer.fit_all()
+
+viewer.show()
+app.exec()
+```
+
+### Running Examples
+
+```bash
+# Full-featured modular example with all widgets
+python examples/example_modular.py
+```
+
+## Project Structure
+
+```
+cad_widgets/
+├── src/
+│   └── cad_widgets/                     # Main package
+│       ├── __init__.py                  # Package exports
+│       ├── enums.py                     # Enums for display and selection
+│       ├── widgets/                     # UI Widget components
+│       │   ├── ocp_widget.py            # Core 3D viewer
+│       │   ├── view_toolbar.py          # View controls toolbar
+│       │   ├── selection_toolbar.py     # Selection mode toolbar
+│       │   ├── geometry_tree.py         # Geometry tree view
+│       │   └── property_editor.py       # Property editor panel
+│       ├── services/                    # Service layer
+│       │   ├── geometry_service.py      # Shape creation/manipulation
+│       │   ├── view_service.py          # View and display management
+│       │   └── selection_service.py     # Selection handling
+│       ├── managers/                    # Business logic layer
+│       │   └── geometry_manager.py      # Geometry lifecycle management
+│       └── models/                      # Data models
+│           └── shape_properties.py      # Property classes
+├── examples/                            # Example applications
+│   └── example_modular.py               # Full-featured example
+├── tests/                               # Comprehensive test suite
+├── docs/                                # Documentation
+│   └── ARCHITECTURE.md                  # Architecture guide
+└── pyproject.toml                       # Project configuration
+```
+
+## Architecture
+
+CAD Widgets follows a clean, layered architecture with clear separation of concerns:
+
+- **Widget Layer** - UI components (OCPWidget, toolbars, tree view, property editor)
+- **Manager Layer** - High-level orchestration (GeometryManager)
+- **Service Layer** - Business logic (GeometryService, ViewService, SelectionService)
+- **Models Layer** - Data structures (ShapeProperties, Translation, Rotation)
+
+Components communicate through Qt signals for loose coupling and reusability. See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for detailed architectural documentation including patterns, component details, and extension points.
+
+## Mouse Controls
+
+- **Left Click + Drag**: Rotate view
+- **Middle Click + Drag**: Pan view
+- **Scroll Wheel**: Zoom in/out
+
+## API Reference
+
+For a complete API reference including all widget methods, signals, service methods, and enums, see [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md#api-reference).
+
+## Dependencies
+
+- **PySide6** ≥ 6.6.0 - Qt for Python GUI framework
+- **cadquery-ocp** ≥ 7.7.0 - OpenCascade Python bindings
+- **numpy** ≥ 1.24.0 - Numerical operations
+
+## Development
+
+### Quick Start
+
+```bash
+# Run tests
+pytest tests/
+
+# Run with coverage
+pytest tests/ --cov=cad_widgets
+
+# Type check
+mypy src/cad_widgets
+
+# Lint and format
+ruff check src tests examples
+ruff format src tests examples
+
+# Run all checks
+uv run invoke check
+```
+
+For detailed development guidelines, testing strategies, and contributing instructions, see [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md#testing).
+
+## Documentation
+
+- **[Architecture Guide](docs/ARCHITECTURE.md)** - Detailed architecture documentation
+- **Examples** - See `examples/` directory for complete applications
+
+## Troubleshooting
+
+### Qt DBus Warnings (Linux)
+
+Suppress harmless DBus warnings:
+
+```bash
+export QT_LOGGING_RULES='qt.qpa.theme.gnome=false'
+python examples/example_modular.py
+```
+
+Or in code:
+
+```python
+import os
+os.environ['QT_LOGGING_RULES'] = 'qt.qpa.theme.gnome=false'
+```
+
+### Import Errors
+
+Ensure dependencies are installed:
+
+```bash
+uv sync  # or pip install -e .
+```
+
+### Display Issues
+
+- Verify OpenGL support is available on your system
+- Check console for error messages
+- Try different Qt platform plugins if available
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Follow the existing architecture patterns
+2. Use signals for component communication
+3. Add tests for new features
+4. Update documentation
+5. Run `ruff check --fix` before committing
+
+## License
+
+This project is provided as-is for educational and development purposes.
+
+## Resources
+
+- [OCP Documentation](https://github.com/CadQuery/OCP)
+- [PySide6 Documentation](https://doc.qt.io/qtforpython/)
+- [OpenCascade Documentation](https://dev.opencascade.org/)
+
+## Acknowledgments
+
+Built with:
+- [OpenCascade](https://www.opencascade.com/) - 3D modeling kernel
+- [PySide6](https://wiki.qt.io/Qt_for_Python) - Qt for Python
+- [CadQuery OCP](https://github.com/CadQuery/OCP) - Python bindings for OpenCascade