nanorst 1.0.0

A tiny, hookable reStructuredText-to-text converter

nanorst

nanorst converts a deliberately small subset of reStructuredText (rST) into readable plain text. A state hook can be used to convert inline formatting to other forms, such as terminal escapes or HTML.

from nanorst import rst_to_text, rst_to_terminal

assert rst_to_text("This is **important**.") == "This is important."
print(rst_to_terminal("This is **important**."))

Supported constructs include emphasis, strong emphasis, inline literals, references supplied by the caller, simple directives, and indented literal blocks. This module is intentionally a loose converter, not a standards-complete reStructuredText implementation.

Development

Create a virtual environment, then install the project and its test dependencies:

python -m pip install -e '.[test]'
pytest

Build both distribution formats and validate their metadata with:

python -m pip install '.[build]'
python -m build
twine check dist/*

Releases are published by the release.yml GitHub Actions workflow when a version tag such as v0.1.0 is pushed. Configure a PyPI Trusted Publisher for the enkore/nanorst repository, workflow release.yml, and environment pypi.

Users

borgbackup has been using nanorst since borg 1.1.0 as a lightweight rST terminal formatter for --help and borg help TOPIC. The same rST sources are also rendered using sphinx-doc for the manual.

License

BSD-3-Clause. See LICENSE.