Skip to main content

Ultra-fast MDX rendering engine powered by Rust and WebAssembly.

Project description

toaq-mdx

A blazingly fast, headless MDX engine for Python, powered by a Rust core.

toaq-mdx provides a bridge between the high-performance pulldown-cmark Rust parser and native Python applications. It parses MDX (Markdown + JSX) into a deeply manipulable Abstract Syntax Tree (AST) and offers zero-dependency native rendering solutions for both the Web (HTML/KaTeX) and Desktop (PyQt5/Matplotlib).

🚀 Features

  • Blazing Fast: The core parsing is handled by a pre-compiled Rust binary.
  • Headless AST: Manipulate Markdown and JSX tags as pure Python objects (AstNode).
  • Zero-HTML Desktop Rendering: Render rich text, complex layouts, and math equations natively in PyQt5 without relying on heavy WebEngine components.
  • Universal Math Support:
    • Generates data-math attributes for KaTeX on the web.
    • Generates native QPixmap images using Matplotlib for desktop apps.
  • Fat Wheel Distribution: The Rust binary is bundled directly into the Python package. No Rust toolchain is required for end-users.

📦 Installation

pip install toaq-mdx

🛠️ Quick Start

1. Parsing MDX to AST

The core feature of toaq-mdx is transforming text into a structured, easily searchable AST.

import toaq_mdx

mdx_content = """
# Physics 101
The kinetic energy is defined as:
$$E_k = \\frac{1}{2}mv^2$$

<Note type="warning">Check your units!</Note>
"""

# Parse the text into a list of AstNode objects
nodes = toaq_mdx.parse(mdx_content)

# Easily search the AST
math_blocks = [n for n in nodes if n.node_type == "BlockMath"]
print(math_blocks[0].content) # Output: E_k = \frac{1}{2}mv^2

2. Web Rendering (HTML)

Generate clean, highly customizable HTML, perfectly suited for modern web frameworks like Next.js or FastAPI.

from toaq_mdx import HtmlRenderer, parse

nodes = parse("<Speaker name='Leon'>Welcome to the show.</Speaker>")

# Register custom rendering logic for JSX components
def render_speaker(node, ctx):
    name = node.attr_text("name")
    return f'<div class="speaker-tag">{name}</div><p>{node.text_content()}</p>'

renderer = HtmlRenderer(components={"Speaker": render_speaker})
html_output = renderer.render(nodes)

3. Native Desktop Rendering (PyQt5)

Render MDX content directly into native Qt Widgets. Math equations are seamlessly converted to high-quality images via Matplotlib.

import sys
from PyQt5.QtWidgets import QApplication, QWidget, QVBoxLayout
from toaq_mdx import OmniMDX, parse

app = QApplication(sys.argv)
window = QWidget()
layout = QVBoxLayout(window)

nodes = parse("# Hello\\nNative rendering without WebViews!")

# OmniMDX handles the Qt layout generation
engine = OmniMDX()
widget = engine.render_qt(nodes, parent=window)

layout.addWidget(widget)
window.show()
sys.exit(app.exec_())

🧠 Advanced AST Manipulation

Because the parser generates a typed AstNode tree, it is an ideal tool for large-scale text analysis, data extraction, or automated moderation.

For instance, when processing researcher submissions or generating structured vocal datasets for distinct podcast series, you can programmatically extract specific nodes while ignoring the rest of the document formatting:

from toaq_mdx import parse

script = """
# Episode 4: Quantum Mechanics

<Speaker name="Dr. Aris" voiceId="v2">
We must look closer at the probability wave.
</Speaker>

<Speaker name="Leon" voiceId="v1">
Are you certain?
</Speaker>
"""

ast = parse(script)

# Extract dialogue for Text-To-Speech (TTS) dataset generation
dataset_entries = []
for node in ast:
    if node.node_type == "Speaker":
        dataset_entries.append({
            "character": node.attr_text("name"),
            "voice_profile": node.attr_text("voiceId"),
            "text": node.text_content().strip()
        })

import json
print(json.dumps(dataset_entries, indent=2))

🏗️ Architecture

  • parser.py: High-level wrapper calling the Rust _core.pyd binary.

  • ast.py: Python dataclasses representing the parsed nodes and attributes.

  • renderer.py: Web-ready HTML generator.

  • qt_renderer.py / engine.py: Native PyQt5 widget generator.

  • math_render.py: Utilites for converting LaTeX strings to Unicode or QPixmap.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

toaq_mdx-0.1.1-py3-none-win_amd64.whl (143.2 kB view details)

Uploaded Python 3Windows x86-64

toaq_mdx-0.1.1-py3-none-manylinux_2_17_x86_64.whl (1.7 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

toaq_mdx-0.1.1-py3-none-macosx_10_9_universal2.whl (650.6 kB view details)

Uploaded Python 3macOS 10.9+ universal2 (ARM64, x86-64)

File details

Details for the file toaq_mdx-0.1.1-py3-none-win_amd64.whl.

File metadata

  • Download URL: toaq_mdx-0.1.1-py3-none-win_amd64.whl
  • Upload date:
  • Size: 143.2 kB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for toaq_mdx-0.1.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 c2fcbfbed25f8bfd85b1334cb3f7887ce3ecf3b3cf7421ee7d0fa248664c3f37
MD5 ec89647f85864dc906f15b23ff770137
BLAKE2b-256 ebb00ff78d55aee868819343a3009bba621eab469599b3cbfa92f4899032e289

See more details on using hashes here.

Provenance

The following attestation bundles were made for toaq_mdx-0.1.1-py3-none-win_amd64.whl:

Publisher: publish-python.yml on TOAQ-oss/omni-mdx-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file toaq_mdx-0.1.1-py3-none-manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for toaq_mdx-0.1.1-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 01003a169fd83afbd0d7022c14aff32034b73bfd453234d75188250878a9eb22
MD5 0cff50c256e482116bf9c49382cc87ae
BLAKE2b-256 22ab0e9b3d80e9b83e6641012b15ba76e112c6dc4d4cccbf513457a8b46c9834

See more details on using hashes here.

Provenance

The following attestation bundles were made for toaq_mdx-0.1.1-py3-none-manylinux_2_17_x86_64.whl:

Publisher: publish-python.yml on TOAQ-oss/omni-mdx-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file toaq_mdx-0.1.1-py3-none-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for toaq_mdx-0.1.1-py3-none-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 18172e3bd6b263772cf7a6213719e8f26dffd029251a8b853ea4b60f7d9465c7
MD5 00767b0cd86864cbd64cf8060c12281f
BLAKE2b-256 c8e6b7f1ce4919bb5292a28f7690f4ad096752b6dd135a11bca15b8a50d05e9a

See more details on using hashes here.

Provenance

The following attestation bundles were made for toaq_mdx-0.1.1-py3-none-macosx_10_9_universal2.whl:

Publisher: publish-python.yml on TOAQ-oss/omni-mdx-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page