diffstory 0.2.0__py3-none-any.whl

diffstory/syntax.py

@@ -0,0 +1,145 @@
+"""Syntax highlighting using Pygments, works entirely offline."""
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pygments import highlight
+from pygments.lexers import (
+    get_lexer_by_name,
+    get_lexer_for_filename,
+    ClassNotFound,
+)
+from pygments.formatters import HtmlFormatter
+
+
+# Mapping of file extensions to language names for quick lookup
+EXTENSION_MAP: dict[str, str] = {
+    ".py": "python",
+    ".js": "javascript",
+    ".jsx": "javascript",
+    ".ts": "typescript",
+    ".tsx": "typescript",
+    ".java": "java",
+    ".cs": "csharp",
+    ".go": "go",
+    ".rs": "rust",
+    ".php": "php",
+    ".rb": "ruby",
+    ".kt": "kotlin",
+    ".kts": "kotlin",
+    ".sql": "sql",
+    ".sh": "bash",
+    ".bash": "bash",
+    ".zsh": "bash",
+    ".yml": "yaml",
+    ".yaml": "yaml",
+    ".json": "json",
+    ".html": "html",
+    ".htm": "html",
+    ".css": "css",
+    ".md": "markdown",
+    ".markdown": "markdown",
+    ".xml": "xml",
+    ".svg": "xml",
+    ".toml": "ini",
+    ".cfg": "ini",
+    ".ini": "ini",
+    ".txt": "text",
+    ".dockerfile": "docker",
+    ".tf": "terraform",
+    ".vue": "html",
+    ".svelte": "html",
+    ".c": "c",
+    ".h": "c",
+    ".cpp": "cpp",
+    ".cc": "cpp",
+    ".hpp": "cpp",
+    ".swift": "swift",
+    ".scala": "scala",
+    ".ex": "elixir",
+    ".exs": "elixir",
+    ".erl": "erlang",
+    ".hrl": "erlang",
+    ".hs": "haskell",
+    ".lua": "lua",
+    ".r": "r",
+    ".R": "r",
+    ".m": "matlab",
+    ".mm": "matlab",
+}
+
+def get_lexer_for_file(filepath: str) -> object:
+    """Get the appropriate Pygments lexer for a file path."""
+    # Try by extension first
+    ext = "." + filepath.rsplit(".", 1)[-1].lower() if "." in filepath else ""
+    if ext in EXTENSION_MAP:
+        try:
+            return get_lexer_by_name(EXTENSION_MAP[ext])
+        except ClassNotFound:
+            pass
+
+    # Try by full filename
+    try:
+        return get_lexer_for_filename(filepath)
+    except ClassNotFound:
+        pass
+
+    # Try to guess from common filenames
+    basename = filepath.rsplit("/", 1)[-1].lower()
+    if basename in ("dockerfile",):
+        try:
+            return get_lexer_by_name("docker")
+        except ClassNotFound:
+            pass
+    if basename in ("makefile", "gnumakefile"):
+        try:
+            return get_lexer_by_name("make")
+        except ClassNotFound:
+            pass
+
+    return None
+
+
+def get_highlighted_line(line: str, filepath: str, lexer_cache: dict) -> str:
+    """Highlight a single line of code using a cached lexer."""
+    from html import escape
+    lexer = lexer_cache.get(filepath)
+    if lexer is None:
+        lexer = get_lexer_for_file(filepath)
+        lexer_cache[filepath] = lexer
+
+    if lexer is None:
+        return escape(line)
+
+    try:
+        formatter = HtmlFormatter(nowrap=True, style="default")
+        return highlight(line, lexer, formatter)
+    except Exception:
+        return escape(line)
+
+
+def get_syntax_css(style: str = "default") -> str:
+    """Get the CSS for syntax highlighting."""
+    formatter = HtmlFormatter(style=style)
+    return formatter.get_style_defs(".highlight")
+
+
+def _scope_css(css: str, theme: str) -> str:
+    """Scope every .highlight rule under a data-theme attribute selector."""
+    lines = css.splitlines()
+    result = []
+    for line in lines:
+        stripped = line.strip()
+        if stripped.startswith(".highlight"):
+            indent = line[:len(line) - len(line.lstrip())]
+            line = indent + '[data-theme="' + theme + '"] ' + stripped
+        result.append(line)
+    return "\n".join(result)
+
+
+def get_syntax_styles() -> str:
+    """Get both light and dark syntax highlight CSS, scoped by data-theme."""
+    light_css = get_syntax_css("default")
+    dark_css = get_syntax_css("monokai")
+    return "\n" + _scope_css(light_css, "light") + "\n\n" + _scope_css(dark_css, "dark") + "\n"

