readwright 0.3.0__tar.gz

readwright-0.3.0/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+on:
+  push:
+    branches: [main]
+  pull_request:
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - run: uv sync --group dev
+      - run: uv run ruff check src tests
+      - run: uv run ruff format --check src tests
+      - run: uv run pytest
+      - run: uv run readwright check

readwright-0.3.0/.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: Release
+on:
+  push:
+    tags: ["v*"]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+  pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+  github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true

readwright-0.3.0/.gitignore

@@ -0,0 +1,219 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python,visualstudiocode,vim
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,visualstudiocode,vim
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### Vim ###
+# Swap
+[._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+*~
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/python,visualstudiocode,vim
+
+# mkreadme
+.tox/

readwright-0.3.0/.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+repos:
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.21.2
+    hooks:
+      - id: gitleaks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-yaml
+      - id: check-toml
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: local
+    hooks:
+      - id: pytest
+        name: pytest
+        entry: uv run pytest
+        language: system
+        pass_filenames: false
+        stages: [pre-push]
+      - id: readwright-check
+        name: readwright check
+        entry: uv run readwright check
+        language: system
+        pass_filenames: false
+        files: ^(README\.md|README\.md\.j2|readme\.yaml|src/readwright/templates/.*)$

readwright-0.3.0/.pre-commit-hooks.yaml

@@ -0,0 +1,14 @@
+- id: readwright-check
+  name: readwright check
+  description: Fail if README.md is out of date with its readwright template.
+  entry: readwright check
+  language: python
+  pass_filenames: false
+  files: ^(README\.md|README\.md\.j2|readme\.yaml|templates/.*|docs/screenshots/.*)$
+- id: readwright-render
+  name: readwright render
+  description: Re-render README.md from its readwright template.
+  entry: readwright render
+  language: python
+  pass_filenames: false
+  files: ^(README\.md|README\.md\.j2|readme\.yaml|templates/.*|docs/screenshots/.*)$

readwright-0.3.0/.python-version

@@ -0,0 +1 @@
+3.11

readwright-0.3.0/LICENSE

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

readwright-0.3.0/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.5
+Name: readwright
+Version: 0.3.0
+Summary: Render GitHub READMEs from Jinja2 templates with badge and screenshot helpers
+Project-URL: Homepage, https://github.com/Garulf/readwright
+Project-URL: Issues, https://github.com/Garulf/readwright/issues
+Author-email: Garulf <535299+Garulf@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: badges,jinja2,markdown,readme,shields
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.11
+Requires-Dist: jinja2>=3.1
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0
+Requires-Dist: tomli-w>=1.2.0
+Requires-Dist: typer>=0.12
+Requires-Dist: watchfiles>=1.2.0
+Description-Content-Type: text/markdown
+
+<!-- generated by readwright from README.md.j2; edit the template, not this file -->
+# readwright
+
+Render GitHub READMEs from Jinja2 templates with badge and screenshot helpers.
+
+[![PyPI](https://img.shields.io/pypi/v/readwright)](https://pypi.org/project/readwright/) [![Python](https://img.shields.io/pypi/pyversions/readwright)](https://pypi.org/project/readwright/) [![License](https://img.shields.io/github/license/Garulf/readwright)](https://github.com/Garulf/readwright/blob/main/LICENSE) [![CI](https://img.shields.io/github/actions/workflow/status/Garulf/readwright/ci.yml)](https://github.com/Garulf/readwright/actions/workflows/ci.yml) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+- [Installation](#installation)
+- [Quick start](#quick-start)
+- [Template helpers](#template-helpers)
+- [Configuration](#configuration)
+- [pre-commit and GitHub Actions](#pre-commit-and-github-actions)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+```sh
+pip install readwright
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv tool install readwright
+```
+
+## Quick start
+
+```sh
+cd my-repo
+readwright init      # writes readme.yaml + README.md.j2 (autodetects owner/repo, name, license, ...)
+readwright render    # writes README.md (--watch to re-render on change, -o - for stdout)
+readwright check     # exit 1 with a diff if README.md is stale (use as a pre-commit hook / in CI)
+readwright badges    # list badge presets
+readwright blocks    # list overridable blocks and partials
+readwright show partials/install.md.j2   # print a packaged template to copy and tweak
+```
+
+Already have a README? `readwright init --from-readme` moves its body into the template so nothing is
+lost, then takes over `README.md`. Prefer `pyproject.toml`? `readwright init --pyproject` writes the config
+to `[tool.readme]`.
+
+`README.md.j2` extends the packaged `base.md.j2` and overrides only what it needs:
+
+```jinja
+{% extends "base.md.j2" %}
+
+{% block usage %}
+## Usage
+
+{{ screenshot("main", width=600) }}
+
+Run `{{ project.name }} --help`.
+{% endblock %}
+```
+
+See [`examples/`](https://github.com/Garulf/readwright/tree/main/examples) for a kitchen-sink project using every helper,
+plus Minecraft mod, HACS card and Flow Launcher plugin examples.
+
+## Template helpers
+
+| Helper | Result |
+| --- | --- |
+| `badge("pypi")`, `badge("ci", workflow="test.yml")` | Preset badge built from repo metadata |
+| `shield("Discord", "chat", "5865F2", link=...)` | Custom shields.io static badge |
+| `badges()` / `donate_badges()` | All badges from `badges:` / `donate:` in config |
+| `screenshot("main", alt=..., width=...)` | Finds `docs/screenshots/main.{png,jpg,gif,webp,svg}`; `main-dark.*` + `main-light.*` become a theme-aware pair |
+| `screenshots(columns=2)` | Gallery table of every image in the screenshots dir |
+| `image("path/or/url", "alt", width=...)` | Explicit image, no discovery |
+| `screenshots(order=[...], captions={...}, subdir=...)` | Control gallery order/captions (or drop a `captions.yaml` in the folder) |
+| `toc()`, `toc(1, 2)` | Table of contents from the headings below it (min/max level) |
+| `changelog(n=1)` | Newest `n` entries of `CHANGELOG.md` |
+| `project.*`, `vars.*` | Repo metadata and free-form config values |
+| `cli_help("mytool --help")` | Runs the command and fences its output (needs `allow_exec: true`) |
+| `include_file(path)`, `code_block(path)`, `snippet(path, start, end)` | Pull a file, a fenced file, or a marked region into the README |
+| `config_table(path, section=...)`, `env_table(".env.example")`, `entry_points_table()` | Markdown tables from YAML/TOML/JSON, env files, `[project.scripts]` |
+| `gh_link("issues", "Issues")`, `spdx_link()`, `my_ha_link("hacs_repository", owner=..., repository=...)` | Repo-relative GitHub links, SPDX license link, My Home Assistant buttons |
+| `callout("tip", text)`, `details(summary, body)`, `center(html)`, `columns([...])` | GitHub alerts, collapsibles, centered blocks, side-by-side cells |
+| `logo(width=120)`, `video("demo")`, `contributors([...])` | Theme-aware logo from `docs/logo.*`, video/gif embed, avatar grid |
+| `unsplash("photo-1518…", credit="Name", user="handle", width=1000, height=280)` | Hero image from Unsplash's CDN with the required attribution line; `banner:` in config puts one above the title |
+| `flow_install_cmd()`, `mc_versions()`, `mod_dependencies()`, `related_repos()` | Flow Launcher / Minecraft mod / related-repo tables |
+| `git_sha()`, `git_tag()`, `today()` | Build metadata (these change between renders, so `check` will flag them) |
+
+To add a badge to the top row without touching the config list, fill the `badges_extra` hook (there is a
+`donate_extra` too):
+
+```jinja
+{% block badges_extra %} {{ shield("docs", "latest", "success", link=gh_link("wiki")) }}{% endblock %}
+```
+
+Badge presets: `pypi`, `pypi-downloads`, `python`, `license`, `ci`, `codecov`, `npm`, `github-release`,
+`github-stars`, `pre-commit`, `ruff`, `version`, `modrinth`, `curseforge`, `hacs`, `ha-version`, plus donation presets `kofi`, `buymeacoffee`, `github-sponsors`,
+`patreon`, `paypal`. Add your own under `badges_custom`; set `badges_style: flat-square` (or pass
+`style=` to any badge helper) to restyle them all.
+
+Blocks in `base.md.j2`: `header`, `badges`, `donate`, `toc`, `screenshots`, `install`, `usage`, `extra`,
+`contributing`, `license`. Any packaged partial can be shadowed by a file of the same name under
+`templates/partials/` in the repo (or `~/.config/readwright/templates/` for all your repos).
+
+Image helpers emit plain markdown by default (dark/light pairs use GitHub's
+`#gh-light-mode-only`/`#gh-dark-mode-only` fragments instead of `<picture>`), and only fall back to HTML
+when you ask for something markdown can't do, like a `width=`. Set `screenshots.style: html` to always
+get `<img>`/`<picture>`/`<table>` output, or pass `html=True` to `unsplash()`/`banner:`.
+
+## Configuration
+
+`readme.yaml` in the repo root (or `[tool.readme]` in `pyproject.toml`); see
+[`examples/config-only/readme.yaml`](https://github.com/Garulf/readwright/blob/main/examples/config-only/readme.yaml) for every key,
+annotated. Everything is optional;
+metadata is autodetected from the git remote, the `LICENSE` file and whichever manifest the project
+has: `pyproject.toml`, `package.json`, `Cargo.toml`, `go.mod`, `*.csproj`, Gradle (`gradle.properties`
+mod metadata for Minecraft mods), `hacs.json` or a Flow Launcher `plugin.json`. The install section
+adapts to the project type.
+
+```yaml
+template: README.md.j2
+templates: [../shared-readme-templates, "pkg:my_org_templates"]   # extra template search paths
+output: README.md
+strict: false                     # missing screenshot -> error instead of warning
+allow_exec: false                 # let cli_help() run commands during render
+badges_style: flat-square         # optional shields.io style for every badge
+related: [{repo: other-tool, description: Sibling project}]   # for related_repos()
+banner: {unsplash: photo-1518770660439-4636190af475, credit: Alexandre Debiève, user: alexkixa}
+screenshots: {dir: docs/screenshots, width: 720, style: markdown}   # style: html for width/alignment
+badges: [pypi, python, license, {preset: ci, workflow: test.yml}, {shield: {label: Docs, message: latest, color: success}}]
+badges_custom:
+  discord: {label: Discord, message: chat, color: 5865F2, link: https://discord.gg/xyz}
+donate: [kofi, github-sponsors]
+donate_handles: {kofi: yourname, github-sponsors: yourname}
+project: {name: ..., owner: ..., repo: ..., tagline: ..., pypi: ..., npm: ..., license: ..., ci_workflow: ...}
+vars: {anything: you like}
+```
+
+Put the values you repeat across repos (donation handles, owner, custom badges) in
+`~/.config/readwright/config.yaml`; `readwright init` bakes them into each new `readme.yaml` so rendering
+stays reproducible in CI. `readwright render --user-config` merges them ad hoc.
+
+## pre-commit and GitHub Actions
+
+```yaml
+# .pre-commit-config.yaml
+- repo: https://github.com/Garulf/readwright
+  rev: v0.3.0
+  hooks:
+    - id: readwright-check
+```
+
+```yaml
+# .github/workflows/ci.yml
+- uses: Garulf/readwright@v0.3.0
+  with:
+    mode: check     # or render
+```
+
+## Contributing
+
+Issues and pull requests are welcome at [Garulf/readwright](https://github.com/Garulf/readwright).
+
+## License
+
+MIT