comrak 0.0.1__tar.gz → 0.0.2__tar.gz

{comrak-0.0.1 → comrak-0.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: comrak
-Version: 0.0.1
+Version: 0.0.2
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
@@ -15,7 +15,10 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.9
 Requires-Dist: maturin[patchelf]>=1.8.2 ; extra == 'dev'
 Requires-Dist: pre-commit>=4.1.0 ; extra == 'dev'
+Requires-Dist: markdown>=3.7 ; extra == 'bench'
+Requires-Dist: markdown2>=2.5.3 ; extra == 'bench'
 Provides-Extra: dev
+Provides-Extra: bench
 Summary: Python bindings for the Comrak Rust library, a fast CommonMark/GFM parser
 Keywords: markdown,html,rust,commonmark,gfm,parser
 Author-email: Louis Maddox <louismmx@gmail.com>
@@ -51,6 +54,13 @@ pip install comrak
 
 Fast Markdown to HTML parser in Rust, shipped for Python via PyO3.
 
+## Benchmarks
+
+Tested with small (8 lines) and medium (1200 lines) markdown strings
+
+- vs. [markdown](https://pypi.org/project/markdown): 15x faster (S/M)
+- vs. [markdown2](https://pypi.org/project/markdown2): 20x (S) - 60x (M) faster
+
 ## Contributing
 
 Maintained by [lmmx](https://github.com/lmmx). Contributions welcome!

{comrak-0.0.1 → comrak-0.0.2}/README.md

@@ -24,6 +24,13 @@ pip install comrak
 
 Fast Markdown to HTML parser in Rust, shipped for Python via PyO3.
 
+## Benchmarks
+
+Tested with small (8 lines) and medium (1200 lines) markdown strings
+
+- vs. [markdown](https://pypi.org/project/markdown): 15x faster (S/M)
+- vs. [markdown2](https://pypi.org/project/markdown2): 20x (S) - 60x (M) faster
+
 ## Contributing
 
 Maintained by [lmmx](https://github.com/lmmx). Contributions welcome!

comrak-0.0.2/benchmark/README.md

@@ -0,0 +1,53 @@
+## Small string (8 lines)
+
+Source: `hello_world_x1000`
+
+```sh
+bash run_small_benchmark.sh 
+```
+
+```
+Benchmark 1: baseline
+  Time (mean ± σ):      42.2 ms ±   0.9 ms    [User: 34.0 ms, System: 7.7 ms]
+  Range (min … max):    40.6 ms …  46.0 ms    68 runs
+ 
+Benchmark 2: markdown
+  Time (mean ± σ):     854.2 ms ±   4.9 ms    [User: 833.7 ms, System: 20.0 ms]
+  Range (min … max):   844.5 ms … 861.0 ms    10 runs
+ 
+Benchmark 3: markdown2
+  Time (mean ± σ):     608.1 ms ±   6.0 ms    [User: 586.7 ms, System: 16.0 ms]
+  Range (min … max):   601.5 ms … 619.7 ms    10 runs
+ 
+Summary
+  'baseline' ran
+   14.42 ± 0.34 times faster than 'markdown2'
+   20.26 ± 0.46 times faster than 'markdown'
+```
+
+## Medium file (1200 lines)
+
+Source: `awesome_python_readme_x1000`
+
+```sh
+bash run_medium_benchmark.sh
+```
+
+```
+Benchmark 1: baseline
+  Time (mean ± σ):     126.1 ms ±   1.7 ms    [User: 110.7 ms, System: 14.9 ms]
+  Range (min … max):   123.0 ms … 129.8 ms    23 runs
+ 
+Benchmark 2: markdown
+  Time (mean ± σ):      2.070 s ±  0.010 s    [User: 2.034 s, System: 0.028 s]
+  Range (min … max):    2.054 s …  2.084 s    10 runs
+ 
+Benchmark 3: markdown2
+  Time (mean ± σ):      7.205 s ±  0.041 s    [User: 7.160 s, System: 0.024 s]
+  Range (min … max):    7.149 s …  7.299 s    10 runs
+ 
+Summary
+  'baseline' ran
+   16.42 ± 0.24 times faster than 'markdown'
+   57.14 ± 0.84 times faster than 'markdown2
+```

comrak-0.0.2/benchmark/awesome_python_readme_x1000/comrak_bench.py

@@ -0,0 +1,15 @@
+from pathlib import Path
+
+import comrak
+
+MARKDOWN_TEXT = (Path(__file__).parent / "README.md").read_text()
+
+
+def main():
+    N = 10
+    for _ in range(N):
+        _ = comrak.render_markdown(MARKDOWN_TEXT)
+
+
+if __name__ == "__main__":
+    main()

comrak-0.0.2/benchmark/awesome_python_readme_x1000/markdown2_bench.py

@@ -0,0 +1,15 @@
+from pathlib import Path
+
+import markdown2
+
+MARKDOWN_TEXT = (Path(__file__).parent / "README.md").read_text()
+
+
+def main():
+    N = 10
+    for _ in range(N):
+        _ = markdown2.markdown(MARKDOWN_TEXT)
+
+
+if __name__ == "__main__":
+    main()

comrak-0.0.2/benchmark/awesome_python_readme_x1000/markdown_bench.py

@@ -0,0 +1,15 @@
+from pathlib import Path
+
+import markdown
+
+MARKDOWN_TEXT = (Path(__file__).parent / "README.md").read_text()
+
+
+def main():
+    N = 10
+    for _ in range(N):
+        _ = markdown.markdown(MARKDOWN_TEXT)
+
+
+if __name__ == "__main__":
+    main()

comrak-0.0.2/benchmark/hello_world_x1000/comrak_bench.py

@@ -0,0 +1,22 @@
+import comrak
+
+MARKDOWN_TEXT = """
+# Example
+
+This is **bold** text with [a link](https://example.com). 
+And some list:
+- item1
+- item2
+
+The end.
+"""
+
+
+def main():
+    N = 1000
+    for _ in range(N):
+        _ = comrak.render_markdown(MARKDOWN_TEXT)
+
+
+if __name__ == "__main__":
+    main()

comrak-0.0.2/benchmark/hello_world_x1000/markdown2_bench.py

@@ -0,0 +1,22 @@
+import markdown2
+
+MARKDOWN_TEXT = """
+# Example
+
+This is **bold** text with [a link](https://example.com). 
+And some list:
+- item1
+- item2
+
+The end.
+"""
+
+
+def main():
+    N = 1000
+    for _ in range(N):
+        _ = markdown2.markdown(MARKDOWN_TEXT)
+
+
+if __name__ == "__main__":
+    main()

comrak-0.0.2/benchmark/hello_world_x1000/markdown_bench.py

@@ -0,0 +1,22 @@
+import markdown
+
+MARKDOWN_TEXT = """
+# Example
+
+This is **bold** text with [a link](https://example.com). 
+And some list:
+- item1
+- item2
+
+The end.
+"""
+
+
+def main():
+    N = 1000
+    for _ in range(N):
+        _ = markdown.markdown(MARKDOWN_TEXT)
+
+
+if __name__ == "__main__":
+    main()

comrak-0.0.2/benchmark/run_medium_benchmark.sh

@@ -0,0 +1,10 @@
+(
+    cd awesome_python_readme_x1000 && \
+    curl -sOL https://raw.githubusercontent.com/vinta/awesome-python/master/README.md && \
+    hyperfine \
+        'python comrak_bench.py' -n baseline \
+        'python markdown_bench.py' -n markdown \
+        'python markdown2_bench.py' -n markdown2 \
+        --warmup 5
+    rm README.md
+)

comrak-0.0.2/benchmark/run_small_benchmark.sh

@@ -0,0 +1,8 @@
+(
+    cd hello_world_x1000 && \
+    hyperfine \
+        'python comrak_bench.py' -n baseline \
+        'python markdown_bench.py' -n markdown \
+        'python markdown2_bench.py' -n markdown2 \
+        --warmup 5
+)

comrak-0.0.2/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = [
+    "maturin>=1.8,<2.0",
+]
+build-backend = "maturin"
+
+[project]
+name = "comrak"
+description = "Python bindings for the Comrak Rust library, a fast CommonMark/GFM parser"
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Rust",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.9",
+]
+dynamic = [
+    "version",
+]
+authors = [
+    { email = "louismmx@gmail.com", name = "Louis Maddox" },
+]
+keywords = [
+    "markdown",
+    "html",
+    "rust",
+    "commonmark",
+    "gfm",
+    "parser",
+]
+readme = "README.md"
+requires-python = ">=3.9"
+version = "0.0.2"
+
+[project.license]
+text = "MIT"
+
+[project.optional-dependencies]
+dev = [
+    "maturin[patchelf]>=1.8.2",
+    "pre-commit>=4.1.0",
+]
+bench = [
+    "markdown>=3.7",
+    "markdown2>=2.5.3",
+]
+
+[project.urls]
+Homepage = "https://github.com/lmmx/comrak"
+Repository = "https://github.com/lmmx/comrak.git"
+
+[tool.maturin]
+features = [
+    "pyo3/extension-module",
+]

{comrak-0.0.1 → comrak-0.0.2}/uv.lock

@@ -15,6 +15,10 @@ name = "comrak"
 source = { editable = "." }
 
 [package.optional-dependencies]
+bench = [
+    { name = "markdown" },
+    { name = "markdown2" },
+]
 dev = [
     { name = "maturin", extra = ["patchelf"] },
     { name = "pre-commit" },
@@ -22,6 +26,8 @@ dev = [
 
 [package.metadata]
 requires-dist = [
+    { name = "markdown", marker = "extra == 'bench'", specifier = ">=3.7" },
+    { name = "markdown2", marker = "extra == 'bench'", specifier = ">=2.5.3" },
     { name = "maturin", extras = ["patchelf"], marker = "extra == 'dev'", specifier = ">=1.8.2" },
     { name = "pre-commit", marker = "extra == 'dev'", specifier = ">=4.1.0" },
 ]
@@ -53,6 +59,39 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/03/00/1fd4a117c6c93f2dcc5b7edaeaf53ea45332ef966429be566ca16c2beb94/identify-2.6.7-py2.py3-none-any.whl", hash = "sha256:155931cb617a401807b09ecec6635d6c692d180090a1cedca8ef7d58ba5b6aa0", size = 99097 },
 ]
 
+[[package]]
+name = "importlib-metadata"
+version = "8.6.1"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "zipp" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/33/08/c1395a292bb23fd03bdf572a1357c5a733d3eecbab877641ceacab23db6e/importlib_metadata-8.6.1.tar.gz", hash = "sha256:310b41d755445d74569f993ccfc22838295d9fe005425094fad953d7f15c8580", size = 55767 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/79/9d/0fb148dc4d6fa4a7dd1d8378168d9b4cd8d4560a6fbf6f0121c5fc34eb68/importlib_metadata-8.6.1-py3-none-any.whl", hash = "sha256:02a89390c1e15fdfdc0d7c6b25cb3e62650d0494005c97d6f148bf5b9787525e", size = 26971 },
+]
+
+[[package]]
+name = "markdown"
+version = "3.7"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "importlib-metadata", marker = "python_full_version < '3.10'" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/54/28/3af612670f82f4c056911fbbbb42760255801b3068c48de792d354ff4472/markdown-3.7.tar.gz", hash = "sha256:2ae2471477cfd02dbbf038d5d9bc226d40def84b4fe2986e49b59b6b472bbed2", size = 357086 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/3f/08/83871f3c50fc983b88547c196d11cf8c3340e37c32d2e9d6152abe2c61f7/Markdown-3.7-py3-none-any.whl", hash = "sha256:7eb6df5690b81a1d7942992c97fad2938e956e79df20cbc6186e9c3a77b1c803", size = 106349 },
+]
+
+[[package]]
+name = "markdown2"
+version = "2.5.3"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/44/52/d7dcc6284d59edb8301b8400435fbb4926a9b0f13a12b5cbaf3a4a54bb7b/markdown2-2.5.3.tar.gz", hash = "sha256:4d502953a4633408b0ab3ec503c5d6984d1b14307e32b325ec7d16ea57524895", size = 141676 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/84/37/0a13c83ccf5365b8e08ea572dfbc04b8cb87cadd359b2451a567f5248878/markdown2-2.5.3-py3-none-any.whl", hash = "sha256:a8ebb7e84b8519c37bf7382b3db600f1798a22c245bfd754a1f87ca8d7ea63b3", size = 48550 },
+]
+
 [[package]]
 name = "maturin"
 version = "1.8.2"
@@ -234,3 +273,12 @@ sdist = { url = "https://files.pythonhosted.org/packages/f1/88/dacc875dd54a8acad
 wheels = [
     { url = "https://files.pythonhosted.org/packages/93/fa/849483d56773ae29740ae70043ad88e068f98a6401aa819b5d6bee604683/virtualenv-20.29.2-py3-none-any.whl", hash = "sha256:febddfc3d1ea571bdb1dc0f98d7b45d24def7428214d4fb73cc486c9568cce6a", size = 4301478 },
 ]
+
+[[package]]
+name = "zipp"
+version = "3.21.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/3f/50/bad581df71744867e9468ebd0bcd6505de3b275e06f202c2cb016e3ff56f/zipp-3.21.0.tar.gz", hash = "sha256:2c9958f6430a2040341a52eb608ed6dd93ef4392e02ffe219417c1b28b5dd1f4", size = 24545 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/b7/1a/7e4798e9339adc931158c9d69ecc34f5e6791489d469f5e50ec15e35f458/zipp-3.21.0-py3-none-any.whl", hash = "sha256:ac1bbe05fd2991f160ebce24ffbac5f6d11d83dc90891255885223d42b3cd931", size = 9630 },
+]

comrak-0.0.1/pyproject.toml

@@ -1,51 +0,0 @@
-[build-system]
-requires = ["maturin>=1.8,<2.0"]
-build-backend = "maturin"
-
-[project]
-name = "comrak"
-description = "Python bindings for the Comrak Rust library, a fast CommonMark/GFM parser"
-classifiers = [
-  "Intended Audience :: Developers",
-  "License :: OSI Approved :: MIT License",
-  "Programming Language :: Rust",
-  "Programming Language :: Python :: Implementation :: CPython",
-  "Programming Language :: Python :: Implementation :: PyPy",
-  "Operating System :: OS Independent",
-  "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.10",
-  "Programming Language :: Python :: 3.11",
-  "Programming Language :: Python :: 3.12",
-  "Programming Language :: Python :: 3.13",
-  "Programming Language :: Python :: 3.9"
-]
-dynamic = ["version"]
-authors = [
-  {email = "louismmx@gmail.com", name = "Louis Maddox"}
-]
-keywords = [
-  "markdown",
-  "html",
-  "rust",
-  "commonmark",
-  "gfm",
-  "parser"
-]
-license = {text = "MIT"}
-readme = "README.md"
-requires-python = ">=3.9"
-version = "0.0.1"
-
-[project.optional-dependencies]
-dev = [
-  "maturin[patchelf]>=1.8.2",
-  "pre-commit>=4.1.0"
-]
-
-[project.urls]
-# Documentation = "https://comrak.vercel.app/"
-Homepage = "https://github.com/lmmx/comrak"
-Repository = "https://github.com/lmmx/comrak.git"
-
-[tool.maturin]
-features = ["pyo3/extension-module"]