Skip to main content

Ultra-fast MDX rendering engine powered by Rust.

Project description

omni-mdx

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

omni-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 omni-mdx

🛠️ Quick Start

1. Parsing MDX to AST

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

import omni_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
ast = omni_mdx.parse(mdx_content)

# Easily search the AST
math_blocks = [n for n in ast.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 omni_mdx import HtmlRenderer, parse

ast = 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(ast.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.

from omni_mdx.qt_renderer import QtRenderer

ast = parse("# Hello\\nNative rendering without WebViews!")
renderer = QtRenderer()
widget = renderer.render(ast.nodes, parent=window)

🧠 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 omni_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.nodes:
    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.

omni_mdx-0.1.18.dev1775497568-cp313-cp313-win_amd64.whl (630.8 kB view details)

Uploaded CPython 3.13Windows x86-64

omni_mdx-0.1.18.dev1775497568-cp313-cp313-manylinux_2_34_x86_64.whl (815.1 kB view details)

Uploaded CPython 3.13manylinux: glibc 2.34+ x86-64

omni_mdx-0.1.18.dev1775497568-cp313-cp313-macosx_11_0_arm64.whl (711.7 kB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

File details

Details for the file omni_mdx-0.1.18.dev1775497568-cp313-cp313-win_amd64.whl.

File metadata

File hashes

Hashes for omni_mdx-0.1.18.dev1775497568-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 7b7d4d2ae4144325a2be1e857ae8dccf6c443722472337530fbe35d0a56e8265
MD5 7825d8200485c500d15d7cab7f9ca253
BLAKE2b-256 42f6267e0d66e04bfce861a746dfe2569868ab34cbc48b326301684d521c2462

See more details on using hashes here.

Provenance

The following attestation bundles were made for omni_mdx-0.1.18.dev1775497568-cp313-cp313-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 omni_mdx-0.1.18.dev1775497568-cp313-cp313-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for omni_mdx-0.1.18.dev1775497568-cp313-cp313-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 270e0b5c5e7d959cc53675c8a164808825d9392775d093787a7510ad4df02bfc
MD5 7990932eebc2ef2bf2194b39632f6623
BLAKE2b-256 1cfe41ba04ee88746f8872baa319794d0d5c3a937eb93c839acfe90870df6cd0

See more details on using hashes here.

Provenance

The following attestation bundles were made for omni_mdx-0.1.18.dev1775497568-cp313-cp313-manylinux_2_34_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 omni_mdx-0.1.18.dev1775497568-cp313-cp313-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for omni_mdx-0.1.18.dev1775497568-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 91ba5c585fa8a6d226d5e44d085ae5ad455bff1195760fc2a677580687fcf5f3
MD5 d1f4fe7a4472965efc30b0fd7fe0cd34
BLAKE2b-256 83ea81df250ba3ed2cc46e0bee7b8c9de9b0ee23517e62d865ae111da9622f82

See more details on using hashes here.

Provenance

The following attestation bundles were made for omni_mdx-0.1.18.dev1775497568-cp313-cp313-macosx_11_0_arm64.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