html-to-markdown 2.2.0__cp310-abi3-win_amd64.whl → 2.3.0__cp310-abi3-win_amd64.whl

html_to_markdown/__init__.py

@@ -39,4 +39,4 @@ __all__ = [
     "markdownify",
 ]
 
-__version__ = "2.2.0"
+__version__ = "2.3.0"

html_to_markdown/cli_proxy.py

@@ -97,7 +97,7 @@ def translate_v1_args_to_v2(argv: list[str]) -> list[str]:
 
 
 def main(argv: list[str]) -> str:
-    """Main entry point for the CLI proxy.
+    """Execute the CLI proxy.
 
     Translates v1 arguments to v2 and invokes the native Rust CLI binary.
 

{html_to_markdown-2.2.0.dist-info → html_to_markdown-2.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: html-to-markdown
-Version: 2.2.0
+Version: 2.3.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -52,11 +52,11 @@ Apple M4 • Real Wikipedia documents • `convert()` (Python)
 
 | Document            | Size  | Latency | Throughput | Docs/sec |
 | ------------------- | ----- | ------- | ---------- | -------- |
-| Lists (Timeline)    | 129KB | 0.62ms  | 208 MB/s   | 1,613    |
-| Tables (Countries)  | 360KB | 2.02ms  | 178 MB/s   | 495      |
-| Mixed (Python wiki) | 656KB | 4.56ms  | 144 MB/s   | 219      |
+| Lists (Timeline)    | 129KB | 0.62ms  | 208 MB/s   | 1,613    |
+| Tables (Countries)  | 360KB | 2.02ms  | 178 MB/s   | 495      |
+| Mixed (Python wiki) | 656KB | 4.56ms  | 144 MB/s   | 219      |
 
-> V1 averaged ~2.5 MB/s (Python/BeautifulSoup). V2’s Rust engine delivers 60–80× higher throughput.
+> V1 averaged ~2.5 MB/s (Python/BeautifulSoup). V2's Rust engine delivers 60–80× higher throughput.
 
 ## Quick Start
 
@@ -173,11 +173,50 @@ Key fields (see docstring for full matrix):
 - `capture_svg`: collect inline `<svg>` (default `True`)
 - `infer_dimensions`: decode raster images to obtain dimensions (default `False`)
 
+## Performance: V2 vs V1 Compatibility Layer
+
+### ⚠️ Important: Always Use V2 API
+
+The v2 API (`convert()`) is **strongly recommended** for all code. The v1 compatibility layer adds significant overhead and should only be used for gradual migration:
+
+```python
+# ✅ RECOMMENDED - V2 Direct API (Fast)
+from html_to_markdown import convert, ConversionOptions
+
+markdown = convert(html)  # Simple conversion - FAST
+markdown = convert(html, ConversionOptions(heading_style="atx"))  # With options - FAST
+
+# ❌ AVOID - V1 Compatibility Layer (Slow)
+from html_to_markdown import convert_to_markdown
+
+markdown = convert_to_markdown(html, heading_style="atx")  # Adds 77% overhead
+```
+
+### Performance Comparison
+
+Benchmarked on Apple M4 with 25-paragraph HTML document:
+
+| API                      | ops/sec          | Relative Performance | Recommendation      |
+| ------------------------ | ---------------- | -------------------- | ------------------- |
+| **V2 API** (`convert()`) | **129,822**      | baseline             | ✅ **Use this**     |
+| **V1 Compat Layer**      | **67,673**       | **77% slower**       | ⚠️ Migration only   |
+| **CLI**                  | **150-210 MB/s** | Fastest              | ✅ Batch processing |
+
+The v1 compatibility layer creates extra Python objects and performs additional conversions, significantly impacting performance.
+
+### When to Use Each
+
+- **V2 API (`convert()`)**: All new code, production systems, performance-critical applications ← **Use this**
+- **V1 Compat (`convert_to_markdown()`)**: Only for gradual migration from legacy codebases
+- **CLI (`html-to-markdown`)**: Batch processing, shell scripts, maximum throughput
+
 ## v1 Compatibility
 
-- **Performance**: V1 averaged ~2.5 MB/s; V2 sustains 150–210 MB/s with identical Markdown output.
-- **Compat shim**: `html_to_markdown.v1_compat` exposes `convert_to_markdown`, `convert_to_markdown_stream`, and `markdownify` to ease migration. Keyword mappings are listed in the [changelog](CHANGELOG.md#v200).
-- **CLI**: The Rust CLI replaces the Python script. New flags are documented via `html-to-markdown --help`.
+A compatibility layer is provided to ease migration from v1.x:
+
+- **Compat shim**: `html_to_markdown.v1_compat` exposes `convert_to_markdown`, `convert_to_markdown_stream`, and `markdownify`. Keyword mappings are listed in the [changelog](CHANGELOG.md#v200).
+- **⚠️ Performance warning**: These compatibility functions add 77% overhead. Migrate to v2 API as soon as possible.
+- **CLI**: The Rust CLI replaces the old Python script. New flags are documented via `html-to-markdown --help`.
 - **Removed options**: `code_language_callback`, `strip`, and streaming APIs were removed; use `ConversionOptions`, `PreprocessingOptions`, and the inline-image helpers instead.
 
 ## Links

html_to_markdown-2.3.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+html_to_markdown-2.3.0.data/scripts/html-to-markdown.exe,sha256=NoG5btr57ihL85-URLcreFRZTiAUfO7km_FiEUMa7xI,4469760
+html_to_markdown-2.3.0.dist-info/METADATA,sha256=wcmX8lAc-dZZp8ETrpbXqu58Kf19n3fE6ubBPd0OfKU,9012
+html_to_markdown-2.3.0.dist-info/WHEEL,sha256=4EDp_7DiFfWl1yYv5M4wSosAn5L_xgD1dyrQxQxfCx8,95
+html_to_markdown-2.3.0.dist-info/licenses/LICENSE,sha256=QhKFMkQLa4mSUlOsyG9VElzC7GYbAKtiS_EwOCyH-b4,1107
+html_to_markdown/__init__.py,sha256=KgR9V82EqdL5S7dzK_USOv6STjyhVRJubDYScHxOJS0,1191
+html_to_markdown/__main__.py,sha256=5objj9lB7hhpSpZsDok5tv9o9yztVR63Ccww-pXsAyY,343
+html_to_markdown/_html_to_markdown.pyd,sha256=Peez6o-WS_O6Cc3YqbxjJzRVw0mLY5HsbJyfeoYj7BY,4214784
+html_to_markdown/_rust.pyi,sha256=JP8tvcjYDfFJeJkbLpQ4qeK-5jl0hzIVT3Sa0daTkyo,2171
+html_to_markdown/api.py,sha256=U7-Tu8TaVa32vveCtiOhTwoEojklkDV2e-6ItAiP3d4,2858
+html_to_markdown/bin/html-to-markdown.exe,sha256=NoG5btr57ihL85-URLcreFRZTiAUfO7km_FiEUMa7xI,4469760
+html_to_markdown/cli.py,sha256=z59l8sF8wIRRzJtUd-tXgqiC0WTqkTjzl-df8Ey_oQ0,67
+html_to_markdown/cli_proxy.py,sha256=JGOuINBI8OMYLxojXGz8DdzMHo8eqgdINstOZWrdw-8,3816
+html_to_markdown/exceptions.py,sha256=31VqpPi4JLGv7lI2481Z4f2s5ejYmq97c3s-WFFkXVU,2443
+html_to_markdown/options.py,sha256=jna7fx9bHhx8N7u5IYtMXganFFzdJSVVgLZW0tYk3GA,5054
+html_to_markdown/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+html_to_markdown/v1_compat.py,sha256=aVt9cVTBfYcrS8EfBsrC6HQwWc3Kz9-65-LB9foN6Jk,8227
+html_to_markdown-2.3.0.dist-info/RECORD,,

html_to_markdown-2.2.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-html_to_markdown-2.2.0.data/scripts/html-to-markdown.exe,sha256=aMAtVnodlg1vMH3l9sQOHHpRJN6c9D0nEnBqjsjz0Cg,4465664
-html_to_markdown-2.2.0.dist-info/METADATA,sha256=dpiwXABx23YyxSxDe9hiHcspTwNLtCO35TMXLt7KAYQ,7233
-html_to_markdown-2.2.0.dist-info/WHEEL,sha256=4EDp_7DiFfWl1yYv5M4wSosAn5L_xgD1dyrQxQxfCx8,95
-html_to_markdown-2.2.0.dist-info/licenses/LICENSE,sha256=QhKFMkQLa4mSUlOsyG9VElzC7GYbAKtiS_EwOCyH-b4,1107
-html_to_markdown/__init__.py,sha256=qNK0cpaGcb8H2zl9BFO9sG_RQs4hMp_GrihUuIHqV10,1191
-html_to_markdown/__main__.py,sha256=5objj9lB7hhpSpZsDok5tv9o9yztVR63Ccww-pXsAyY,343
-html_to_markdown/_html_to_markdown.pyd,sha256=44hglf_qiVnD8-bCpsScL_qxKiWRlNjl1ai_Hpko26U,4211200
-html_to_markdown/_rust.pyi,sha256=JP8tvcjYDfFJeJkbLpQ4qeK-5jl0hzIVT3Sa0daTkyo,2171
-html_to_markdown/api.py,sha256=U7-Tu8TaVa32vveCtiOhTwoEojklkDV2e-6ItAiP3d4,2858
-html_to_markdown/bin/html-to-markdown.exe,sha256=aMAtVnodlg1vMH3l9sQOHHpRJN6c9D0nEnBqjsjz0Cg,4465664
-html_to_markdown/cli.py,sha256=z59l8sF8wIRRzJtUd-tXgqiC0WTqkTjzl-df8Ey_oQ0,67
-html_to_markdown/cli_proxy.py,sha256=J2Qk9MnnkFKIroxc0wn79nzI0dXqXDDNEAF9o9hth9Y,3829
-html_to_markdown/exceptions.py,sha256=31VqpPi4JLGv7lI2481Z4f2s5ejYmq97c3s-WFFkXVU,2443
-html_to_markdown/options.py,sha256=jna7fx9bHhx8N7u5IYtMXganFFzdJSVVgLZW0tYk3GA,5054
-html_to_markdown/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-html_to_markdown/v1_compat.py,sha256=aVt9cVTBfYcrS8EfBsrC6HQwWc3Kz9-65-LB9foN6Jk,8227
-html_to_markdown-2.2.0.dist-info/RECORD,,