diffuser-cli 0.1.0__tar.gz → 0.1.2__tar.gz

diffuser_cli-0.1.2/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: diffuser-cli
+Version: 0.1.2
+Summary: CriticMarkup viewer for the terminal
+Author-email: shakedlokits <shakedl@salt.security>
+License-Expression: GPL-3.0-or-later
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: rich>=14.3.3
+Requires-Dist: typer>=0.24.1
+Description-Content-Type: text/markdown
+
+```
+██████╗ ██╗███████╗███████╗██╗   ██╗███████╗███████╗██████╗ 
+██╔══██╗██║██╔════╝██╔════╝██║   ██║██╔════╝██╔════╝██╔══██╗
+██║  ██║██║█████╗  █████╗  ██║   ██║███████╗█████╗  ██████╔╝
+██║  ██║██║██╔══╝  ██╔══╝  ██║   ██║╚════██║██╔══╝  ██╔══██╗
+██████╔╝██║██║     ██║     ╚██████╔╝███████║███████╗██║  ██║
+╚═════╝ ╚═╝╚═╝     ╚═╝      ╚═════╝ ╚══════╝╚══════╝╚═╝  ╚═╝ 
+```
+
+CriticMarkup viewer for the terminal.
+
+## Getting Started
+
+### Installation
+
+```bash
+pip install diffuser-cli
+```
+
+Or with uv:
+
+```bash
+uv tool install diffuser-cli
+```
+
+### Quick Example
+
+Given a markdown file with CriticMarkup annotations:
+
+```markdown
+The system processed the data and {~~returned results to~>delivered results
+back to~~} the user.
+```
+
+Render it in the terminal with color-coded annotations:
+
+```bash
+diffuser view my-document.md
+```
+
+## Background & Rationale
+
+Writing blog posts in markdown is straightforward until you start editing.
+You change a sentence, rewrite a paragraph, cut a section. The next morning,
+you're not sure what you changed or why. Git solves this for code, but
+version control for prose is a different problem. You don't want branches
+and merge conflicts for a blog post. You want to see what changed, right
+there in the text.
+
+Fletcher Penney saw this clearly. Penney is the creator of
+[MultiMarkdown](https://fletcherpenney.net/multimarkdown/). He has spent
+years building tools for writers who think in plain text. Together with Gabe
+Weatherhead, he created [CriticMarkup](http://criticmarkup.com): five
+simple inline annotations that track changes without leaving the document.
+`{++add this++}`, `{--remove this--}`, `{~~old~>new~~}`. No external
+tooling. No version control. Just the text.
+
+The idea was brilliant. I just needed it in the terminal. That's diffuser.
+
+## Agent Skill
+
+If you want to use an agent to help you with writing, there's a skill to
+guide it on how to use CriticMarkup when suggesting changes:
+
+```bash
+npx skills add shakedlokits/diffuser
+```
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/shakedlokits/diffuser.git
+cd diffuser
+uv sync
+```
+
+### Running
+
+```bash
+uv run diffuser view my-document.md
+```
+
+### Running Tests
+
+```bash
+uv run pytest
+```
+
+### Releasing
+
+```bash
+git tag v0.1.0
+git push origin v0.1.0
+```
+
+## Credits
+
+CriticMarkup was created by [Fletcher Penney](https://fletcherpenney.net/)
+and [Gabe Weatherhead](http://macdrifter.com). Full specification at
+[criticmarkup.com](http://criticmarkup.com/spec.php).

diffuser_cli-0.1.2/README.md

@@ -0,0 +1,102 @@
+```
+██████╗ ██╗███████╗███████╗██╗   ██╗███████╗███████╗██████╗ 
+██╔══██╗██║██╔════╝██╔════╝██║   ██║██╔════╝██╔════╝██╔══██╗
+██║  ██║██║█████╗  █████╗  ██║   ██║███████╗█████╗  ██████╔╝
+██║  ██║██║██╔══╝  ██╔══╝  ██║   ██║╚════██║██╔══╝  ██╔══██╗
+██████╔╝██║██║     ██║     ╚██████╔╝███████║███████╗██║  ██║
+╚═════╝ ╚═╝╚═╝     ╚═╝      ╚═════╝ ╚══════╝╚══════╝╚═╝  ╚═╝ 
+```
+
+CriticMarkup viewer for the terminal.
+
+## Getting Started
+
+### Installation
+
+```bash
+pip install diffuser-cli
+```
+
+Or with uv:
+
+```bash
+uv tool install diffuser-cli
+```
+
+### Quick Example
+
+Given a markdown file with CriticMarkup annotations:
+
+```markdown
+The system processed the data and {~~returned results to~>delivered results
+back to~~} the user.
+```
+
+Render it in the terminal with color-coded annotations:
+
+```bash
+diffuser view my-document.md
+```
+
+## Background & Rationale
+
+Writing blog posts in markdown is straightforward until you start editing.
+You change a sentence, rewrite a paragraph, cut a section. The next morning,
+you're not sure what you changed or why. Git solves this for code, but
+version control for prose is a different problem. You don't want branches
+and merge conflicts for a blog post. You want to see what changed, right
+there in the text.
+
+Fletcher Penney saw this clearly. Penney is the creator of
+[MultiMarkdown](https://fletcherpenney.net/multimarkdown/). He has spent
+years building tools for writers who think in plain text. Together with Gabe
+Weatherhead, he created [CriticMarkup](http://criticmarkup.com): five
+simple inline annotations that track changes without leaving the document.
+`{++add this++}`, `{--remove this--}`, `{~~old~>new~~}`. No external
+tooling. No version control. Just the text.
+
+The idea was brilliant. I just needed it in the terminal. That's diffuser.
+
+## Agent Skill
+
+If you want to use an agent to help you with writing, there's a skill to
+guide it on how to use CriticMarkup when suggesting changes:
+
+```bash
+npx skills add shakedlokits/diffuser
+```
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/shakedlokits/diffuser.git
+cd diffuser
+uv sync
+```
+
+### Running
+
+```bash
+uv run diffuser view my-document.md
+```
+
+### Running Tests
+
+```bash
+uv run pytest
+```
+
+### Releasing
+
+```bash
+git tag v0.1.0
+git push origin v0.1.0
+```
+
+## Credits
+
+CriticMarkup was created by [Fletcher Penney](https://fletcherpenney.net/)
+and [Gabe Weatherhead](http://macdrifter.com). Full specification at
+[criticmarkup.com](http://criticmarkup.com/spec.php).

{diffuser_cli-0.1.0 → diffuser_cli-0.1.2}/pyproject.toml

@@ -1,10 +1,10 @@
 [project]
 name = "diffuser-cli"
 dynamic = ["version"]
-description = "CriticMarkup-aware markdown viewer for the terminal"
+description = "CriticMarkup viewer for the terminal"
 readme = "README.md"
 authors = [
-    { name = "shaked-lokits", email = "shakedl@salt.security" }
+    { name = "shakedlokits", email = "shakedl@salt.security" }
 ]
 requires-python = ">=3.11"
 license = "GPL-3.0-or-later"
@@ -22,7 +22,6 @@ build-backend = "hatchling.build"
 
 [tool.hatch.version]
 source = "vcs"
-fallback-version = "0.0.0"
 
 [tool.hatch.build.hooks.vcs]
 version-file = "src/diffuser/_version.py"

diffuser_cli-0.1.2/src/diffuser/__init__.py

@@ -0,0 +1,72 @@
+"""diffuser -- CriticMarkup viewer for the terminal."""
+
+from pathlib import Path
+from typing import Optional
+
+import typer
+
+from diffuser.parse import prepare
+from diffuser.render import render
+from diffuser.skill import get_skill_content
+
+_BANNER = r"""
+ ██████╗ ██╗███████╗███████╗██╗   ██╗███████╗███████╗██████╗
+ ██╔══██╗██║██╔════╝██╔════╝██║   ██║██╔════╝██╔════╝██╔══██╗
+ ██║  ██║██║█████╗  █████╗  ██║   ██║███████╗█████╗  ██████╔╝
+ ██║  ██║██║██╔══╝  ██╔══╝  ██║   ██║╚════██║██╔══╝  ██╔══██╗
+ ██████╔╝██║██║     ██║     ╚██████╔╝███████║███████╗██║  ██║
+ ╚═════╝ ╚═╝╚═╝     ╚═╝      ╚═════╝ ╚══════╝╚══════╝╚═╝  ╚═╝
+"""
+
+
+def _version_callback(value: bool) -> None:
+    if value:
+        from diffuser._version import __version__
+
+        typer.echo(f"diffuser {__version__}")
+        raise typer.Exit()
+
+
+app = typer.Typer(
+    help=_BANNER + "\n CriticMarkup viewer for the terminal.",
+    epilog="Made by Shaked Lokits. https://github.com/shakedlokits/diffuser",
+    no_args_is_help=True,
+)
+
+
+@app.callback()
+def _main_callback(
+    version: Optional[bool] = typer.Option(
+        None,
+        "--version",
+        "-v",
+        callback=_version_callback,
+        is_eager=True,
+        help="Show version and exit.",
+    ),
+) -> None:
+    pass
+
+
+@app.command()
+def view(
+    file: Path = typer.Argument(..., help="Markdown file to render"),
+) -> None:
+    """Render a CriticMarkup-annotated markdown file in the terminal."""
+    if not file.exists():
+        typer.echo(f"Error: file not found: {file}", err=True)
+        raise typer.Exit(code=1)
+
+    text = file.read_text()
+    prepared = prepare(text)
+    render(prepared)
+
+
+@app.command()
+def skill() -> None:
+    """Print the CriticMarkup agent skill (SKILL.md) to stdout."""
+    typer.echo(get_skill_content())
+
+
+def main() -> None:
+    app()

{diffuser_cli-0.1.0 → diffuser_cli-0.1.2}/src/diffuser/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.1.0'
-__version_tuple__ = version_tuple = (0, 1, 0)
+__version__ = version = '0.1.2'
+__version_tuple__ = version_tuple = (0, 1, 2)
 
 __commit_id__ = commit_id = None

diffuser_cli-0.1.0/PKG-INFO

@@ -1,126 +0,0 @@
-Metadata-Version: 2.4
-Name: diffuser-cli
-Version: 0.1.0
-Summary: CriticMarkup-aware markdown viewer for the terminal
-Author-email: shaked-lokits <shakedl@salt.security>
-License-Expression: GPL-3.0-or-later
-License-File: LICENSE
-Requires-Python: >=3.11
-Requires-Dist: rich>=14.3.3
-Requires-Dist: typer>=0.24.1
-Description-Content-Type: text/markdown
-
-```
-
-     ██████  ██ ████████ ████████ ██    ██ ▄█████ ████████ ██████
-     ██   ██ ██ ██       ██       ██    ██ ▀▀▀▄▄▄ ██       ██   ██
-     ██   ██ ██ ██████   ██████   ██    ██ █████▀ ██████   ██████
-     ██   ██ ██ ██       ██       ██    ██       █ ██       ██  ██
-     ██████  ██ ██       ██        ██████  ██████▀ ████████ ██   ██
-
-```
-
-CriticMarkup-aware markdown viewer for the terminal.
-
-## Getting Started
-
-### Installation
-
-```bash
-pip install diffuser-cli
-```
-
-Or with uv:
-
-```bash
-uv tool install diffuser-cli
-```
-
-### Quick Example
-
-Given a markdown file with CriticMarkup annotations:
-
-```markdown
-The system processed the data and {~~returned results to~>delivered results
-back to~~} the user.{>>"Delivered back" is more active and specific.<<}
-```
-
-Render it in the terminal with color-coded annotations:
-
-```bash
-diffuser view my-document.md
-```
-
-## Background & Rationale
-
-When AI agents suggest changes to writing, they typically rewrite the whole
-file. The original is gone. If you disagree with one sentence, tough luck --
-you're diffing walls of prose in a terminal.
-
-CriticMarkup solves this. It's a plain-text syntax for editorial annotations
-that sits inside the document without destroying what was already there.
-`{++add this++}`, `{--remove this--}`, `{~~old~>new~~}` -- five simple
-marks that let an agent suggest changes while preserving every word of the
-original.
-
-What was missing was a way to view these annotations clearly from the
-command line. Rich terminal rendering, color-coded by change type, without
-leaving the shell. That's what diffuser does.
-
-## How It Works
-
-diffuser preprocesses CriticMarkup syntax into Rich markup, then delegates
-all markdown rendering to the `rich` library. No custom HTML parser, no
-browser -- just your terminal.
-
-### CriticMarkup Syntax
-
-| Syntax | Meaning |
-|---|---|
-| `{++text++}` | Insertion |
-| `{--text--}` | Deletion |
-| `{~~old~>new~~}` | Substitution |
-| `{==text==}` | Highlight |
-| `{>>text<<}` | Comment |
-
-Full specification: http://criticmarkup.com/spec.php
-
-## Agent Skill
-
-diffuser ships with a skill that teaches AI agents how to use CriticMarkup
-when editing your writing. Install it with the [skills CLI](https://skills.sh):
-
-```bash
-npx skills add shakedlokits/diffuser
-```
-
-Or view the skill content directly:
-
-```bash
-diffuser skill
-```
-
-The skill instructs the agent to annotate files in-place using CriticMarkup
-syntax, never deleting or replacing original text directly.
-
-## Development
-
-### Setup
-
-```bash
-git clone https://github.com/shakedlokits/diffuser.git
-cd diffuser
-uv sync
-```
-
-### Running
-
-```bash
-uv run diffuser view my-document.md
-```
-
-### Running Tests
-
-```bash
-uv run pytest
-```

diffuser_cli-0.1.0/README.md

@@ -1,114 +0,0 @@
-```
-
-     ██████  ██ ████████ ████████ ██    ██ ▄█████ ████████ ██████
-     ██   ██ ██ ██       ██       ██    ██ ▀▀▀▄▄▄ ██       ██   ██
-     ██   ██ ██ ██████   ██████   ██    ██ █████▀ ██████   ██████
-     ██   ██ ██ ██       ██       ██    ██       █ ██       ██  ██
-     ██████  ██ ██       ██        ██████  ██████▀ ████████ ██   ██
-
-```
-
-CriticMarkup-aware markdown viewer for the terminal.
-
-## Getting Started
-
-### Installation
-
-```bash
-pip install diffuser-cli
-```
-
-Or with uv:
-
-```bash
-uv tool install diffuser-cli
-```
-
-### Quick Example
-
-Given a markdown file with CriticMarkup annotations:
-
-```markdown
-The system processed the data and {~~returned results to~>delivered results
-back to~~} the user.{>>"Delivered back" is more active and specific.<<}
-```
-
-Render it in the terminal with color-coded annotations:
-
-```bash
-diffuser view my-document.md
-```
-
-## Background & Rationale
-
-When AI agents suggest changes to writing, they typically rewrite the whole
-file. The original is gone. If you disagree with one sentence, tough luck --
-you're diffing walls of prose in a terminal.
-
-CriticMarkup solves this. It's a plain-text syntax for editorial annotations
-that sits inside the document without destroying what was already there.
-`{++add this++}`, `{--remove this--}`, `{~~old~>new~~}` -- five simple
-marks that let an agent suggest changes while preserving every word of the
-original.
-
-What was missing was a way to view these annotations clearly from the
-command line. Rich terminal rendering, color-coded by change type, without
-leaving the shell. That's what diffuser does.
-
-## How It Works
-
-diffuser preprocesses CriticMarkup syntax into Rich markup, then delegates
-all markdown rendering to the `rich` library. No custom HTML parser, no
-browser -- just your terminal.
-
-### CriticMarkup Syntax
-
-| Syntax | Meaning |
-|---|---|
-| `{++text++}` | Insertion |
-| `{--text--}` | Deletion |
-| `{~~old~>new~~}` | Substitution |
-| `{==text==}` | Highlight |
-| `{>>text<<}` | Comment |
-
-Full specification: http://criticmarkup.com/spec.php
-
-## Agent Skill
-
-diffuser ships with a skill that teaches AI agents how to use CriticMarkup
-when editing your writing. Install it with the [skills CLI](https://skills.sh):
-
-```bash
-npx skills add shakedlokits/diffuser
-```
-
-Or view the skill content directly:
-
-```bash
-diffuser skill
-```
-
-The skill instructs the agent to annotate files in-place using CriticMarkup
-syntax, never deleting or replacing original text directly.
-
-## Development
-
-### Setup
-
-```bash
-git clone https://github.com/shakedlokits/diffuser.git
-cd diffuser
-uv sync
-```
-
-### Running
-
-```bash
-uv run diffuser view my-document.md
-```
-
-### Running Tests
-
-```bash
-uv run pytest
-```

diffuser_cli-0.1.0/src/diffuser/__init__.py

@@ -1,38 +0,0 @@
-"""diffuser -- CriticMarkup-aware markdown viewer for the terminal."""
-
-from pathlib import Path
-
-import typer
-
-from diffuser.parse import prepare
-from diffuser.render import render
-from diffuser.skill import get_skill_content
-
-app = typer.Typer(
-    help="Render markdown with CriticMarkup annotations in the terminal.",
-    no_args_is_help=True,
-)
-
-
-@app.command()
-def view(
-    file: Path = typer.Argument(..., help="Markdown file to render"),
-) -> None:
-    """Render a CriticMarkup-annotated markdown file in the terminal."""
-    if not file.exists():
-        typer.echo(f"Error: file not found: {file}", err=True)
-        raise typer.Exit(code=1)
-
-    text = file.read_text()
-    prepared = prepare(text)
-    render(prepared)
-
-
-@app.command()
-def skill() -> None:
-    """Print the CriticMarkup agent skill (SKILL.md) to stdout."""
-    typer.echo(get_skill_content())
-
-
-def main() -> None:
-    app()