wenmode 0.1.0__tar.gz

wenmode-0.1.0/.editorconfig

@@ -0,0 +1,11 @@
+root=true
+
+[*]
+insert_final_newline = true
+end_of_line = lf
+indent_style = space
+indent_size = 2
+
+[*.py]
+indent_size = 4
+trim_trailing_whitespace = true

wenmode-0.1.0/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

wenmode-0.1.0/.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github:
+  - lepture

wenmode-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,54 @@
+name: Publish docs
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - "tests/**"
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: install dependencies
+        run: python -m pip install --upgrade uv
+
+      - name: sphinx build
+        run: uv run --group docs sphinx-build -b html docs public -W --keep-going
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: public
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    needs: build
+
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v5

wenmode-0.1.0/.github/workflows/pypi.yml

@@ -0,0 +1,75 @@
+name: Release to PyPI
+
+permissions:
+  contents: read
+
+on:
+  push:
+    tags:
+      - "[0-9]*"
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: build dist files
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v6
+
+    - uses: actions/setup-python@v6
+      with:
+        python-version: "3.10"
+
+    - name: install uv
+      run: python -m pip install --upgrade uv
+
+    - name: build dist
+      run: uv build
+
+    - name: check dist metadata
+      run: uv run --with twine twine check dist/*
+
+    - uses: actions/upload-artifact@v7
+      with:
+        name: artifacts
+        path: dist/*
+        if-no-files-found: error
+
+  publish:
+    environment:
+      name: pypi
+      url: https://pypi.org/project/wenmode/
+    permissions:
+      id-token: write
+    name: release to pypi
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/download-artifact@v8
+      with:
+        name: artifacts
+        path: dist
+
+    - name: Push build artifacts to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  release:
+    name: write release note
+    runs-on: ubuntu-latest
+    needs: publish
+    permissions:
+      contents: write
+
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+    - uses: actions/setup-node@v6
+      with:
+        node-version: 24
+    - run: npx changelogithub --no-group
+      continue-on-error: true
+      env:
+        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

wenmode-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,83 @@
+name: Test
+permissions:
+  contents: read
+
+on:
+  push:
+    branches-ignore:
+      - 'wip-*'
+    paths-ignore:
+      - 'docs/**'
+      - '*.md'
+      - '*.rst'
+  pull_request:
+    branches-ignore:
+      - 'wip-*'
+    paths-ignore:
+      - 'docs/**'
+      - '*.md'
+      - '*.rst'
+  workflow_dispatch:
+
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: python -m pip install --upgrade uv
+
+      - name: ruff lint
+        run: uv run --group lint ruff check .
+
+      - name: mypy lint
+        run: uv run --group lint mypy
+
+  test:
+    needs: lint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      code-quality: write
+      pull-requests: read
+
+    strategy:
+      fail-fast: false
+      max-parallel: 3
+      matrix:
+        python-version:
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: ${{ github.event.pull_request.head.sha || github.sha }}
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: python -m pip install --upgrade uv
+
+      - name: Report coverage
+        run: uv run --group test pytest --cov=wenmode --cov-report=xml
+
+      - name: Upload coverage to GitHub
+        if: ${{ matrix.python-version == '3.14' }}
+        uses: actions/upload-code-coverage@v1
+        with:
+          file: coverage.xml
+          language: Python
+          label: code-coverage/pytest
+          fail-on-error: false

wenmode-0.1.0/.gitignore

@@ -0,0 +1,19 @@
+# Editor
+.idea/
+
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+.coverage
+coverage.xml
+
+# Virtual environments
+.venv
+
+uv.lock
+demo.py
+public/

wenmode-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

wenmode-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Hsiaoming Yang
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

wenmode-0.1.0/PKG-INFO

@@ -0,0 +1,269 @@
+Metadata-Version: 2.4
+Name: wenmode
+Version: 0.1.0
+Summary: A fast, composable Markdown parser and renderer toolkit.
+Project-URL: Homepage, https://github.com/lepture/wenmode
+Project-URL: Repository, https://github.com/lepture/wenmode
+Project-URL: Issues, https://github.com/lepture/wenmode/issues
+Project-URL: Documentation, https://wenmode.lepture.com
+Author-email: Hsiaoming Yang <me@lepture.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: commonmark,markdown,mdast,parser,renderer
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# Wenmode
+
+Wenmode is a composable Markdown toolkit for Python by the same author as
+[Mistune](https://mistune.lepture.com/). It is a rewrite informed by Mistune's
+design, with a stronger focus on explicit rule composition, mdast-compatible AST
+output, extension state, and pluggable rendering.
+
+The top-level `Wenmode` class combines a parser and a renderer. By default it
+parses CommonMark-style Markdown and renders HTML.
+
+Documentation: <https://wenmode.lepture.com>
+
+## Installation
+
+```bash
+pip install wenmode
+```
+
+## Quick start
+
+```python
+from wenmode import Wenmode
+
+wenmode = Wenmode()
+
+text = '''
+# Hello
+
+This is **wenmode**.
+'''
+expected = '''
+<h1>Hello</h1>
+<p>This is <strong>wenmode</strong>.</p>
+'''
+
+html = wenmode.render(text)
+assert html == expected.lstrip()
+```
+
+Use `parse()` when you need the mdast-compatible syntax tree:
+
+```python
+from wenmode import Wenmode
+
+wenmode = Wenmode()
+text = 'A [link](https://example.com).'
+
+tree = wenmode.parse(text)
+ast = tree.to_ast()
+
+assert ast == {
+    'type': 'root',
+    'children': [
+        {
+            'type': 'paragraph',
+            'children': [
+                {'type': 'text', 'value': 'A '},
+                {
+                    'type': 'link',
+                    'children': [{'type': 'text', 'value': 'link'}],
+                    'url': 'https://example.com',
+                },
+                {'type': 'text', 'value': '.'},
+            ],
+        }
+    ],
+}
+```
+
+Pass a different renderer when you want another output format:
+
+```python
+from wenmode import RSTRenderer, Wenmode
+
+wenmode = Wenmode(renderer=RSTRenderer())
+
+text = '# Hello'
+expected = '''
+Hello
+=====
+'''
+
+rst = wenmode.render(text)
+assert rst == expected.lstrip()
+```
+
+## Rules
+
+Rules are opt-in and composable. `Wenmode()` uses the `commonmark` preset by
+default; pass an explicit rule list when you want a custom Markdown dialect.
+
+```python
+from wenmode import Wenmode
+from wenmode.rules import AtxHeading, FencedCode, Image, InlineCode, Link
+
+wenmode = Wenmode([AtxHeading, FencedCode, Link, Image, InlineCode])
+text = '''
+# h1
+
+hi `code` **strong**
+'''
+expected = '''
+<h1>h1</h1>
+<p>hi <code>code</code> **strong**</p>
+'''
+
+assert wenmode.render(text) == expected.lstrip()
+```
+
+Because `Emphasis` is not enabled above, `**strong**` stays as text.
+
+Use `Parser` directly when you only need an AST and want to choose rendering
+separately:
+
+```python
+from wenmode import HTMLRenderer, Parser
+from wenmode.presets import commonmark
+
+parser = Parser(commonmark)
+text = '# Hello'
+
+tree = parser.parse(text)
+
+html = HTMLRenderer().render(tree)
+```
+
+Use the `github` preset for GitHub-flavored Markdown features such as tables,
+task lists, strikethrough, extended autolinks, and footnotes:
+
+```python
+from wenmode import Wenmode
+from wenmode.presets import github
+
+wenmode = Wenmode(github)
+```
+
+## Benchmark
+
+Wenmode is designed so enabling more rules adds limited dispatch overhead. The
+benchmark script compares Markdown-to-HTML throughput across Wenmode and the
+libraries covered by the migration guides:
+
+```bash
+uv run --group benchmark python scripts/benchmark.py --case all
+```
+
+`wenmode-core` uses CommonMark-style rules plus pipe tables. The other parsers
+are configured to match that feature set as closely as their APIs allow:
+CommonMark-style parsing plus pipe table support. `commonmark.py` is included
+as a CommonMark-only parser because it does not support pipe tables.
+
+`wenmode-all` uses the `github` preset plus Wenmode's remaining built-in rules,
+including directives, math, definition lists, abbreviations, spoilers, ruby
+text, and additional inline formatting. These extra rules are mostly unused by
+the benchmark corpora, so `wenmode-all` measures the overhead of carrying many
+additional rules rather than a syntax-equivalent comparison with the other
+parsers.
+
+All benchmark targets are created once before warmup and timed iterations, then
+reused for every render call. Python-Markdown is the exception only in that the
+same `Markdown` instance is reset before each conversion, matching its reusable
+API shape. Marko uses `marko.ext.gfm.gfm`, which is a reusable `Markdown`
+instance rather than a newly created converter per iteration.
+
+The rule sets are intentionally close, not identical. `wenmode-core` uses
+CommonMark-style rules plus pipe tables with raw HTML passthrough and URL
+sanitization disabled for parity with the other HTML renderers. Mistune,
+Python-Markdown, markdown-it-py, and markdown2 enable their table support.
+Marko uses its GFM helper, which is broader than just tables. `commonmark.py`
+is included as a CommonMark-only baseline because it has no pipe table support.
+`wenmode-all` is deliberately broader than the other targets.
+
+Versions used in these snapshots:
+
+| Library | Version |
+| --- | ---: |
+| wenmode | 0.1.0 |
+| mistune | 3.2.1 |
+| python-markdown | 3.10.2 |
+| markdown-it-py | 4.2.0 |
+| markdown2 | 2.5.5 |
+| marko | 2.2.3 |
+| commonmark.py | 0.9.2 |
+
+Mean time from one local `--case all` run:
+
+| Case | Bytes | Library | Mean | MB/s | vs core |
+| --- | ---: | --- | ---: | ---: | ---: |
+| docs | 53,792 | wenmode-core | 4.84ms | 11.58 | 1.00x |
+| docs | 53,792 | wenmode-all | 5.89ms | 9.59 | 0.82x |
+| docs | 53,792 | mistune | 8.64ms | 6.89 | 0.56x |
+| docs | 53,792 | markdown-it-py | 13.27ms | 4.19 | 0.36x |
+| docs | 53,792 | commonmark.py | 20.72ms | 2.67 | 0.23x |
+| docs | 53,792 | python-markdown | 28.98ms | 1.88 | 0.17x |
+| docs | 53,792 | markdown2 | 43.34ms | 1.25 | 0.11x |
+| docs | 53,792 | marko | 49.65ms | 1.11 | 0.10x |
+| rust-book | 1,225,464 | wenmode-core | 138.87ms | 9.07 | 1.00x |
+| rust-book | 1,225,464 | wenmode-all | 156.48ms | 8.09 | 0.89x |
+| rust-book | 1,225,464 | mistune | 214.92ms | 6.53 | 0.65x |
+| rust-book | 1,225,464 | markdown-it-py | 360.20ms | 3.49 | 0.39x |
+| rust-book | 1,225,464 | python-markdown | 624.73ms | 2.00 | 0.22x |
+| rust-book | 1,225,464 | marko | 1.178s | 1.04 | 0.12x |
+| rust-book | 1,225,464 | markdown2 | 4.082s | 0.30 | 0.03x |
+| rust-book | 1,225,464 | commonmark.py | 9.619s | 0.14 | 0.01x |
+| progit | 502,090 | wenmode-core | 26.61ms | 19.24 | 1.00x |
+| progit | 502,090 | wenmode-all | 35.31ms | 16.36 | 0.75x |
+| progit | 502,090 | mistune | 44.01ms | 12.40 | 0.60x |
+| progit | 502,090 | markdown-it-py | 76.29ms | 7.15 | 0.35x |
+| progit | 502,090 | python-markdown | 149.01ms | 3.47 | 0.18x |
+| progit | 502,090 | commonmark.py | 347.45ms | 1.49 | 0.08x |
+| progit | 502,090 | marko | 357.08ms | 1.43 | 0.07x |
+| progit | 502,090 | markdown2 | 1.425s | 0.35 | 0.02x |
+
+In this run, `wenmode-all` remains faster than the other parsers even after
+loading many extra rules that the benchmark inputs mostly do not use.
+
+## Streaming
+
+Use the `streaming` preset when you want to render HTML chunks without waiting
+for the entire document to be parsed and rendered:
+
+```python
+from wenmode import Wenmode
+from wenmode.presets import streaming
+
+wenmode = Wenmode(streaming)
+
+text = '''
+# Hello
+
+A [link](/url).
+'''
+
+for chunk in wenmode.stream(text):
+    send(chunk)
+```
+
+The returned iterator can be passed to streaming responses in frameworks such
+as Django, Flask, and FastAPI.