pager

Author: willmcgugan

README.md

@@ -96,6 +96,12 @@ rich "Hello [b]World[b]!" --rule --rule-style "red" --rule-char "="
 
 ![syntax1](https://raw.githubusercontent.com/Textualize/rich-cli/main/imgs/rules1.png)
 
+## Pager
+
+Add `--pager` to display the content with a built in pager application.
+
+Scroll the pager with cursor keys, page up/down, home, end. Alternatively use the scrollbar which will be visible to the right of the terminal.
+
 ## Network
 
 The `rich` command can read files from the internet you give it a URL starting with `http://` or `https://`.

poetry.lock

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "rich-cli"
 homepage = "https://github.com/Textualize/rich-cli"
-version = "1.2.2"
+version = "1.3.0"
 description = "Command Line Interface to Rich"
 authors = ["Will McGugan <willmcgugan@gmail.com>"]
 license = "MIT"
@@ -22,10 +22,11 @@ classifiers = [
 
 
 [tool.poetry.dependencies]
-python = "^3.6.2"
+python = "^3.7"
 rich = "^11.0.0"
 click = "^8.0.0"
 requests = "^2.0.0"
+textual = "^0.1.15"
 
 [tool.poetry.dev-dependencies]
 black = "21.12b0"

pyproject.toml

@@ -2,7 +2,6 @@
 from typing import TYPE_CHECKING, List, NoReturn, Optional, Tuple
 
 import click
-from pygments.lexers.special import TextLexer
 from pygments.util import ClassNotFound
 from rich.console import Console, RenderableType
 from rich.markup import escape
@@ -37,7 +36,7 @@
     "toml": "toml",
 }
 
-VERSION = "1.2.2"
+VERSION = "1.3.0"
 
 
 def on_error(message: str, error: Optional[Exception] = None, code=-1) -> NoReturn:
@@ -98,10 +97,11 @@ def read_resource(path: str, lexer: Optional[str]) -> Tuple[str, Optional[str]]:
         if not lexer:
             from pygments.lexers import guess_lexer_for_filename
 
-            lexer = guess_lexer_for_filename(path, text).name
+            try:
+                lexer = guess_lexer_for_filename(path, text).name
+            except ClassNotFound:
+                return (text, "text")
         return (text, lexer)
-    except ClassNotFound:
-        return (text, TextLexer())
     except Exception as error:
         on_error(f"unable to read {escape(path)}", error)
 
@@ -363,6 +363,7 @@ class OptionHighlighter(RegexHighlighter):
     default="",
     help="Write HTML to [b]PATH[/b].",
 )
+@click.option("--pager", is_flag=True, help="Display in an interactive pager.")
 def main(
     resource: str,
     print: bool = False,
@@ -399,6 +400,7 @@ def main(
     hyperlinks: bool = False,
     force_terminal: bool = False,
     export_html: Optional[str] = None,
+    pager: bool = False,
 ):
     """Rich toolbox for console output."""
     console = Console(
@@ -548,12 +550,18 @@ def main(
     elif center:
         justify = "center"
 
-    console.print(
-        renderable,
-        width=None if max_width <= 0 else max_width,
-        justify=justify,
-        soft_wrap=soft,
-    )
+    if pager:
+        from .pager import PagerApp
+
+        PagerApp.run(title=resource, content=renderable)
+
+    else:
+        console.print(
+            renderable,
+            width=None if max_width <= 0 else max_width,
+            justify=justify,
+            soft_wrap=soft,
+        )
 
     if export_html:
         try:

src/rich_cli/__main__.py

@@ -0,0 +1,25 @@
+from textual import events
+from textual.app import App
+from textual.widgets import ScrollView
+
+
+class PagerApp(App):
+    """App to scroll renderable"""
+
+    def __init__(
+        self,
+        *args,
+        content=None,
+        **kwargs,
+    ) -> None:
+        self.content = content
+        super().__init__(*args, **kwargs)
+
+    async def on_load(self, event: events.Load) -> None:
+        await self.bind("q", "quit", "Quit")
+
+    async def on_mount(self, event: events.Mount) -> None:
+        self.body = body = ScrollView()
+        await self.view.dock(body)
+        await body.focus()
+        await body.update(self.content)