rich-gradient-cli 0.1.0__tar.gz → 0.3.0__tar.gz

rich_gradient_cli-0.3.0/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.3
+Name: rich-gradient-cli
+Version: 0.3.0
+Summary: CLI for printing text in gradient color using the rich-gradient library.
+Author: Maxwell Ludden
+Author-email: Maxwell Ludden <maxludden@me.com>
+Requires-Dist: typer>=0.21.1
+Requires-Dist: rich>=14.3.2
+Requires-Dist: rich-color-ext>=0.1.9
+Requires-Dist: rich-gradient>=0.3.9
+Requires-Dist: mypy>=1.18.2 ; extra == 'dev'
+Requires-Dist: pytest>=8.4.2 ; extra == 'dev'
+Requires-Dist: ruff>=0.15.0 ; extra == 'dev'
+Requires-Dist: mkdocstrings>=1.0.8 ; python_full_version >= '3.11' and extra == 'docs'
+Requires-Dist: mkdocstrings-python>=2.0.2 ; python_full_version >= '3.11' and extra == 'docs'
+Requires-Dist: zensical>=0.0.68 ; python_full_version >= '3.11' and extra == 'docs'
+Requires-Python: >=3.10
+Provides-Extra: dev
+Provides-Extra: docs
+Description-Content-Type: text/markdown
+
+# rich-gradient-cli
+
+ `rich-gradient-cli`  is a CLI for [`rich-gradient`](https://github.com/maxludden/rich-gradient). The tool allows you to create colorful gradients in your terminal output, making it easier to visualize data or simply add some flair to your command-line applications.
+
+## Installation
+
+You can install rich-gradient-cli from PyPI
+
+### uv (recommended)
+
+```shell
+uv add rich-gradient-cli
+```
+
+### pip
+
+```shell
+pip install rich-gradient-cli
+```
+
+## Usage
+
+<video
+  src="docs/img/rich-gradient-cli-help.mp4"
+  controls
+  muted
+  loop>
+</video>
+
+### Print
+
+To use the `rich-gradient-cli`, you can run the following command in your terminal:
+
+```bash
+gradient print --colors 'red,#ff9900,#ffff00' "This is gradient text that starts red, transitions through orange, and ends in yellow\!"
+```
+
+![Gradient Text Example](print-example.svg)
+
+### Gradient
+
+Use `gradient` for the generic `rich-gradient` renderable, including highlight rules and animation:
+
+```bash
+gradient gradient --colors 'magenta,cyan' --highlight-word error='bold white on red' "Highlight error text"
+```
+
+### Spectrum
+
+Inspect generated spectrum colors as a rich table, hex values, names, or CSV:
+
+```bash
+gradient spectrum --hues 7 --seed 42
+gradient spectrum --hues 7 --output hex
+```
+
+### Rich renderables
+
+Wrap common Rich renderables in gradients without writing Python:
+
+```bash
+gradient columns alpha beta gamma --colors 'red,blue'
+gradient tree project src/app.py docs/index.md --colors 'lime,cyan'
+gradient syntax pyproject.toml --lexer toml --line-numbers --colors 'yellow,magenta'
+cat data.csv | gradient table - --colors 'cyan,magenta'
+```
+
+### Rule
+
+You can also create gradient rules using the `rule` command:
+
+```bash
+gradient rule --colors 'blue,#00ff00,cyan' "Blue to Green to Cyan Rule"
+```
+
+![Gradient Rule Example](rule-example.svg)
+
+### Panel
+
+To create a gradient panel, you can use the `panel` command:
+
+```bash
+gradient panel --colors "red,#ff9999" -t "Error" --title-style "bold #ffffff" --title-align left 'This is an error message with a red to pink gradient background.'
+```
+
+![Gradient Panel Example](panel-example.svg)
+
+### Markdown
+
+You can also render Markdown with gradients:
+
+```bash
+echo "# Hello\n\n- This is **bold**.\n- This is *italic*." | gradient markdown -
+```
+
+![Gradient Markdown Example](markdown-example.svg)
+
+### Rich-style viewing
+
+Use `view` for `rich-cli`-style file rendering. It auto-detects Markdown, JSON, CSV/TSV, and syntax-highlighted source files; it also accepts `-` for stdin and `http://` or `https://` URLs.
+
+```bash
+gradient view README.md
+gradient view pyproject.toml --lexer toml --line-numbers --guides
+cat data.json | gradient view - --json --force-terminal
+gradient view README.md --export-html readme.html
+```
+
+## Docs
+
+Build and preview the documentation locally with Zensical (requires Python 3.11+; the `docs` extra is skipped on 3.10):
+
+```bash
+uv pip install -e ".[docs]"
+zensical serve
+```
+
+
+
+<div align="center">
+  <a href="https://github.com/maxludden/maxludden" style="text-decoration:none; color:inherit;">
+      <p>Designed by Max Ludden</p>
+  </a>
+  <br />
+  <a href="https://github.com/maxludden/maxludden" style="text-decoration:none; color:inherit;">
+    <img
+      src="docs/img/MaxLogo.svg"
+      alt="Max Ludden's Logo"
+      width="20%"
+    />
+  </a>
+</div>

rich_gradient_cli-0.1.0/PKG-INFO → rich_gradient_cli-0.3.0/README.md

@@ -1,22 +1,3 @@
-Metadata-Version: 2.3
-Name: rich-gradient-cli
-Version: 0.1.0
-Summary: CLI for printing text in gradient color using the rich-gradient library.
-Author: Maxwell Ludden
-Author-email: Maxwell Ludden <maxludden@me.com>
-Requires-Dist: typer>=0.21.1
-Requires-Dist: rich>=14.3.2
-Requires-Dist: rich-color-ext>=0.1.9
-Requires-Dist: rich-gradient>=0.3.9
-Requires-Dist: ruff>=0.15.0
-Requires-Dist: mkdocs>=1.6.0 ; extra == 'docs'
-Requires-Dist: mkdocs-material>=9.5.0 ; extra == 'docs'
-Requires-Dist: mkdocstrings>=0.25.0 ; extra == 'docs'
-Requires-Dist: mkdocstrings-python>=1.10.0 ; extra == 'docs'
-Requires-Python: >=3.14
-Provides-Extra: docs
-Description-Content-Type: text/markdown
-
 # rich-gradient-cli
 
  `rich-gradient-cli`  is a CLI for [`rich-gradient`](https://github.com/maxludden/rich-gradient). The tool allows you to create colorful gradients in your terminal output, making it easier to visualize data or simply add some flair to your command-line applications.
@@ -39,6 +20,12 @@ pip install rich-gradient-cli
 
 ## Usage
 
+<video
+  src="docs/img/rich-gradient-cli-help.mp4"
+  controls
+  muted
+  loop>
+</video>
 
 ### Print
 
@@ -50,6 +37,33 @@ gradient print --colors 'red,#ff9900,#ffff00' "This is gradient text that starts
 
 ![Gradient Text Example](print-example.svg)
 
+### Gradient
+
+Use `gradient` for the generic `rich-gradient` renderable, including highlight rules and animation:
+
+```bash
+gradient gradient --colors 'magenta,cyan' --highlight-word error='bold white on red' "Highlight error text"
+```
+
+### Spectrum
+
+Inspect generated spectrum colors as a rich table, hex values, names, or CSV:
+
+```bash
+gradient spectrum --hues 7 --seed 42
+gradient spectrum --hues 7 --output hex
+```
+
+### Rich renderables
+
+Wrap common Rich renderables in gradients without writing Python:
+
+```bash
+gradient columns alpha beta gamma --colors 'red,blue'
+gradient tree project src/app.py docs/index.md --colors 'lime,cyan'
+gradient syntax pyproject.toml --lexer toml --line-numbers --colors 'yellow,magenta'
+cat data.csv | gradient table - --colors 'cyan,magenta'
+```
 
 ### Rule
 
@@ -81,13 +95,24 @@ echo "# Hello\n\n- This is **bold**.\n- This is *italic*." | gradient markdown -
 
 ![Gradient Markdown Example](markdown-example.svg)
 
+### Rich-style viewing
+
+Use `view` for `rich-cli`-style file rendering. It auto-detects Markdown, JSON, CSV/TSV, and syntax-highlighted source files; it also accepts `-` for stdin and `http://` or `https://` URLs.
+
+```bash
+gradient view README.md
+gradient view pyproject.toml --lexer toml --line-numbers --guides
+cat data.json | gradient view - --json --force-terminal
+gradient view README.md --export-html readme.html
+```
+
 ## Docs
 
-Build and preview the documentation locally with MkDocs:
+Build and preview the documentation locally with Zensical (requires Python 3.11+; the `docs` extra is skipped on 3.10):
 
 ```bash
 uv pip install -e ".[docs]"
-mkdocs serve
+zensical serve
 ```
 
 
@@ -99,7 +124,7 @@ mkdocs serve
   <br />
   <a href="https://github.com/maxludden/maxludden" style="text-decoration:none; color:inherit;">
     <img
-      src="https://github.com/maxludden/maxludden/blob/f3913ecf11f90c97435e2b55d2e43dadd51c1fe4/Images/MaxLogo-animated.svg"
+      src="docs/img/MaxLogo.svg"
       alt="Max Ludden's Logo"
       width="20%"
     />

rich_gradient_cli-0.3.0/pyproject.toml

@@ -0,0 +1,59 @@
+[project]
+name = "rich-gradient-cli"
+version = "0.3.0"
+description = "CLI for printing text in gradient color using the rich-gradient library."
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "typer>=0.21.1",
+    "rich>=14.3.2",
+    "rich-color-ext>=0.1.9",
+    "rich-gradient>=0.3.9",
+]
+
+[[project.authors]]
+name = "Maxwell Ludden"
+email = "maxludden@me.com"
+
+[project.optional-dependencies]
+dev = [
+    "mypy>=1.18.2",
+    "pytest>=8.4.2",
+    "ruff>=0.15.0",
+]
+docs = [
+    "mkdocstrings>=1.0.8; python_version >= '3.11'",
+    "mkdocstrings-python>=2.0.2; python_version >= '3.11'",
+    "zensical>=0.0.68; python_version >= '3.11'",
+]
+
+[project.scripts]
+gradient = "rich_gradient_cli:entrypoint"
+
+[build-system]
+requires = ["uv_build>=0.10.0,<0.11.0"]
+build-backend = "uv_build"
+
+[tool.mypy]
+python_version = "3.10"
+mypy_path = "typings"
+files = [
+    "src",
+    "typings",
+]
+ignore_missing_imports = true
+check_untyped_defs = true
+
+[tool.ruff]
+target-version = "py310"
+src = [
+    "src",
+    "typings",
+]
+
+[tool.pylint.messages_control]
+disable = [
+    "import-error",
+    "unused-argument",
+    "W0613",
+]

rich_gradient_cli-0.3.0/pyproject.toml.orig

@@ -0,0 +1,53 @@
+[project]
+name = "rich-gradient-cli"
+version = "0.3.0"
+description = "CLI for printing text in gradient color using the rich-gradient library."
+readme = "README.md"
+authors = [
+    { name = "Maxwell Ludden", email = "maxludden@me.com" }
+]
+requires-python = ">=3.10"
+dependencies = [
+    "typer>=0.21.1",
+    "rich>=14.3.2",
+    "rich-color-ext>=0.1.9",
+    "rich-gradient>=0.3.9",
+]
+
+[project.optional-dependencies]
+dev = [
+    "mypy>=1.18.2",
+    "pytest>=8.4.2",
+    "ruff>=0.15.0",
+]
+# Docs tooling (mkdocstrings>=1.0.8, zensical) requires Python >= 3.11; on 3.10 this extra installs nothing.
+docs = [
+    "mkdocstrings>=1.0.8; python_version >= '3.11'",
+    "mkdocstrings-python>=2.0.2; python_version >= '3.11'",
+    "zensical>=0.0.68; python_version >= '3.11'",
+]
+
+[project.scripts]
+gradient = "rich_gradient_cli:entrypoint"
+
+[build-system]
+requires = ["uv_build>=0.10.0,<0.11.0"]
+build-backend = "uv_build"
+
+[tool.mypy]
+python_version = "3.10"
+mypy_path = "typings"
+files = ["src", "typings"]
+ignore_missing_imports = true
+check_untyped_defs = true
+
+[tool.ruff]
+target-version = "py310"
+src = ["src", "typings"]
+
+[tool.pylint.messages_control]
+disable = [
+    "import-error",
+    "unused-argument",
+    "W0613"
+]

{rich_gradient_cli-0.1.0 → rich_gradient_cli-0.3.0}/src/rich_gradient_cli/__init__.py

@@ -3,17 +3,45 @@
 from __future__ import annotations
 
 import sys
+from pathlib import Path
 from typing import Any, Sequence
 
 import click
 import typer
 
-from .common import VERSION
-from .help import RichTyperCommand, RichTyperGroup
-from .markdown_command import markdown_command
-from .panel_command import panel_command
-from .rule_command import rule_command
-from .text_command import print_command
+if __package__ in {None, ""}:
+    sys.path.insert(0, str(Path(__file__).resolve().parents[1]))
+    from rich_gradient_cli.common import VERSION
+    from rich_gradient_cli.gradient_command import gradient_command
+    from rich_gradient_cli.help import RichTyperCommand, RichTyperGroup
+    from rich_gradient_cli.markdown_command import markdown_command
+    from rich_gradient_cli.panel_command import panel_command
+    from rich_gradient_cli.renderable_commands import (
+        columns_command,
+        syntax_command,
+        table_command,
+        tree_command,
+    )
+    from rich_gradient_cli.rule_command import rule_command
+    from rich_gradient_cli.spectrum_command import spectrum_command
+    from rich_gradient_cli.text_command import print_command
+    from rich_gradient_cli.view_command import view_command
+else:
+    from .common import VERSION
+    from .gradient_command import gradient_command
+    from .help import RichTyperCommand, RichTyperGroup
+    from .markdown_command import markdown_command
+    from .panel_command import panel_command
+    from .renderable_commands import (
+        columns_command,
+        syntax_command,
+        table_command,
+        tree_command,
+    )
+    from .rule_command import rule_command
+    from .spectrum_command import spectrum_command
+    from .text_command import print_command
+    from .view_command import view_command
 
 
 class DefaultTyperGroup(RichTyperGroup):
@@ -32,6 +60,7 @@ class DefaultTyperGroup(RichTyperGroup):
         default_cmd_name: str = "print",
         **kwargs: Any,
     ) -> None:
