text-region-parser

Parse regions in your Markdown/text files!

You can dynamically parse and update regions in your Markdown/text files like this:

Description of the project

<!-- region:name argument=value -->
This is a region with autogenerated content
<!-- endregion:name -->

End of the file

Installation

pip install text-region-parser
# or
uv add text-region-parser
# or
poetry add text-region-parser

Usage

from pathlib import Path
from typing import TypedDict

from text_region_parser import RegionConstructor


class ScopeOptions(TypedDict):
    name: str
    level: str


constructor = RegionConstructor()

@constructor.add_parser("scope", options_type=ScopeOptions)
def create_scope_content(options: ScopeOptions) -> str:
    """Create region `scope` with options."""
    return f"Scope: {options['name']} with level {options['level']}"


# Parse the content.
file_path = Path("README.md")
constructor.update_files_data(file_path)
print(file_path.read_text())

License

MIT