Merge pull request #41 from Textualize/space-page

added space to page

Author: willmcgugan

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Added space key to page down to pager
+
+### Changed
+
+- Change how code blocks in markdown are rendered (remove border, adding padding)
+
+[unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.5.1...HEAD

poetry.lock

@@ -23,15 +23,15 @@ classifiers = [
 
 [tool.poetry.dependencies]
 python = "^3.7"
-rich = "^11.2.0"
+rich = "^12.0.0"
 click = "^8.0.0"
 requests = "^2.0.0"
 textual = "^0.1.15"
-rich-rst = "^1.0.0"
+rich-rst = "^1.1.7"
 
 [tool.poetry.dev-dependencies]
-black = "21.12b0"
-mypy = "^0.931"
+black = "21.1.0"
+mypy = "0.941"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

pyproject.toml

@@ -558,7 +558,7 @@ def print_usage() -> None:
             on_error("unable to read json", error)
 
     elif resource_format == MARKDOWN:
-        from rich.markdown import Markdown
+        from .markdown import Markdown
 
         markdown_data, lexer = read_resource(resource, lexer)
         renderable = Markdown(markdown_data, hyperlinks=hyperlinks)

src/rich_cli/__main__.py

@@ -0,0 +1,32 @@
+from typing import Any
+
+from rich.console import Console, ConsoleOptions, RenderResult
+from rich.markdown import Markdown, TextElement
+from rich.padding import Padding
+from rich.syntax import Syntax
+
+
+class CodeBlock(TextElement):
+    """A code block with syntax highlighting."""
+
+    style_name = "markdown.code_block"
+
+    @classmethod
+    def create(cls, markdown: "Markdown", node: Any) -> "CodeBlock":
+        node_info = node.info or ""
+        lexer_name = node_info.partition(" ")[0]
+        return cls(lexer_name or "default", markdown.code_theme)
+
+    def __init__(self, lexer_name: str, theme: str) -> None:
+        self.lexer_name = lexer_name
+        self.theme = theme
+
+    def __rich_console__(
+        self, console: Console, options: ConsoleOptions
+    ) -> RenderResult:
+        code = str(self.text).rstrip()
+        syntax = Syntax(code, self.lexer_name, theme=self.theme, word_wrap=True)
+        yield Padding(syntax, (0, 4))
+
+
+Markdown.elements["code_block"] = CodeBlock

src/rich_cli/markdown.py

@@ -58,6 +58,10 @@ def __init__(
     async def on_load(self, event: events.Load) -> None:
         await self.bind("q", "quit", "Quit")
 
+    async def on_key(self, event: events.Key) -> None:
+        if event.key == " ":
+            self.body.page_down()
+
     async def on_mount(self, event: events.Mount) -> None:
         self.body = body = ScrollView(auto_width=True)