flexdoc 0.1.0

Document model for powerful text parsing and processing in Markdown

flexdoc

flexdoc is a source-grounded, layered document model for Markdown and text. It parses a document into a FlexDoc, lets you query its structure across independent layers with a single collect() primitive, serializes it as a DocGraph, and anchors spans and edits with SpanRef so they survive a reparse.

The aim is fine-grained understanding of a complex Markdown document along several independent axes at once — its Markdown syntax (blocks, inline elements, exact spans, typed attributes), its grammar and language (paragraphs, sentences, tokens), and other structures layered onto the same text — over one shared coordinate space.

flexdoc is a standalone library. chopdiff builds its diff-filtering and windowed-transform layer on top of flexdoc.

Installation

uv add flexdoc
# or: pip install flexdoc

Usage

The primary entry point is FlexDoc, importable from the package root; the full public surfaces live in the submodules:

• flexdoc.docs — FlexDoc, Paragraph, Sentence, Section, Block, BlockType, the node table, collect(), DocGraph, SpanRef, token diffs/mappings, and word-token utilities.
• flexdoc.html — html-in-md, html/plaintext conversion, HTML tag helpers, the content extractor, and timestamp extraction.
• flexdoc.util — read-time and token-count estimation.

from flexdoc import FlexDoc

doc = FlexDoc.from_text("# Title\n\nHello world. This is a second sentence.\n")

# Round-trips back to normalized Markdown.
print(doc.reassemble())

# Human-readable size stats (paragraphs, sentences, words, ...).
print(doc.size_summary())

See usage.md for the main workflows and examples/ for worked scripts. From a repository checkout, run examples with uv run python examples/<name>.py.

Project Docs

• Design of record: docs/flexdoc-spec.md.
• The extraction program and the model’s design history: docs/project/specs/active/.
• For how to install uv and Python, see installation.md.
• For development workflows, see development.md.
• For publishing to PyPI, see publishing.md.
• Dependency policy: SUPPLY-CHAIN-SECURITY.md.

---

This project was built from simple-modern-uv.