mdview-tui 0.0.1__tar.gz

mdview_tui-0.0.1/PKG-INFO

@@ -0,0 +1,31 @@
+Metadata-Version: 2.3
+Name: mdview-tui
+Version: 0.0.1
+Summary: CLI tool to view markdown files in the terminal.
+Author: Shunichiro Nomura
+Author-email: Shunichiro Nomura <nomura@space.t.u-tokyo.ac.jp>
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Dist: rich>=14.3.3
+Requires-Dist: textual[syntax]>=8.2.2
+Requires-Dist: typer>=0.24.1
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# mdview
+
+This is a thin wrapper around Textual's Markdown widget to view markdown files in the terminal.
+
+## Installation
+
+```bash
+uv tool install mdview-tui
+```
+
+## Usage
+
+```bash
+mdview <markdown-file>
+```

mdview_tui-0.0.1/README.md

@@ -0,0 +1,15 @@
+# mdview
+
+This is a thin wrapper around Textual's Markdown widget to view markdown files in the terminal.
+
+## Installation
+
+```bash
+uv tool install mdview-tui
+```
+
+## Usage
+
+```bash
+mdview <markdown-file>
+```

mdview_tui-0.0.1/pyproject.toml

@@ -0,0 +1,113 @@
+[project]
+name = "mdview-tui"
+version = "0.0.1"
+description = "CLI tool to view markdown files in the terminal."
+readme = "README.md"
+requires-python = ">=3.14"
+authors = [
+  { name = "Shunichiro Nomura", email = "nomura@space.t.u-tokyo.ac.jp" },
+]
+classifiers = [
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.14",
+  "Typing :: Typed",
+]
+dependencies = [
+  "rich>=14.3.3",
+  "textual[syntax]>=8.2.2",
+  "typer>=0.24.1",
+]
+
+[project.scripts]
+mdview = "mdview_tui:main"
+
+[dependency-groups]
+dev = [
+  "pre-commit>=4.2.0",
+  { include-group = "ruff" },
+  { include-group = "test" },
+  { include-group = "typing" },
+]
+ruff = ["ruff>=0.11.13"]
+test = [
+  "pytest>=9.0.0",
+  # "coverage>=7.8.2", # If you use coverage
+]
+typing = [
+  "basedpyright>=1.36.2",
+  "mypy>=1.16.1",
+  "ty>=0.0.8",
+  { include-group = "test" },
+]
+
+[build-system]
+requires = ["uv_build>=0.11,<0.12"]
+build-backend = "uv_build"
+
+[tool.mypy]
+strict = true
+
+[tool.pytest]
+addopts = [
+  "--capture=no",
+  "--color=yes",
+  "--log-cli-level=INFO",
+  "--strict-markers",
+  "--verbose",
+  "--verbose",
+  "-ra",  # show extra test summary info for all tests except passed tests
+]
+minversion = "9.0"
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["ALL"]
+# Modify the following rules according to your preferences
+ignore = [
+  # "PLR2004", # magic numbers
+  "S101",  # use of assert
+  "G",  # logging format
+  # "ANN101",  # missing type annotation for self in method
+  #     "ANN102",  # missing type annotation for cls in classmethod
+  #     "D100",    # missing docstring in public module
+  #     "D101",    # missing docstring in public class
+  #     "D102",    # missing docstring in public method
+  #     "D103",    # missing docstring in public function
+  #     "D104",    # missing docstring in public package
+  #     "D105",    # missing docstring in magic method
+  #     "D107",    # missing docstring in __init__
+  "D203",  # 1 blank line required before class docstring
+  "D213",  # multi-line docstring summary should start at the second line
+  # "PGH003",  # Use specific rule codes when ignoring type issues
+  #     "RET505",  # Unnecessary `else` after `return` statement
+  "ANN401",  # Dynamically typed expressions (typing.Any) are disallowed
+  # "D401",    # First line should be in imperative mood
+  "TD002",  # Missing author in TODO
+  "TD003",  # add link on issue into TODO
+  # "PLR0913", # Too many arguments to function call
+  #     "D407",    # Missing dashed underline after section
+  #     "ERA001",  # Commented out code
+  "FIX002",  # Fixme comment
+  # "S311",    # suspicious-non-cryptographic-random-usage
+  #     "EM101",   # raw-string-in-exception
+  #     "TRY003",  # Avoid specifying long messages outside the exception class
+  # "UP040", # uses `TypeAlias` annotation instead of the `type` keyword. This is to be compatible with griffe.
+]
+unfixable = [
+  "F401",  # Prevent auto-fix for unused imports
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**.py" = [
+  "D",  # Docstring
+  "INP001",  # implicit-namespace-package
+  "ANN201",  # missing-return-type-undocumented-public-function
+  "S101",  # use of assert
+]
+
+[tool.uv]
+exclude-newer = "7 days"

mdview_tui-0.0.1/src/mdview_tui/__init__.py

@@ -0,0 +1,33 @@
+"""mdview_tui is a terminal-based markdown viewer built with Textual."""
+
+from pathlib import Path  # noqa: TC003
+from typing import Annotated
+
+import typer
+from rich.console import Console
+
+from .app import MarkdownViewerApp
+
+err_console = Console(stderr=True)
+
+
+def _main(
+    file: Annotated[
+        Path,
+        typer.Argument(help="Path to the markdown file to view."),
+    ],
+) -> None:
+    """View markdown files in the terminal."""
+    if not file.exists():
+        err_console.print(f"[bold red]Error:[/] File not found: [yellow]{file}[/]")
+        raise typer.Exit(code=1)
+    if not file.is_file():
+        err_console.print(f"[bold red]Error:[/] Not a file: [yellow]{file}[/]")
+        raise typer.Exit(code=1)
+    text = file.read_text()
+    MarkdownViewerApp(text, title=str(file)).run()
+
+
+def main() -> None:
+    """Entry point for the mdview_tui application."""
+    typer.run(_main)

mdview_tui-0.0.1/src/mdview_tui/app.py

@@ -0,0 +1,37 @@
+"""MarkdownViewerApp Textual application for viewing markdown content in the terminal."""
+
+from textual.app import App, ComposeResult
+from textual.binding import Binding
+from textual.widgets import Footer, Markdown
+
+
+class MarkdownViewerApp(App):
+    """A Textual application for viewing markdown content in the terminal."""
+
+    BINDINGS = [  # noqa: RUF012
+        Binding("q", "quit", "Quit"),
+    ]
+
+    CSS = """
+    Markdown {
+        layout: stream;
+        padding: 0 2;
+    }
+    """
+
+    theme = "tokyo-night"
+
+    def __init__(self, text: str, title: str = "Markdown") -> None:
+        """Initialize the MarkdownViewerApp with the given markdown text and title."""
+        super().__init__()
+        self._text = text
+        self._title = title
+
+    def compose(self) -> ComposeResult:
+        """Compose the UI components for the application."""
+        yield Markdown(self._text)
+        yield Footer()
+
+    def on_mount(self) -> None:
+        """Set the application title on mount."""
+        self.title = self._title