diffstory-0.2.0.dist-info/METADATA

@@ -0,0 +1,207 @@
+Metadata-Version: 2.4
+Name: diffstory
+Version: 0.2.0
+Summary: Transform Git diffs into rich, interactive, self-contained HTML reports
+License: MIT
+Project-URL: Homepage, https://github.com/lakshayjindal/diffstory
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: Pygments>=2.10
+
+# DiffStory
+
+**Transform Git diffs into rich, interactive, self-contained HTML reports.**
+
+DiffStory turns any `git diff` into a beautiful, portable HTML report that answers not just *what* changed, but *who* changed it, *when*, and *why* — all offline, in a single file.
+
+```bash
+pip install diffstory
+cd my-repo
+diffstory --staged -o report.html
+# Open report.html in any browser
+```
+
+---
+
+## Features
+
+### Phase 1 (MVP)
+- **Unified View** — Classic git-style diff with syntax highlighting
+- **Side-by-Side View** — Original and modified columns, synchronized
+- **Inline Edit View** — Word-level diff showing exact token changes
+- **Syntax Highlighting** — 30+ languages via Pygments, light + dark themes
+- **Statistics Dashboard** — Files changed, +/-, authors breakdown
+- **File Sidebar** — Navigate files with search, collapse/expand
+- **Keyboard Shortcuts** — `U`/`S`/`I` to switch views, `D` for theme, `Esc` to close
+- **Theme Toggle** — Light/dark with system preference detection and persistence
+- **Export Formats** — HTML, JSON, Markdown, CSV
+
+### Phase 2 (Blame Integration)
+- **Blame Tooltips** — Hover any changed line to see author, commit, date, and message
+- **Commit Drawer** — Click a line to open a detailed side panel with full commit metadata
+- **Relative Time** — "2h ago", "3d ago" for at-a-glance recency
+
+### Future Phases
+- Search across filename, author, commit message, and code content
+- Filtering by author, date range, file type, change type
+- Commit evolution viewer and timeline
+- Deep linking to specific lines and files
+
+---
+
+## Installation
+
+### From PyPI (once published)
+```bash
+pip install diffstory
+```
+
+### From source
+```bash
+git clone https://github.com/user/diffstory.git
+cd diffstory
+pip install -e .
+```
+
+**Requirements:** Python 3.10+, Git
+
+---
+
+## Usage
+
+### Basic Commands
+
+```bash
+# Working tree diff
+diffstory
+
+# Staged changes
+diffstory --staged
+
+# Compare commits
+diffstory HEAD~3 HEAD
+
+# Compare branches
+diffstory main feature
+
+# Custom output file
+diffstory -o my-report.html
+
+# Multiple export formats
+diffstory --staged --json --md --csv -o report
+```
+
+### Keyboard Shortcuts (in the HTML report)
+
+| Key | Action |
+|---|---|
+| `U` | Unified view |
+| `S` | Side-by-side view |
+| `I` | Inline edit view |
+| `D` | Toggle theme |
+| `Esc` | Close drawer / stats panel |
+| `F` | Focus file search |
+
+---
+
+## Report Features
+
+### Three View Modes
+
+| Mode | Description |
+|---|---|
+| **Unified** | Classic git diff format with line numbers |
+| **Side-by-Side** | Two-column layout — original on left, modified on right |
+| **Inline Edit** | Word-level diff showing additions (green) and removals (red strikethrough) within the same line |
+
+### Blame Tooltips (Phase 2)
+
+Hover over any changed line to see:
+- **Author** name
+- **Commit hash** (short, 7 chars)
+- **Commit subject**
+- **Date** with relative time ("2h ago")
+
+Click any line to open the **Commit Drawer** with full metadata: body, committer, parents, files changed, insertions/deletions.
+
+### Statistics
+
+The statistics panel shows:
+- Files changed, additions, deletions
+- Added / deleted / modified / renamed file counts
+- Top 10 most-changed files with per-file breakdown
+
+---
+
+## Output
+
+Reports are fully self-contained single HTML files:
+- All CSS inlined
+- All JavaScript inlined
+- All data embedded as JSON
+- No external dependencies
+- Works offline in any modern browser
+- Safe to email or archive
+
+---
+
+## Project Structure
+
+```
+diffstory/
+├── pyproject.toml              # Build config & entry point
+├── requirements.md             # Full product requirements
+├── .gitignore
+├── src/diffstory/
+│   ├── __init__.py             # Package version
+│   ├── __main__.py             # python -m diffstory
+│   ├── cli.py                  # CLI argument parsing & orchestration
+│   ├── git_utils.py            # Git subprocess wrappers
+│   ├── diff_parser.py          # Unified diff → structured data
+│   ├── syntax.py               # Pygments syntax highlighting
+│   └── html_generator.py       # Self-contained HTML report generation
+└── tests/
+    └── __init__.py
+```
+
+---
+
+## Development
+
+```bash
+# Install in editable mode
+pip install -e .
+
+# Run against a test repo
+cd /tmp && mkdir test && cd test
+git init
+echo "hello" > test.py
+git add -A && git commit -m "init"
+echo "world" >> test.py
+diffstory
+```
+
+---
+
+## Security
+
+DiffStory is designed for air-gapped, audit-safe use:
+- Never uploads code
+- Never transmits data
+- No telemetry
+- No accounts required
+- No external API calls
+- Never modifies your repository
+
+---
+
+## License
+
+MIT

