prezo 0.3.1__tar.gz

prezo-0.3.1/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.3
+Name: prezo
+Version: 0.3.1
+Summary: Add your description here
+Author: Stefane Fermigier
+Author-email: Stefane Fermigier <sf@fermigier.com>
+Requires-Dist: textual>=0.89.1
+Requires-Dist: python-frontmatter>=1.1.0
+Requires-Dist: textual-image>=0.8.0
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# Prezo
+
+A TUI-based presentation tool for the terminal, built with [Textual](https://textual.textualize.io/).
+
+Display presentations written in Markdown using conventions similar to those of [MARP](https://marp.app/) or [Deckset](https://www.deckset.com/).
+
+## Features (v0.3)
+
+- **Markdown presentations** - MARP/Deckset format with `---` slide separators
+- **Live reload** - Auto-refresh when file changes (1s polling)
+- **Keyboard navigation** - Vim-style keys, arrow keys, and more
+- **Slide overview** - Grid view for quick navigation (`o`)
+- **Search** - Find slides by content (`/`)
+- **Table of contents** - Navigate by headings (`t`)
+- **Go to slide** - Jump to specific slide number (`:`)
+- **Presenter notes** - Toggle notes panel (`p`)
+- **Themes** - 6 color schemes (`T` to cycle): dark, light, dracula, solarized-dark, nord, gruvbox
+- **Timer/Clock** - Elapsed time and countdown (`c`)
+- **Edit slides** - Open in $EDITOR (`e`), saves back to source file
+- **Export** - PDF, HTML, PNG, SVG formats with customizable themes and sizes
+- **Image support** - Inline and background images with MARP layout directives (left/right/fit)
+- **Native image viewing** - Press `i` for full-quality image display (iTerm2/Kitty protocols)
+- **Blackout/Whiteout** - Blank screen modes (`b`/`w`)
+- **Command palette** - Quick access to all commands (`Ctrl+P`)
+- **Config file** - Customizable settings via `~/.config/prezo/config.toml`
+- **Recent files** - Tracks recently opened presentations
+- **Position memory** - Remembers last slide position per file
+
+## Demo
+
+[![asciicast](https://asciinema.org/a/0rRbYzbq7iyha2wLkN6o4OPcX.svg)](https://asciinema.org/a/0rRbYzbq7iyha2wLkN6o4OPcX)
+
+
+## Installation
+
+```bash
+pip install prezo
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv tool install prezo
+```
+
+## Usage
+
+```bash
+# View a presentation
+prezo presentation.md
+
+# Disable auto-reload
+prezo --no-watch presentation.md
+
+# Use custom config
+prezo -c myconfig.toml presentation.md
+
+# Set image rendering mode
+prezo --image-mode ascii presentation.md   # Options: auto, kitty, sixel, iterm, ascii, none
+
+# Export to PDF
+prezo -e pdf presentation.md
+
+# Export with options
+prezo -e pdf presentation.md --theme light --size 100x30 --no-chrome
+```
+
+## Keyboard Shortcuts
+
+| Key | Action |
+|-----|--------|
+| `→` / `j` / `Space` | Next slide |
+| `←` / `k` | Previous slide |
+| `Home` / `g` | First slide |
+| `End` / `G` | Last slide |
+| `:` | Go to slide number |
+| `/` | Search slides |
+| `o` | Slide overview |
+| `t` | Table of contents |
+| `p` | Toggle notes panel |
+| `c` | Cycle clock display |
+| `T` | Cycle theme |
+| `b` | Blackout screen |
+| `w` | Whiteout screen |
+| `i` | View image (native quality) |
+| `e` | Edit in $EDITOR |
+| `r` | Reload file |
+| `Ctrl+P` | Command palette |
+| `?` | Help |
+| `q` | Quit |
+
+## Presentation Format
+
+Prezo supports standard Markdown with MARP/Deckset conventions:
+
+```markdown
+---
+title: My Presentation
+theme: default
+---
+
+# First Slide
+
+Content here...
+
+---
+
+# Second Slide
+
+- Bullet points
+- Code blocks
+- Tables
+
+???
+Presenter notes go here (after ???)
+
+---
+
+# Third Slide
+
+<!-- notes: Alternative notes syntax -->
+
+More content...
+```
+
+## Themes
+
+Available themes: `dark`, `light`, `dracula`, `solarized-dark`, `nord`, `gruvbox`
+
+Press `T` to cycle through themes during presentation.
+
+## Export Options
+
+Prezo supports multiple export formats: PDF, HTML, PNG, and SVG.
+
+```bash
+# PDF export
+prezo -e pdf presentation.md                    # Default: 80x24, dark theme
+prezo -e pdf presentation.md --theme light      # Light theme (for printing)
+prezo -e pdf presentation.md --size 100x30      # Custom dimensions
+prezo -e pdf presentation.md --no-chrome        # No window decorations
+prezo -e pdf presentation.md -o slides.pdf      # Custom output path
+
+# HTML export (single self-contained file)
+prezo -e html presentation.md
+
+# Image export (PNG/SVG)
+prezo -e png presentation.md                    # All slides as PNG
+prezo -e png presentation.md --slide 3          # Single slide (1-indexed)
+prezo -e svg presentation.md --scale 2.0        # SVG with scale factor
+```
+
+PDF/PNG/SVG export requires optional dependencies:
+
+```bash
+pip install prezo[export]
+# or
+pip install cairosvg pypdf
+```
+
+## Development
+
+```bash
+# Clone and install
+git clone https://github.com/user/prezo.git
+cd prezo
+uv sync
+
+# Run
+uv run prezo presentation.md
+
+# Run tests
+uv run pytest
+
+# Lint
+uv run ruff check .
+uv run ruff format .
+```
+
+## License
+
+MIT

prezo-0.3.1/README.md

@@ -0,0 +1,182 @@
+# Prezo
+
+A TUI-based presentation tool for the terminal, built with [Textual](https://textual.textualize.io/).
+
+Display presentations written in Markdown using conventions similar to those of [MARP](https://marp.app/) or [Deckset](https://www.deckset.com/).
+
+## Features (v0.3)
+
+- **Markdown presentations** - MARP/Deckset format with `---` slide separators
+- **Live reload** - Auto-refresh when file changes (1s polling)
+- **Keyboard navigation** - Vim-style keys, arrow keys, and more
+- **Slide overview** - Grid view for quick navigation (`o`)
+- **Search** - Find slides by content (`/`)
+- **Table of contents** - Navigate by headings (`t`)
+- **Go to slide** - Jump to specific slide number (`:`)
+- **Presenter notes** - Toggle notes panel (`p`)
+- **Themes** - 6 color schemes (`T` to cycle): dark, light, dracula, solarized-dark, nord, gruvbox
+- **Timer/Clock** - Elapsed time and countdown (`c`)
+- **Edit slides** - Open in $EDITOR (`e`), saves back to source file
+- **Export** - PDF, HTML, PNG, SVG formats with customizable themes and sizes
+- **Image support** - Inline and background images with MARP layout directives (left/right/fit)
+- **Native image viewing** - Press `i` for full-quality image display (iTerm2/Kitty protocols)
+- **Blackout/Whiteout** - Blank screen modes (`b`/`w`)
+- **Command palette** - Quick access to all commands (`Ctrl+P`)
+- **Config file** - Customizable settings via `~/.config/prezo/config.toml`
+- **Recent files** - Tracks recently opened presentations
+- **Position memory** - Remembers last slide position per file
+
+## Demo
+
+[![asciicast](https://asciinema.org/a/0rRbYzbq7iyha2wLkN6o4OPcX.svg)](https://asciinema.org/a/0rRbYzbq7iyha2wLkN6o4OPcX)
+
+
+## Installation
+
+```bash
+pip install prezo
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv tool install prezo
+```
+
+## Usage
+
+```bash
+# View a presentation
+prezo presentation.md
+
+# Disable auto-reload
+prezo --no-watch presentation.md
+
+# Use custom config
+prezo -c myconfig.toml presentation.md
+
+# Set image rendering mode
+prezo --image-mode ascii presentation.md   # Options: auto, kitty, sixel, iterm, ascii, none
+
+# Export to PDF
+prezo -e pdf presentation.md
+
+# Export with options
+prezo -e pdf presentation.md --theme light --size 100x30 --no-chrome
+```
+
+## Keyboard Shortcuts
+
+| Key | Action |
+|-----|--------|
+| `→` / `j` / `Space` | Next slide |
+| `←` / `k` | Previous slide |
+| `Home` / `g` | First slide |
+| `End` / `G` | Last slide |
+| `:` | Go to slide number |
+| `/` | Search slides |
+| `o` | Slide overview |
+| `t` | Table of contents |
+| `p` | Toggle notes panel |
+| `c` | Cycle clock display |
+| `T` | Cycle theme |
+| `b` | Blackout screen |
+| `w` | Whiteout screen |
+| `i` | View image (native quality) |
+| `e` | Edit in $EDITOR |
+| `r` | Reload file |
+| `Ctrl+P` | Command palette |
+| `?` | Help |
+| `q` | Quit |
+
+## Presentation Format
+
+Prezo supports standard Markdown with MARP/Deckset conventions:
+
+```markdown
+---
+title: My Presentation
+theme: default
+---
+
+# First Slide
+
+Content here...
+
+---
+
+# Second Slide
+
+- Bullet points
+- Code blocks
+- Tables
+
+???
+Presenter notes go here (after ???)
+
+---
+
+# Third Slide
+
+<!-- notes: Alternative notes syntax -->
+
+More content...
+```
+
+## Themes
+
+Available themes: `dark`, `light`, `dracula`, `solarized-dark`, `nord`, `gruvbox`
+
+Press `T` to cycle through themes during presentation.
+
+## Export Options
+
+Prezo supports multiple export formats: PDF, HTML, PNG, and SVG.
+
+```bash
+# PDF export
+prezo -e pdf presentation.md                    # Default: 80x24, dark theme
+prezo -e pdf presentation.md --theme light      # Light theme (for printing)
+prezo -e pdf presentation.md --size 100x30      # Custom dimensions
+prezo -e pdf presentation.md --no-chrome        # No window decorations
+prezo -e pdf presentation.md -o slides.pdf      # Custom output path
+
+# HTML export (single self-contained file)
+prezo -e html presentation.md
+
+# Image export (PNG/SVG)
+prezo -e png presentation.md                    # All slides as PNG
+prezo -e png presentation.md --slide 3          # Single slide (1-indexed)
+prezo -e svg presentation.md --scale 2.0        # SVG with scale factor
+```
+
+PDF/PNG/SVG export requires optional dependencies:
+
+```bash
+pip install prezo[export]
+# or
+pip install cairosvg pypdf
+```
+
+## Development
+
+```bash
+# Clone and install
+git clone https://github.com/user/prezo.git
+cd prezo
+uv sync
+
+# Run
+uv run prezo presentation.md
+
+# Run tests
+uv run pytest
+
+# Lint
+uv run ruff check .
+uv run ruff format .
+```
+
+## License
+
+MIT

prezo-0.3.1/pyproject.toml

@@ -0,0 +1,44 @@
+[project]
+name = "prezo"
+version = "0.3.1"
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    { name = "Stefane Fermigier", email = "sf@fermigier.com" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "textual>=0.89.1",
+    "python-frontmatter>=1.1.0",
+    "textual-image>=0.8.0",
+]
+
+[project.scripts]
+prezo = "prezo:main"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0.0",
+    "cairosvg>=2.7.0",
+    "pypdf>=4.0.0",
+    "abilian-devtools>=0.8.0",
+    "pytest-asyncio>=1.3.0",
+    "ty>=0.0.2",
+]
+export = [
+    "cairosvg>=2.7.0",
+    "pypdf>=4.0.0",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+
+[build-system]
+requires = ["uv_build>=0.8.4,<0.9.0"]
+build-backend = "uv_build"
+
+# [build-system]
+# requires = ["hatchling"]
+# build-backend = "hatchling.build"

prezo-0.3.1/src/prezo/__init__.py

@@ -0,0 +1,216 @@
+"""Prezo - TUI-based presentation tool."""
+
+from __future__ import annotations
+
+import argparse
+import sys
+from pathlib import Path
+
+# ANSI color codes for error messages
+RED = "\033[91m"
+YELLOW = "\033[93m"
+BOLD = "\033[1m"
+RESET = "\033[0m"
+
+
+def _error(message: str) -> None:
+    """Print an error message and exit."""
+    sys.stderr.write(f"{RED}{BOLD}error:{RESET} {message}\n")
+    sys.exit(1)
+
+
+def _warn(message: str) -> None:
+    """Print a warning message."""
+    sys.stderr.write(f"{YELLOW}{BOLD}warning:{RESET} {message}\n")
+
+
+def _validate_file(path: Path, must_exist: bool = True) -> Path:
+    """Validate a file path and return the resolved path.
+
+    Args:
+        path: The path to validate.
+        must_exist: Whether the file must exist.
+
+    Returns:
+        The resolved absolute path.
+
+    """
+    resolved = path.resolve()
+
+    if must_exist and not resolved.exists():
+        _error(
+            f"file not found: {path}\n\n"
+            "Make sure the file exists and the path is correct."
+        )
+
+    if must_exist and resolved.is_dir():
+        _error(
+            f"expected a file, got a directory: {path}\n\nProvide a path to a .md file."
+        )
+
+    if must_exist and resolved.suffix.lower() not in (".md", ".markdown"):
+        _warn(
+            f"file '{path.name}' does not have a .md extension "
+            "- treating as markdown anyway"
+        )
+
+    return resolved
+
+
+def main() -> None:
+    """Entry point for Prezo."""
+    parser = argparse.ArgumentParser(
+        prog="prezo",
+        description="TUI-based presentation tool for Markdown slides",
+        epilog="For more information, visit: https://github.com/abilian/prezo",
+    )
+    parser.add_argument(
+        "file",
+        nargs="?",
+        help="Path to the presentation file (.md)",
+    )
+    parser.add_argument(
+        "--export",
+        "-e",
+        metavar="FORMAT",
+        choices=["pdf", "html", "png", "svg"],
+        help="Export presentation to format (pdf, html, png, svg)",
+    )
+    parser.add_argument(
+        "--slide",
+        metavar="NUM",
+        type=int,
+        help="Export only slide number NUM (1-indexed, for png/svg export)",
+    )
+    parser.add_argument(
+        "--output",
+        "-o",
+        metavar="PATH",
+        help="Output path for export (default: same name with new extension)",
+    )
+    parser.add_argument(
+        "--theme",
+        "-t",
+        metavar="NAME",
+        default="dark",
+        help="Theme for export (dark, light, dracula, solarized-dark, nord, gruvbox)",
+    )
+    parser.add_argument(
+        "--size",
+        "-s",
+        metavar="WxH",
+        default="80x24",
+        help="Screen size for export as WIDTHxHEIGHT (default: 80x24)",
+    )
+    parser.add_argument(
+        "--no-chrome",
+        action="store_true",
+        help="Export without window decorations (for printing)",
+    )
+    parser.add_argument(
+        "--scale",
+        metavar="FACTOR",
+        type=float,
+        default=2.0,
+        help="Scale factor for PNG export (default: 2.0 for higher resolution)",
+    )
+    parser.add_argument(
+        "--no-watch",
+        action="store_true",
+        help="Disable file watching for auto-reload",
+    )
+    parser.add_argument(
+        "--config",
+        "-c",
+        metavar="PATH",
+        help="Path to custom config file (default: ~/.config/prezo/config.toml)",
+    )
+    parser.add_argument(
+        "--image-mode",
+        metavar="MODE",
+        choices=["auto", "kitty", "sixel", "iterm", "ascii", "none"],
+        help="Image rendering mode (auto, kitty, sixel, iterm, ascii, none)",
+    )
+
+    args = parser.parse_args()
+
+    # Load config from custom path or default
+    from .config import load_config  # noqa: PLC0415
+
+    config_path = Path(args.config) if args.config else None
+    if config_path and not config_path.exists():
+        _error(f"config file not found: {config_path}")
+
+    config = load_config(config_path)
+
+    # Override image mode if specified
+    if args.image_mode:
+        config.images.mode = args.image_mode
+
+    if args.export:
+        if not args.file:
+            _error(
+                "--export requires a presentation file\n\n"
+                "Usage: prezo -e pdf presentation.md"
+            )
+
+        # Validate source file
+        source_path = _validate_file(Path(args.file))
+
+        # Parse size
+        try:
+            width, height = map(int, args.size.lower().split("x"))
+        except ValueError:
+            _error(
+                f"invalid size format: {args.size}\n\n"
+                "Use WIDTHxHEIGHT format (e.g., 80x24, 100x30)"
+            )
+
+        if args.export == "html":
+            from .export import run_html_export  # noqa: PLC0415
+
+            sys.exit(
+                run_html_export(
+                    str(source_path),
+                    args.output,
+                    theme=args.theme,
+                ),
+            )
+        elif args.export in ("png", "svg"):
+            from .export import run_image_export  # noqa: PLC0415
+
+            sys.exit(
+                run_image_export(
+                    str(source_path),
+                    args.output,
+                    output_format=args.export,
+                    theme=args.theme,
+                    width=width,
+                    height=height,
+                    chrome=not args.no_chrome,
+                    slide_num=args.slide,
+                    scale=args.scale,
+                ),
+            )
+        else:
+            from .export import run_export  # noqa: PLC0415
+
+            sys.exit(
+                run_export(
+                    str(source_path),
+                    args.output,
+                    theme=args.theme,
+                    width=width,
+                    height=height,
+                    chrome=not args.no_chrome,
+                ),
+            )
+    else:
+        from .app import run_app  # noqa: PLC0415
+
+        # Validate file if provided
+        file_path = None
+        if args.file:
+            file_path = _validate_file(Path(args.file))
+
+        run_app(file_path, watch=not args.no_watch, config=config)