yom 0.1.0a0__tar.gz

yom-0.1.0a0/LICENSE

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

yom-0.1.0a0/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: yom
+Version: 0.1.0a0
+Summary: Markdown tree web server with live updates
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Markdown>=3.6
+Requires-Dist: watchdog>=6.0.0
+Dynamic: license-file
+
+# yom
+
+`yom` is a local web viewer for Markdown trees. It scans a directory, renders `.md` files, and serves them in a sidebar-based browser UI with live reload.
+
+## Features
+
+- Recursively discovers Markdown files
+- Shows a file tree in the sidebar
+- Renders Markdown as HTML
+- Resolves relative links and image paths inside Markdown
+- Watches for file changes and updates the browser automatically
+- Starts a local server with a single command
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install yom
+```
+
+If you use `uv`, you can also run it without a manual virtual environment step:
+
+```bash
+uv tool install yom
+```
+
+## Quick Start
+
+Serve the current directory:
+
+```bash
+yom .
+```
+
+Serve a specific directory:
+
+```bash
+yom /path/to/docs
+```
+
+By default, `yom` starts a local server on `http://127.0.0.1:8000` and opens it in your browser.
+
+## Usage
+
+```bash
+yom /path/to/docs --host 127.0.0.1 --port 8000 --interval 0.7 --title "My docs"
+```
+
+Options available through `yom --help`:
+
+- `root`: directory to scan
+- `--host`: bind host
+- `--port`: bind port
+- `--interval`: polling interval for change detection, in seconds
+- `--no-watch`: disable file watching
+- `--watch-mode {auto,poll,watchdog}`: choose the watch backend
+- `--title`: browser window title
+- `--no-open`: disable automatic browser launch on startup
+- `--markdown-extension NAME`: enable an additional Markdown extension
+- `--no-default-extensions`: disable the built-in Markdown extensions
+
+Enable an extra Markdown extension:
+
+```bash
+yom /path/to/docs --markdown-extension admonition
+```
+
+`--markdown-extension` does not enable a yom-specific feature. It passes an additional
+extension name through to the underlying Python-Markdown renderer. For example,
+`admonition` enables admonition block syntax supported by Python-Markdown.
+
+By default, yom enables `fenced_code`, `tables`, `toc`, and `sane_lists`. Use
+`--no-default-extensions` if you want to start from an empty extension set and opt in
+only to the extensions you need.
+
+Run with the minimal Markdown configuration:
+
+```bash
+yom /path/to/docs --no-default-extensions
+```
+
+## Relative Paths
+
+- Markdown links such as `./other.md` and `../guide.md` are converted into in-app navigation
+- Image paths such as `./image.png` are served as local assets
+- References that point outside the scanned directory tree are left unresolved
+
+## Watch Behavior
+
+To disable file watching:
+
+```bash
+yom /path/to/docs --no-watch
+```
+
+To force the `watchdog` backend:
+
+```bash
+yom /path/to/docs --watch-mode watchdog
+```
+
+To disable automatic browser opening:
+
+```bash
+yom /path/to/docs --no-open
+```
+
+## Development
+
+For local development with the repository checked out:
+
+```bash
+uv sync --group dev
+make test
+make ci-check
+```
+
+The Japanese translation is available at [README.ja.md](README.ja.md).

yom-0.1.0a0/README.md

@@ -0,0 +1,119 @@
+# yom
+
+`yom` is a local web viewer for Markdown trees. It scans a directory, renders `.md` files, and serves them in a sidebar-based browser UI with live reload.
+
+## Features
+
+- Recursively discovers Markdown files
+- Shows a file tree in the sidebar
+- Renders Markdown as HTML
+- Resolves relative links and image paths inside Markdown
+- Watches for file changes and updates the browser automatically
+- Starts a local server with a single command
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install yom
+```
+
+If you use `uv`, you can also run it without a manual virtual environment step:
+
+```bash
+uv tool install yom
+```
+
+## Quick Start
+
+Serve the current directory:
+
+```bash
+yom .
+```
+
+Serve a specific directory:
+
+```bash
+yom /path/to/docs
+```
+
+By default, `yom` starts a local server on `http://127.0.0.1:8000` and opens it in your browser.
+
+## Usage
+
+```bash
+yom /path/to/docs --host 127.0.0.1 --port 8000 --interval 0.7 --title "My docs"
+```
+
+Options available through `yom --help`:
+
+- `root`: directory to scan
+- `--host`: bind host
+- `--port`: bind port
+- `--interval`: polling interval for change detection, in seconds
+- `--no-watch`: disable file watching
+- `--watch-mode {auto,poll,watchdog}`: choose the watch backend
+- `--title`: browser window title
+- `--no-open`: disable automatic browser launch on startup
+- `--markdown-extension NAME`: enable an additional Markdown extension
+- `--no-default-extensions`: disable the built-in Markdown extensions
+
+Enable an extra Markdown extension:
+
+```bash
+yom /path/to/docs --markdown-extension admonition
+```
+
+`--markdown-extension` does not enable a yom-specific feature. It passes an additional
+extension name through to the underlying Python-Markdown renderer. For example,
+`admonition` enables admonition block syntax supported by Python-Markdown.
+
+By default, yom enables `fenced_code`, `tables`, `toc`, and `sane_lists`. Use
+`--no-default-extensions` if you want to start from an empty extension set and opt in
+only to the extensions you need.
+
+Run with the minimal Markdown configuration:
+
+```bash
+yom /path/to/docs --no-default-extensions
+```
+
+## Relative Paths
+
+- Markdown links such as `./other.md` and `../guide.md` are converted into in-app navigation
+- Image paths such as `./image.png` are served as local assets
+- References that point outside the scanned directory tree are left unresolved
+
+## Watch Behavior
+
+To disable file watching:
+
+```bash
+yom /path/to/docs --no-watch
+```
+
+To force the `watchdog` backend:
+
+```bash
+yom /path/to/docs --watch-mode watchdog
+```
+
+To disable automatic browser opening:
+
+```bash
+yom /path/to/docs --no-open
+```
+
+## Development
+
+For local development with the repository checked out:
+
+```bash
+uv sync --group dev
+make test
+make ci-check
+```
+
+The Japanese translation is available at [README.ja.md](README.ja.md).

yom-0.1.0a0/pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "yom"
+version = "0.1.0a0"
+description = "Markdown tree web server with live updates"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+  "Markdown>=3.6",
+  "watchdog>=6.0.0",
+]
+
+[dependency-groups]
+dev = [
+  "pytest>=8.3.0",
+  "ruff>=0.11.0",
+  "ty>=0.0.1a14",
+]
+
+[project.scripts]
+yom = "yom.cli:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+yom = ["assets/*.html", "assets/*.css", "assets/*.js"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]

yom-0.1.0a0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

yom-0.1.0a0/src/yom/__init__.py

@@ -0,0 +1,3 @@
+__all__ = ["__version__"]
+
+__version__ = "0.1.0"

yom-0.1.0a0/src/yom/__main__.py

@@ -0,0 +1,4 @@
+from yom.cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())