rs-rich 0.0.1__tar.gz

rs_rich-0.0.1/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: rs-rich
+Version: 0.0.1
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Terminals
+Summary: Rich-compatible terminal rendering, backed by the rs-rich Rust port
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Documentation, https://buchochelliq-labs.github.io/rs-rich-cli/python/
+Project-URL: Repository, https://github.com/buchochelliq-labs/rs-rich-cli
+
+# rs-rich (Python)
+
+Rich-compatible terminal rendering for Python, backed by
+[rs-rich](https://github.com/buchochelliq-labs/rs-rich-cli), a Rust port of
+[Rich](https://github.com/Textualize/rich).
+
+```bash
+pip install rs-rich
+```
+
+Documentation: <https://buchochelliq-labs.github.io/rs-rich-cli/python/>, with a
+[getting started guide](https://buchochelliq-labs.github.io/rs-rich-cli/python/getting-started/)
+and an API reference for every module.
+
+Move a Rich program over by changing its imports:
+
+```python
+from rs_rich.console import Console   # was: from rich.console import Console
+from rs_rich.table import Table       # was: from rich.table import Table
+
+table = Table(title="Star Wars Movies")
+table.add_column("Released", justify="right", style="cyan", no_wrap=True)
+table.add_column("Title", style="magenta")
+table.add_row("Dec 20, 2019", "Star Wars: The Rise of Skywalker")
+
+console = Console()
+console.print(table)
+```
+
+All rendering happens in Rust. The Python package only maps Rich's classes
+and arguments onto the Rust ones, so output matches Rich 15.0.0 byte for
+byte (the documentation's Python section lists the few known differences).
+What the port cannot do (Jupyter output, a handful of `Table` options) raises
+`NotImplementedError` rather than rendering something different.
+
+## What is in it
+
+| | Modules |
+|---|---|
+| All of Rich's API | `rs_rich` (`print`, `print_json`, `inspect`, ...), `console`, `text`, `style`, `color`, `theme`, `markup`, `emoji`, `segment`, `measure`, `box`, `errors`, `terminal_theme`, `table`, `panel`, `rule`, `padding`, `align`, `constrain`, `styled`, `bar`, `spinner`, `columns`, `containers`, `layout`, `tree`, `markdown`, `syntax`, `pretty`, `json`, `highlighter`, `traceback`, `live`, `live_render`, `status`, `screen`, `pager`, `progress`, `progress_bar`, `prompt`, `logging` |
+| rs-rich's extensions | `rs_rich.ext` and its 38 submodules: diagnostics, structured data, diffs and test reports, transforms, workflows, tables and badges, terminal capabilities, inspectors, live layouts, CLI docs, testing and QA |
+| Images and diagrams | `rs_rich.art` (images, Sixel, FIGlet, GIFs, image diffs; Pillow images when Pillow is installed), `rs_rich.mermaid` |
+| Plugins | `rs_rich.plugins`: write highlighters, code highlighters, themes, boxes, renderers, fence renderers and transforms in Python, checked by the Rust plugin host |
+| The command line | `python -m rs_rich` and the `rich-rs` script: rs-rich's `rich` command |
+
+Your own classes render through `__rich__`, `__rich_console__` and
+`__rich_measure__`, anywhere a renderable goes.
+
+The `lumis` (tree-sitter) code highlighter is a separate build
+(`maturin build --features lumis`), and Mermaid's `mmdc` backend needs
+`--features mmdc` and Mermaid's own CLI.
+
+## Versions
+
+The package has its own version (0.0.1) and is released from `python-v…`
+tags. It bundles the rs-rich Rust crate from the same commit.
+

rs_rich-0.0.1/README.md

@@ -0,0 +1,56 @@
+# rs-rich (Python)
+
+Rich-compatible terminal rendering for Python, backed by
+[rs-rich](https://github.com/buchochelliq-labs/rs-rich-cli), a Rust port of
+[Rich](https://github.com/Textualize/rich).
+
+```bash
+pip install rs-rich
+```
+
+Documentation: <https://buchochelliq-labs.github.io/rs-rich-cli/python/>, with a
+[getting started guide](https://buchochelliq-labs.github.io/rs-rich-cli/python/getting-started/)
+and an API reference for every module.
+
+Move a Rich program over by changing its imports:
+
+```python
+from rs_rich.console import Console   # was: from rich.console import Console
+from rs_rich.table import Table       # was: from rich.table import Table
+
+table = Table(title="Star Wars Movies")
+table.add_column("Released", justify="right", style="cyan", no_wrap=True)
+table.add_column("Title", style="magenta")
+table.add_row("Dec 20, 2019", "Star Wars: The Rise of Skywalker")
+
+console = Console()
+console.print(table)
+```
+
+All rendering happens in Rust. The Python package only maps Rich's classes
+and arguments onto the Rust ones, so output matches Rich 15.0.0 byte for
+byte (the documentation's Python section lists the few known differences).
+What the port cannot do (Jupyter output, a handful of `Table` options) raises
+`NotImplementedError` rather than rendering something different.
+
+## What is in it
+
+| | Modules |
+|---|---|
+| All of Rich's API | `rs_rich` (`print`, `print_json`, `inspect`, ...), `console`, `text`, `style`, `color`, `theme`, `markup`, `emoji`, `segment`, `measure`, `box`, `errors`, `terminal_theme`, `table`, `panel`, `rule`, `padding`, `align`, `constrain`, `styled`, `bar`, `spinner`, `columns`, `containers`, `layout`, `tree`, `markdown`, `syntax`, `pretty`, `json`, `highlighter`, `traceback`, `live`, `live_render`, `status`, `screen`, `pager`, `progress`, `progress_bar`, `prompt`, `logging` |
+| rs-rich's extensions | `rs_rich.ext` and its 38 submodules: diagnostics, structured data, diffs and test reports, transforms, workflows, tables and badges, terminal capabilities, inspectors, live layouts, CLI docs, testing and QA |
+| Images and diagrams | `rs_rich.art` (images, Sixel, FIGlet, GIFs, image diffs; Pillow images when Pillow is installed), `rs_rich.mermaid` |
+| Plugins | `rs_rich.plugins`: write highlighters, code highlighters, themes, boxes, renderers, fence renderers and transforms in Python, checked by the Rust plugin host |
+| The command line | `python -m rs_rich` and the `rich-rs` script: rs-rich's `rich` command |
+
+Your own classes render through `__rich__`, `__rich_console__` and
+`__rich_measure__`, anywhere a renderable goes.
+
+The `lumis` (tree-sitter) code highlighter is a separate build
+(`maturin build --features lumis`), and Mermaid's `mmdc` backend needs
+`--features mmdc` and Mermaid's own CLI.
+
+## Versions
+
+The package has its own version (0.0.1) and is released from `python-v…`
+tags. It bundles the rs-rich Rust crate from the same commit.

rs_rich-0.0.1/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["maturin>=1.8,<2"]
+build-backend = "maturin"
+
+[project]
+name = "rs-rich"
+version = "0.0.1"
+description = "Rich-compatible terminal rendering, backed by the rs-rich Rust port"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Rust",
+    "Topic :: Terminals",
+]
+
+[project.scripts]
+# `rich` belongs to rich-cli; this package's command is `rich-rs`.
+rich-rs = "rs_rich.cli:main"
+
+[project.urls]
+Repository = "https://github.com/buchochelliq-labs/rs-rich-cli"
+Documentation = "https://buchochelliq-labs.github.io/rs-rich-cli/python/"
+
+[tool.maturin]
+module-name = "rs_rich._native"
+features = ["extension-module"]
+manifest-path = "rich-py/Cargo.toml"
+python-source = "python"

rs_rich-0.0.1/python/rs_rich/__init__.py

@@ -0,0 +1,60 @@
+"""Rich-compatible terminal rendering, backed by the rs-rich Rust port.
+
+Every class here is implemented in Rust (``rs_rich._native``); these modules
+only re-export them under Rich's module paths, so a program can move from
+``rich`` by changing its imports. See the supported surface in the README.
+"""
+
+from typing import IO, Any, Optional
+
+from . import _native
+from ._native import __version__
+from .console import Console
+
+__all__ = ["Console", "__version__", "get_console", "inspect", "print", "print_json", "reconfigure"]
+
+_console: Optional[Console] = None
+
+
+def get_console() -> Console:
+    """The global console ``rs_rich.print`` writes to, created on first use."""
+    global _console
+    if _console is None:
+        _console = Console()
+    return _console
+
+
+def reconfigure(**kwargs: Any) -> None:
+    """``rich.reconfigure``: replace the global console with ``Console(**kwargs)``.
+
+    Rich changes the existing console in place; rs_rich's native console
+    cannot be, so ``get_console()`` returns a new object afterwards.
+    """
+    global _console
+    _console = Console(**kwargs)
+
+
+def print(  # noqa: A001
+    *objects: Any,
+    sep: str = " ",
+    end: str = "\n",
+    file: Optional[IO[str]] = None,
+    flush: bool = False,
+) -> None:
+    """``rich.print``: print objects to the global console (or to ``file``)."""
+    write_console = get_console() if file is None else Console(file=file)
+    write_console.print(*objects, sep=sep, end=end)
+
+
+def print_json(json: Optional[str] = None, *, data: Any = None, **kwargs: Any) -> None:
+    """``rich.print_json``: pretty-print JSON on the global console."""
+    get_console().print_json(json, data=data, **kwargs)
+
+
+def inspect(obj: Any, **kwargs: Any) -> None:
+    """``rich.inspect``: provided by ``_native.inspect`` once the code area adds it."""
+    implementation = getattr(_native, "inspect", None)
+    if implementation is None:
+        raise NotImplementedError("rs_rich.inspect is not implemented yet")
+    kwargs.setdefault("console", get_console())
+    implementation(obj, **kwargs)

rs_rich-0.0.1/python/rs_rich/__main__.py

@@ -0,0 +1,8 @@
+"""``python -m rs_rich``: the ``rich`` command line (see :mod:`rs_rich.cli`)."""
+
+import sys
+
+from rs_rich.cli import main
+
+if __name__ == "__main__":
+    sys.exit(main())