diffstory-0.2.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+diffstory/__init__.py,sha256=CLe-2vhq8c6aj3_3Y4Nq37NngqZ9oPQwTy1r8Xqy9Ec,100
+diffstory/__main__.py,sha256=Pc47yF5jQlbjKC_BSH_pna-n3MnEA3lIKsE3TvJ_Jlo,128
+diffstory/cli.py,sha256=aZ7KbfT7CWlVTR-ERBmPWnYscafV10uFvmtiDHN7Nsk,12678
+diffstory/diff_parser.py,sha256=n9L-MmWBSZP-nYohMb1jhOZrERv8O8rnJ3OzeGMpYgU,9417
+diffstory/git_utils.py,sha256=eT77bnYKOlY30ZK07gK60VJWioBjKKgKBNsS-jzXCMg,10786
+diffstory/html_generator.py,sha256=iyHkk9uxlVLpeYuYJXGRPnNOjRJKFNFjz7Spkab3yHQ,72226
+diffstory/syntax.py,sha256=8KPUvBObrZ0uQ5n0-axbC6wRO_ygWhICsADwpYdoSmw,3867
+diffstory-0.2.0.dist-info/METADATA,sha256=QlR_yL1h8bxzZw2uSeVudq2a85dCh8SBfXK0G86nRG0,5330
+diffstory-0.2.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+diffstory-0.2.0.dist-info/entry_points.txt,sha256=_PGs0-KAfUwKvHnoDa7V-ouABl0dAMeRetsEgijp0LM,49
+diffstory-0.2.0.dist-info/top_level.txt,sha256=qxbolVX6YxYMHor32Ih3RMUHGmhvspVJKnSKZsLwVPQ,10
+diffstory-0.2.0.dist-info/RECORD,,

diffstory-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

diffstory-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+diffstory = diffstory.cli:main

diffstory-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+diffstory