velocity-previewer 1.1.0__tar.gz

velocity_previewer-1.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 VM Visualizer Team
+
+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.

velocity_previewer-1.1.0/PKG-INFO

@@ -0,0 +1,192 @@
+Metadata-Version: 2.4
+Name: velocity-previewer
+Version: 1.1.0
+Summary: A modern, feature-rich PyQt5 application for previewing and rendering Velocity templates with real-time syntax highlighting, validation, and export capabilities.
+Author: Josh Simnitt
+License: MIT
+Project-URL: Homepage, https://github.com/star7js/velocity-previewer
+Project-URL: Repository, https://github.com/star7js/velocity-previewer
+Project-URL: Documentation, https://github.com/star7js/velocity-previewer#readme
+Project-URL: Issues, https://github.com/star7js/velocity-previewer/issues
+Keywords: velocity,template,previewer,pyqt5,gui,syntax-highlighting
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Markup :: HTML
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: airspeed>=0.6.0
+Requires-Dist: pyqt5>=5.15.11
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: flake8>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: PyQt5-stubs>=5.15; extra == "dev"
+Dynamic: license-file
+
+# Velocity Template Previewer
+
+[![CI](https://github.com/star7js/velocity-previewer/actions/workflows/ci.yml/badge.svg)](https://github.com/star7js/velocity-previewer/actions/workflows/ci.yml) [![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/) ![PyQt5](https://img.shields.io/badge/PyQt5-5.15+-41CD52?logo=qt&logoColor=white)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Desktop application for previewing and rendering Apache Velocity templates with real-time syntax highlighting and validation. Perfect for developers working with Atlassian products (Jira, Confluence), ScriptRunner, email templates, and web applications.
+
+![Velocity Template Previewer](examples/example-template-render.png)
+
+## What is This?
+
+Apache Velocity is a Java-based template engine commonly used in:
+- **Atlassian Products**: Jira email templates, Confluence macros, ScriptRunner scripts
+- **Email Systems**: Dynamic email generation
+- **Web Applications**: Server-side templating
+- **Code Generation**: Template-based code scaffolding
+
+This tool lets you preview and test your Velocity templates instantly without deploying to production.
+
+## Features
+
+- **Real-time Preview**: See changes as you type
+- **Syntax Highlighting**: Color-coded templates and JSON data
+- **Validation**: Catch errors before deployment
+- **Background Rendering**: Smooth performance with large templates
+- **Auto-save**: Never lose your work (saves every 30 seconds)
+- **Export**: Generate static HTML from your templates
+- **Dark Mode**: Easy on the eyes
+- **Recent Files**: Quick access to your projects
+
+## Installation
+
+**Requirements:** Python 3.9+ (Windows, macOS, Linux)
+
+```bash
+git clone https://github.com/star7js/velocity-previewer.git
+cd velocity-previewer
+pip install -e .
+velocity-previewer
+```
+
+## Quick Start
+
+1. **Open a template**: File > Open or Ctrl+O
+2. **Add your data**: Switch to Data tab, paste JSON
+3. **Render**: Press F5
+4. **Export** (optional): File > Export to HTML
+
+Try the included `examples/example-template.vm` with `examples/example-data.json` to see it in action.
+
+## Use Cases
+
+### Atlassian/ScriptRunner Development
+Test Jira email notifications, Confluence macros, or ScriptRunner templates locally before deploying:
+
+```velocity
+#if($issue.priority.name == "Critical")
+  <span style="color: red;">$issue.key - $issue.summary</span>
+#end
+```
+
+### Email Template Design
+Preview dynamic email templates with test data:
+
+```velocity
+Hello $customer.name,
+
+Your order #$order.id has shipped!
+#foreach($item in $order.items)
+  - $item.name (Qty: $item.quantity)
+#end
+```
+
+### Dynamic Reports
+Generate reports from JSON data without manual formatting.
+
+## Keyboard Shortcuts
+
+| Action | Shortcut |
+|--------|----------|
+| Render Template | F5 |
+| Open Template | Ctrl+O |
+| Save Template | Ctrl+S |
+| Validate Template | Ctrl+Shift+V |
+| Validate Data | Ctrl+Shift+D |
+
+## Supported Velocity Syntax
+
+- **Variables**: `$variable`, `${variable}`
+- **Directives**: `#if`, `#foreach`, `#set`, `#macro`
+- **Comments**: `##` (single line), `#* ... *#` (multi-line)
+- **Properties**: `$object.property`, `$array[0]`
+- **Methods**: `$string.substring(0, 5)`
+
+Full Apache Velocity specification supported via Airspeed engine.
+
+## Platform Support
+
+- ✅ Windows 10/11
+- ✅ macOS 10.15+
+- ✅ Linux (Ubuntu, Fedora, Arch)
+
+## Development
+
+```bash
+# Install dependencies
+pip install -e .
+
+# Run tests
+pytest
+
+# Type check
+mypy src/
+
+# Project structure
+├── src/velocity_previewer/    # Main package
+│   ├── main.py                # Application UI and logic
+│   ├── renderer.py            # Background rendering & context building
+│   ├── styles.py              # Light/dark Qt stylesheets
+│   ├── utils.py               # Template processing
+│   └── syntax_highlighters.py # Syntax highlighting
+├── examples/                  # Example templates and data
+├── tests/                     # Test files
+└── pyproject.toml            # Project configuration
+```
+
+Settings (window size, recent files) are saved to:
+- **Windows**: `%APPDATA%/VelocityPreviewer`
+- **macOS**: `~/Library/Application Support/VelocityPreviewer`
+- **Linux**: `~/.config/VelocityPreviewer`
+
+## Troubleshooting
+
+| Issue | Solution |
+|-------|----------|
+| Template won't render | Use `Tools > Validate Template` (Ctrl+Shift+V) to see errors |
+| JSON parse errors | Use `Tools > Validate Data` (Ctrl+Shift+D) to check format |
+| Slow performance | Large templates render in background automatically |
+| App won't start | Ensure PyQt5 is installed: `pip install PyQt5` |
+
+## Roadmap
+
+- [ ] Live preview mode (render on every keystroke)
+- [ ] Multiple data sets for testing
+- [ ] Template snippet library
+- [ ] Velocity macro autocomplete
+
+## License
+
+MIT License
+
+## Built With
+
+- [PyQt5](https://www.riverbankcomputing.com/software/pyqt/) - Cross-platform UI framework
+- [Airspeed](https://github.com/purcell/airspeed) - Python implementation of Apache Velocity

velocity_previewer-1.1.0/README.md

@@ -0,0 +1,156 @@
+# Velocity Template Previewer
+
+[![CI](https://github.com/star7js/velocity-previewer/actions/workflows/ci.yml/badge.svg)](https://github.com/star7js/velocity-previewer/actions/workflows/ci.yml) [![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/) ![PyQt5](https://img.shields.io/badge/PyQt5-5.15+-41CD52?logo=qt&logoColor=white)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Desktop application for previewing and rendering Apache Velocity templates with real-time syntax highlighting and validation. Perfect for developers working with Atlassian products (Jira, Confluence), ScriptRunner, email templates, and web applications.
+
+![Velocity Template Previewer](examples/example-template-render.png)
+
+## What is This?
+
+Apache Velocity is a Java-based template engine commonly used in:
+- **Atlassian Products**: Jira email templates, Confluence macros, ScriptRunner scripts
+- **Email Systems**: Dynamic email generation
+- **Web Applications**: Server-side templating
+- **Code Generation**: Template-based code scaffolding
+
+This tool lets you preview and test your Velocity templates instantly without deploying to production.
+
+## Features
+
+- **Real-time Preview**: See changes as you type
+- **Syntax Highlighting**: Color-coded templates and JSON data
+- **Validation**: Catch errors before deployment
+- **Background Rendering**: Smooth performance with large templates
+- **Auto-save**: Never lose your work (saves every 30 seconds)
+- **Export**: Generate static HTML from your templates
+- **Dark Mode**: Easy on the eyes
+- **Recent Files**: Quick access to your projects
+
+## Installation
+
+**Requirements:** Python 3.9+ (Windows, macOS, Linux)
+
+```bash
+git clone https://github.com/star7js/velocity-previewer.git
+cd velocity-previewer
+pip install -e .
+velocity-previewer
+```
+
+## Quick Start
+
+1. **Open a template**: File > Open or Ctrl+O
+2. **Add your data**: Switch to Data tab, paste JSON
+3. **Render**: Press F5
+4. **Export** (optional): File > Export to HTML
+
+Try the included `examples/example-template.vm` with `examples/example-data.json` to see it in action.
+
+## Use Cases
+
+### Atlassian/ScriptRunner Development
+Test Jira email notifications, Confluence macros, or ScriptRunner templates locally before deploying:
+
+```velocity
+#if($issue.priority.name == "Critical")
+  <span style="color: red;">$issue.key - $issue.summary</span>
+#end
+```
+
+### Email Template Design
+Preview dynamic email templates with test data:
+
+```velocity
+Hello $customer.name,
+
+Your order #$order.id has shipped!
+#foreach($item in $order.items)
+  - $item.name (Qty: $item.quantity)
+#end
+```
+
+### Dynamic Reports
+Generate reports from JSON data without manual formatting.
+
+## Keyboard Shortcuts
+
+| Action | Shortcut |
+|--------|----------|
+| Render Template | F5 |
+| Open Template | Ctrl+O |
+| Save Template | Ctrl+S |
+| Validate Template | Ctrl+Shift+V |
+| Validate Data | Ctrl+Shift+D |
+
+## Supported Velocity Syntax
+
+- **Variables**: `$variable`, `${variable}`
+- **Directives**: `#if`, `#foreach`, `#set`, `#macro`
+- **Comments**: `##` (single line), `#* ... *#` (multi-line)
+- **Properties**: `$object.property`, `$array[0]`
+- **Methods**: `$string.substring(0, 5)`
+
+Full Apache Velocity specification supported via Airspeed engine.
+
+## Platform Support
+
+- ✅ Windows 10/11
+- ✅ macOS 10.15+
+- ✅ Linux (Ubuntu, Fedora, Arch)
+
+## Development
+
+```bash
+# Install dependencies
+pip install -e .
+
+# Run tests
+pytest
+
+# Type check
+mypy src/
+
+# Project structure
+├── src/velocity_previewer/    # Main package
+│   ├── main.py                # Application UI and logic
+│   ├── renderer.py            # Background rendering & context building
+│   ├── styles.py              # Light/dark Qt stylesheets
+│   ├── utils.py               # Template processing
+│   └── syntax_highlighters.py # Syntax highlighting
+├── examples/                  # Example templates and data
+├── tests/                     # Test files
+└── pyproject.toml            # Project configuration
+```
+
+Settings (window size, recent files) are saved to:
+- **Windows**: `%APPDATA%/VelocityPreviewer`
+- **macOS**: `~/Library/Application Support/VelocityPreviewer`
+- **Linux**: `~/.config/VelocityPreviewer`
+
+## Troubleshooting
+
+| Issue | Solution |
+|-------|----------|
+| Template won't render | Use `Tools > Validate Template` (Ctrl+Shift+V) to see errors |
+| JSON parse errors | Use `Tools > Validate Data` (Ctrl+Shift+D) to check format |
+| Slow performance | Large templates render in background automatically |
+| App won't start | Ensure PyQt5 is installed: `pip install PyQt5` |
+
+## Roadmap
+
+- [ ] Live preview mode (render on every keystroke)
+- [ ] Multiple data sets for testing
+- [ ] Template snippet library
+- [ ] Velocity macro autocomplete
+
+## License
+
+MIT License
+
+## Built With
+
+- [PyQt5](https://www.riverbankcomputing.com/software/pyqt/) - Cross-platform UI framework
+- [Airspeed](https://github.com/purcell/airspeed) - Python implementation of Apache Velocity

velocity_previewer-1.1.0/pyproject.toml

@@ -0,0 +1,105 @@
+[project]
+name = "velocity-previewer"
+version = "1.1.0"
+description = "A modern, feature-rich PyQt5 application for previewing and rendering Velocity templates with real-time syntax highlighting, validation, and export capabilities."
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "MIT"}
+authors = [
+    {name = "Josh Simnitt"}
+]
+keywords = ["velocity", "template", "previewer", "pyqt5", "gui", "syntax-highlighting"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Text Processing :: Markup :: HTML",
+    "Topic :: Software Development :: User Interfaces",
+]
+dependencies = [
+    "airspeed>=0.6.0",
+    "pyqt5>=5.15.11",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "black>=22.0.0",
+    "flake8>=5.0.0",
+    "mypy>=1.0.0",
+    "PyQt5-stubs>=5.15",
+]
+
+[project.urls]
+Homepage = "https://github.com/star7js/velocity-previewer"
+Repository = "https://github.com/star7js/velocity-previewer"
+Documentation = "https://github.com/star7js/velocity-previewer#readme"
+Issues = "https://github.com/star7js/velocity-previewer/issues"
+
+[project.scripts]
+velocity-previewer = "velocity_previewer.main:main"
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["velocity_previewer*"]
+exclude = ["tests*", "docs*"]
+
+[tool.black]
+line-length = 88
+target-version = ['py39']
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  # directories
+  \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | build
+  | dist
+)/
+'''
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+warn_unreachable = true
+strict_equality = true
+
+[[tool.mypy.overrides]]
+module = "airspeed.*"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "velocity_previewer.main"
+disallow_untyped_defs = false
+disallow_incomplete_defs = false
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = "-v --tb=short"

velocity_previewer-1.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

velocity_previewer-1.1.0/src/velocity_previewer/__init__.py

@@ -0,0 +1,7 @@
+"""Velocity template previewer with syntax highlighting."""
+
+from .main import VelocityTemplatePreviewer, main
+from .utils import APP_VERSION
+
+__version__ = APP_VERSION
+__all__ = ["VelocityTemplatePreviewer", "main"]