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

rich_gradient_cli-0.4.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Maxwell O. Ludden
+
+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.

rich_gradient_cli-0.4.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: rich-gradient-cli
+Version: 0.4.0
+Summary: Render files, URLs, stdin, and text with rich-gradient from the command line.
+Author: Maxwell Ludden
+Author-email: Maxwell Ludden <maxludden@me.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Dist: typer>=0.21.1
+Requires-Dist: rich>=15.0.0
+Requires-Dist: rich-color-ext>=3.0.0
+Requires-Dist: rich-gradient>=0.4.1
+Requires-Dist: amplitude-analytics>=1.3.0
+Requires-Dist: rich-rst>=2.2.0
+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 ; extra == 'docs'
+Requires-Dist: mkdocstrings-python>=2.0.2 ; extra == 'docs'
+Requires-Dist: zensical>=0.0.68 ; extra == 'docs'
+Requires-Python: >=3.11
+Provides-Extra: dev
+Provides-Extra: docs
+Description-Content-Type: text/markdown
+
+# rich-gradient-cli
+
+`gradient` is a single-command CLI for [`rich-gradient`](https://github.com/maxludden/rich-gradient), modeled on [`rich-cli`](https://github.com/Textualize/rich-cli): point it at a file, a URL, `-` for stdin, or literal text and it renders the result with a gradient.
+
+```text
+gradient [OPTIONS] [PATH,TEXT,URL, or '-']
+```
+
+## Installation
+
+```shell
+uv tool install rich-gradient-cli   # or: pip install rich-gradient-cli
+```
+
+Or with [Homebrew](https://brew.sh):
+
+```shell
+brew install maxludden/tap/rich-gradient-cli
+```
+
+Requires Python 3.11+.
+
+## Usage
+
+The renderable is chosen from the file extension (`.md`, `.rst`, `.ipynb`, `.json`, `.csv`/`.tsv`, source code) or by a mode flag, exactly like `rich-cli`. Literal text and stdin are printed as gradient text.
+
+```bash
+gradient --colors 'red,#ff9900,#ffff00' "Gradient text that runs red, orange, yellow!"
+gradient README.md                        # Markdown, auto-detected
+gradient pyproject.toml -n -g             # syntax with line numbers and guides
+gradient data.csv --colors cyan,magenta   # table
+gradient notebook.ipynb                   # Jupyter notebook
+cat doc.rst | gradient - --rst            # reStructuredText from stdin
+gradient https://example.com/page.md      # URL
+gradient "Title" --rule --colors blue,cyan
+gradient "Heads up" --panel rounded --title Notice
+gradient str --inspect                    # inspect a Python object
+gradient --spectrum --hues 7
+gradient --tree src                       # directory tree
+gradient README.md --export-svg out.svg   # also: -o out.html, --pager
+```
+
+![Gradient text](docs/img/commands/text-example.svg)
+
+### Options at a glance
+
+Shared flags keep their `rich-cli` spelling (`-p --print`, `-u --rule`, `-m --markdown`, `-J --json`, `-a --panel BOX`, `-d --padding`, `-s --style`, `-S --panel-style`, `-l/-c/-r` block alignment, `-L/-C/-R/-F` text justify, `-w/-W` width, `-h/-t` head/tail, `-n -g -x -y -j`, `-o --export-html`, `--export-svg`, `--pager`, `-v --version`). Gradient-specific options are long-only: `--colors`, `--bgcolors`, `--rainbow`, `--hues`, `--repeat-scale`, `--highlight-word`, `--highlight-regex`, `--animate`, `--duration`.
+
+See [docs/options.md](docs/options.md) or run `gradient --help` for the grouped list.
+
+### From `0.3` subcommands
+
+Versions up to 0.3 used subcommands (`gradient print`, `gradient panel`, `gradient view`, ...). They were replaced by flags on the one command; see the [CHANGELOG](CHANGELOG.md) for the mapping.
+
+### Telemetry
+
+Anonymous usage telemetry is **off by default**. `gradient --telemetry enable|disable|status` manages it; when enabled and `AMPLITUDE_API_KEY` is set, a `Command Run` event with the render mode and a random install ID is sent after a command succeeds.
+
+## Docs
+
+Build and preview the documentation locally with [Zensical](https://zensical.org):
+
+```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.4.0/README.md

@@ -0,0 +1,80 @@
+# rich-gradient-cli
+
+`gradient` is a single-command CLI for [`rich-gradient`](https://github.com/maxludden/rich-gradient), modeled on [`rich-cli`](https://github.com/Textualize/rich-cli): point it at a file, a URL, `-` for stdin, or literal text and it renders the result with a gradient.
+
+```text
+gradient [OPTIONS] [PATH,TEXT,URL, or '-']
+```
+
+## Installation
+
+```shell
+uv tool install rich-gradient-cli   # or: pip install rich-gradient-cli
+```
+
+Or with [Homebrew](https://brew.sh):
+
+```shell
+brew install maxludden/tap/rich-gradient-cli
+```
+
+Requires Python 3.11+.
+
+## Usage
+
+The renderable is chosen from the file extension (`.md`, `.rst`, `.ipynb`, `.json`, `.csv`/`.tsv`, source code) or by a mode flag, exactly like `rich-cli`. Literal text and stdin are printed as gradient text.
+
+```bash
+gradient --colors 'red,#ff9900,#ffff00' "Gradient text that runs red, orange, yellow!"
+gradient README.md                        # Markdown, auto-detected
+gradient pyproject.toml -n -g             # syntax with line numbers and guides
+gradient data.csv --colors cyan,magenta   # table
+gradient notebook.ipynb                   # Jupyter notebook
+cat doc.rst | gradient - --rst            # reStructuredText from stdin
+gradient https://example.com/page.md      # URL
+gradient "Title" --rule --colors blue,cyan
+gradient "Heads up" --panel rounded --title Notice
+gradient str --inspect                    # inspect a Python object
+gradient --spectrum --hues 7
+gradient --tree src                       # directory tree
+gradient README.md --export-svg out.svg   # also: -o out.html, --pager
+```
+
+![Gradient text](docs/img/commands/text-example.svg)
+
+### Options at a glance
+
+Shared flags keep their `rich-cli` spelling (`-p --print`, `-u --rule`, `-m --markdown`, `-J --json`, `-a --panel BOX`, `-d --padding`, `-s --style`, `-S --panel-style`, `-l/-c/-r` block alignment, `-L/-C/-R/-F` text justify, `-w/-W` width, `-h/-t` head/tail, `-n -g -x -y -j`, `-o --export-html`, `--export-svg`, `--pager`, `-v --version`). Gradient-specific options are long-only: `--colors`, `--bgcolors`, `--rainbow`, `--hues`, `--repeat-scale`, `--highlight-word`, `--highlight-regex`, `--animate`, `--duration`.
+
+See [docs/options.md](docs/options.md) or run `gradient --help` for the grouped list.
+
+### From `0.3` subcommands
+
+Versions up to 0.3 used subcommands (`gradient print`, `gradient panel`, `gradient view`, ...). They were replaced by flags on the one command; see the [CHANGELOG](CHANGELOG.md) for the mapping.
+
+### Telemetry
+
+Anonymous usage telemetry is **off by default**. `gradient --telemetry enable|disable|status` manages it; when enabled and `AMPLITUDE_API_KEY` is set, a `Command Run` event with the render mode and a random install ID is sent after a command succeeds.
+
+## Docs
+
+Build and preview the documentation locally with [Zensical](https://zensical.org):
+
+```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.3.0 → rich_gradient_cli-0.4.0}/pyproject.toml

@@ -1,14 +1,18 @@
 [project]
 name = "rich-gradient-cli"
-version = "0.3.0"
-description = "CLI for printing text in gradient color using the rich-gradient library."
+version = "0.4.0"
+description = "Render files, URLs, stdin, and text with rich-gradient from the command line."
 readme = "README.md"
-requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
 dependencies = [
     "typer>=0.21.1",
-    "rich>=14.3.2",
-    "rich-color-ext>=0.1.9",
-    "rich-gradient>=0.3.9",
+    "rich>=15.0.0",
+    "rich-color-ext>=3.0.0",
+    "rich-gradient>=0.4.1",
+    "amplitude-analytics>=1.3.0",
+    "rich-rst>=2.2.0",
 ]
 
 [[project.authors]]
@@ -22,9 +26,9 @@ dev = [
     "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'",
+    "mkdocstrings>=1.0.8",
+    "mkdocstrings-python>=2.0.2",
+    "zensical>=0.0.68",
 ]
 
 [project.scripts]
@@ -34,22 +38,18 @@ gradient = "rich_gradient_cli:entrypoint"
 requires = ["uv_build>=0.10.0,<0.11.0"]
 build-backend = "uv_build"
 
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
 [tool.mypy]
-python_version = "3.10"
-mypy_path = "typings"
-files = [
-    "src",
-    "typings",
-]
+python_version = "3.11"
+files = ["src"]
 ignore_missing_imports = true
 check_untyped_defs = true
 
 [tool.ruff]
-target-version = "py310"
-src = [
-    "src",
-    "typings",
-]
+target-version = "py311"
+src = ["src"]
 
 [tool.pylint.messages_control]
 disable = [
@@ -57,3 +57,6 @@ disable = [
     "unused-argument",
     "W0613",
 ]
+
+[dependency-groups]
+dev = ["pytest>=9.0.2"]

{rich_gradient_cli-0.3.0 → rich_gradient_cli-0.4.0}/pyproject.toml.orig

@@ -1,17 +1,21 @@
 [project]
 name = "rich-gradient-cli"
-version = "0.3.0"
-description = "CLI for printing text in gradient color using the rich-gradient library."
+version = "0.4.0"
+description = "Render files, URLs, stdin, and text with rich-gradient from the command line."
 readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
 authors = [
     { name = "Maxwell Ludden", email = "maxludden@me.com" }
 ]
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 dependencies = [
     "typer>=0.21.1",
-    "rich>=14.3.2",
-    "rich-color-ext>=0.1.9",
-    "rich-gradient>=0.3.9",
+    "rich>=15.0.0",
+    "rich-color-ext>=3.0.0",
+    "rich-gradient>=0.4.1",
+    "amplitude-analytics>=1.3.0",
+    "rich-rst>=2.2.0",
 ]
 
 [project.optional-dependencies]
@@ -20,11 +24,10 @@ dev = [
     "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'",
+    "mkdocstrings>=1.0.8",
+    "mkdocstrings-python>=2.0.2",
+    "zensical>=0.0.68",
 ]
 
 [project.scripts]
@@ -34,16 +37,18 @@ gradient = "rich_gradient_cli:entrypoint"
 requires = ["uv_build>=0.10.0,<0.11.0"]
 build-backend = "uv_build"
 
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
 [tool.mypy]
-python_version = "3.10"
-mypy_path = "typings"
-files = ["src", "typings"]
+python_version = "3.11"
+files = ["src"]
 ignore_missing_imports = true
 check_untyped_defs = true
 
 [tool.ruff]
-target-version = "py310"
-src = ["src", "typings"]
+target-version = "py311"
+src = ["src"]
 
 [tool.pylint.messages_control]
 disable = [
@@ -51,3 +56,8 @@ disable = [
     "unused-argument",
     "W0613"
 ]
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.2",
+]

rich_gradient_cli-0.4.0/src/rich_gradient_cli/__init__.py

@@ -0,0 +1,36 @@
+"""rich-gradient-cli: render text, files, URLs, and stdin with rich-gradient.
+
+The package exposes a single Typer application, :data:`app`, installed as the
+``gradient`` console script.
+"""
+
+import sys
+
+from . import cli
+from .cli import VERSION, app
+from .telemetry import track_command
+
+
+def entrypoint() -> None:
+    """Console-script entry point for ``gradient``.
+
+    Runs the app, then sends the opt-in telemetry event only when the command
+    completed successfully (not for ``--help``, ``--telemetry`` or usage errors).
+    """
+    try:
+        app()
+    except SystemExit as exc:
+        if exc.code in (0, None):
+            _track_success()
+        raise
+    _track_success()
+
+
+def _track_success() -> None:
+    """Send the render-mode telemetry event for a command that completed normally."""
+    if cli.invoked_mode and "--help" not in sys.argv[1:]:
+        track_command(cli.invoked_mode)
+
+
+__version__ = VERSION
+__all__ = ["VERSION", "app", "entrypoint"]