+        """Initialize the group with a default command name fallback."""
         super().__init__(
             name=name,
             commands=commands,
@@ -42,11 +71,12 @@ class DefaultTyperGroup(RichTyperGroup):
             result_callback=result_callback,
             **kwargs,
         )
-        self.default_cmd_name = default_cmd_name
+        self.default_cmd_name: str = default_cmd_name
 
     def resolve_command(
         self, ctx: click.Context, args: list[str]
     ) -> tuple[str | None, click.Command | None, list[str]]:
+        """Resolve the command, routing unknown input to the default command."""
         if args:
             cmd = self.get_command(ctx, args[0])
             if cmd is None or args[0].startswith("-"):
@@ -60,7 +90,7 @@ app = typer.Typer(
     add_completion=False,
     help="Create gradient-rich text, panels, and markdown.",
     rich_markup_mode="rich",
-    context_settings={"help_option_names": ["-h", "--help"], "color": True},
+    context_settings={"help_option_names": ["--help"], "color": True},
 )
 
 
@@ -86,11 +116,27 @@ def main(
 
 
 app.command("print", cls=RichTyperCommand)(print_command)
+app.command("gradient", cls=RichTyperCommand)(gradient_command)
+app.command("columns", cls=RichTyperCommand)(columns_command)
 app.command("panel", cls=RichTyperCommand)(panel_command)
 app.command("rule", cls=RichTyperCommand)(rule_command)
 app.command("markdown", cls=RichTyperCommand)(markdown_command)
+app.command("spectrum", cls=RichTyperCommand)(spectrum_command)
+app.command("syntax", cls=RichTyperCommand)(syntax_command)
+app.command("table", cls=RichTyperCommand)(table_command)
+app.command("tree", cls=RichTyperCommand)(tree_command)
+app.command("view", cls=RichTyperCommand)(view_command)
 
 
 cli = app
 
-__all__ = ["app", "cli"]
+
+def entrypoint() -> None:
+    """Run the Typer CLI application."""
+    app()
+
+__all__ = ["app", "cli", "entrypoint"]
+
+
+if __name__ == "__main__":
+    entrypoint()

rich_gradient_cli-0.3.0/src/rich_gradient_cli/common.py

@@ -0,0 +1,189 @@
+"""Shared helpers and configuration for the rich-gradient CLI."""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+from pathlib import Path
+from typing import Any, List, Mapping, Optional, Sequence, cast
+
+from rich.console import Console, RenderableType
+from rich.padding import Padding
+from rich.style import Style
+from rich_gradient.animated_gradient import AnimatedGradient
+from rich_gradient.gradient import Gradient
+from rich_gradient.theme import GRADIENT_TERMINAL_THEME
+
+console = Console()
+try:
+    VERSION = version("rich-gradient-cli")
+except PackageNotFoundError:
+    VERSION = "0.0.0"
+
+HEADER_TEXT = (
+    "[#ff5500]r[/][#ff6f00]i[/][#ff8300]c[/]"
+    "[#ff9500]h[/][#ffa600]-[/][#ffb600]g[/][#ffc500]r[/]"
+    "[#ffd400]a[/][#ffe500]d[/][#fff400]i[/][#f9ff00]e[/]"
+    "[#e2ff00]n[/][#c8ff00]t[/][#a9ff00] [/][bold #fff]CLI[/]"
+)
+
+FOOTER_TEXT = (
+    "[#ff5500]\U0001f308[/][#ff7400] [/][#ff8c00]h[/]"
+    "[#ffa100]t[/][#ffb500]t[/][#ffc700]p[/][#ffdc00]s[/]"
+    "[#ffef00]:[/][#fbff00]/[/][#dfff00]/[/][#bdff00]m[/]"
+    "[#9aff00]a[/][#73ff00]x[/][#2aff00]l[/][#00ff5c]u[/]"
+    "[#00ff83]d[/][#00ffa6]d[/][#00ffd1]e[/][#00fff3]n[/]"
+    "[#00f4ff].[/][#00e1ff]g[/][#00ccff]i[/][#00baff]t[/]"
+    "[#00a6ff]h[/][#2192ff]u[/][#3b81ff]b[/][#4c6cff].[/]"
+    "[#6061ff]i[/][#725bff]o[/][#8253ff]/[/][#9648ff]r[/]"
+    "[#a83bff]i[/][#c22eff]c[/][#e122ff]h[/][#fb0cff]-[/]"
+    "[#ff00e6]g[/][#ff00c6]r[/][#ff00a4]a[/][#ff0089]d[/]"
+    "[#ff0066]i[/][#ff004b]e[/][#ff0036]n[/][#ff0000]t[/]"
+)
+
+
+USAGE_PREFIX = "[bold #00ff00]Usage:[/]"
+USAGE_PROG_STYLE = "#af00ff"
+USAGE_CMD_STYLE = "#0099ff"
+USAGE_BRACKET_STYLE = "#ffffff"
+
+
+def parse_colors(colors: Optional[str]) -> Optional[List[str]]:
+    """Parse comma-separated color tokens into a list."""
+    if colors is None:
+        return None
+    return [c.strip() for c in colors.split(",") if c.strip()]
+
+
+def parse_style(style: Optional[str]) -> Style:
+    """Parse a Rich style string or return a null style."""
+    if style is None:
+        return Style.null()
+    return Style.parse(style)
+
+
+def parse_mapping_options(values: Optional[Sequence[str]]) -> Optional[Mapping[str, str]]:
+    """Parse repeated KEY=VALUE CLI options into a mapping."""
+    if not values:
+        return None
+
+    parsed: dict[str, str] = {}
+    for value in values:
+        key, separator, item_value = value.partition("=")
+        key = key.strip()
+        item_value = item_value.strip()
+        if not separator or not key or not item_value:
+            raise ValueError(f"Expected KEY=VALUE, got {value!r}.")
+        parsed[key] = item_value
+    return parsed
+
+
+def parse_padding(padding: Optional[str]) -> int | tuple[int, ...] | None:
+    """Parse Rich padding shorthand from a CLI string."""
+    if padding is None:
+        return None
+
+    parts = tuple(int(part) for part in padding.split(",") if part.strip())
+    if len(parts) not in {1, 2, 4}:
+        raise ValueError("Padding must contain 1, 2, or 4 comma-separated integers.")
+    if len(parts) == 1:
+        return parts[0]
+    return parts
+
+
+def export_svg(
+    renderable: RenderableType, svg_path: str, *, end: str = "\n", no_wrap: bool = False
+) -> None:
+    """Render a Rich renderable to an SVG file."""
+    svg_console = Console(record=True, force_terminal=True, color_system="truecolor")
+    padded = Padding(renderable, (1, 4))
+    svg_console.print(padded, end=end, no_wrap=no_wrap)
+
+    Path(svg_path).write_text(
+        svg_console.export_svg(
+            title="rich-gradient",
+            theme=GRADIENT_TERMINAL_THEME,
+        ),
+        encoding="utf-8",
+    )
+
+
+def render_gradient_output(
+    renderable: RenderableType,
+    *,
+    colors: Optional[str] = None,
+    bgcolors: Optional[str] = None,
+    rainbow: bool = False,
+    hues: int = 5,
+    expand: bool = True,
+    justify: str = "left",
+    vertical_justify: str = "middle",
+    repeat_scale: float = 2.0,
+    highlight_words: Optional[Sequence[str]] = None,
+    highlight_regex: Optional[Sequence[str]] = None,
+    end: str = "\n",
+    animate: bool = False,
+    duration: Optional[float] = None,
+    svg: Optional[str] = None,
+) -> None:
+    """Render any Rich renderable through rich-gradient's Gradient wrapper."""
+    fg_list = parse_colors(colors)
+    bg_list = parse_colors(bgcolors)
+    highlight_word_map = parse_mapping_options(highlight_words)
+    highlight_regex_map = parse_mapping_options(highlight_regex)
+
+    if animate and svg:
+        raise ValueError("--svg is not supported with --animate.")
+    if animate and console.is_terminal is True:
+        animated = AnimatedGradient(
+            cast(Any, renderable),
+            colors=cast(Any, fg_list),
+            bg_colors=cast(Any, bg_list),
+            hues=hues,
+            rainbow=rainbow,
+            expand=expand,
+            justify=cast(Any, justify),
+            vertical_justify=cast(Any, vertical_justify),
+            repeat_scale=repeat_scale,
+            highlight_words=highlight_word_map,
+            highlight_regex=highlight_regex_map,
+            animate=True,
+            duration=duration,
+        )
+        animated.run()
+        return
+
+    gradient = Gradient(
+        cast(Any, renderable),
+        colors=cast(Any, fg_list),
+        bg_colors=cast(Any, bg_list),
+        hues=hues,
+        rainbow=rainbow,
+        expand=expand,
+        justify=cast(Any, justify),
+        vertical_justify=cast(Any, vertical_justify),
+        repeat_scale=repeat_scale,
+        highlight_words=highlight_word_map,
+        highlight_regex=highlight_regex_map,
+    )
+    if svg:
+        export_svg(gradient, svg, end=end)
+        return
+    console.print(gradient, end=end)
+
+
+__all__ = [
+    "VERSION",
+    "console",
+    "parse_colors",
+    "parse_mapping_options",
+    "parse_padding",
+    "parse_style",
+    "render_gradient_output",
+    "HEADER_TEXT",
+    "FOOTER_TEXT",
+    "USAGE_PREFIX",
+    "USAGE_PROG_STYLE",
+    "USAGE_CMD_STYLE",
+    "USAGE_BRACKET_STYLE",
+    "export_svg",
+]