markitdown-plus 0.2.0__py3-none-any.whl

markitdown_plus-0.2.0.dist-info/METADATA

@@ -0,0 +1,292 @@
+Metadata-Version: 2.4
+Name: markitdown-plus
+Version: 0.2.0
+Summary: Batch conversion, asset extraction, and RAG-ready output toolkit for Microsoft MarkItDown.
+Project-URL: Homepage, https://github.com/lamguo/markitdown-plus
+Project-URL: Repository, https://github.com/lamguo/markitdown-plus
+Project-URL: Issues, https://github.com/lamguo/markitdown-plus/issues
+Project-URL: Funding, https://www.paypal.me/lamguo
+Author-email: Lam Guo <lamguo111@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: asset-extraction,batch-conversion,document-conversion,docx-to-markdown,jsonl,llm,markdown,markitdown,microsoft-markitdown,pdf-to-markdown,rag
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.10
+Requires-Dist: markitdown[all]>=0.1.0
+Provides-Extra: dev
+Requires-Dist: hypothesis>=6.100; extra == 'dev'
+Requires-Dist: pytest-benchmark>=4.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6.0; extra == 'dev'
+Requires-Dist: tqdm>=4.66; extra == 'dev'
+Provides-Extra: progress
+Requires-Dist: tqdm>=4.66; extra == 'progress'
+Provides-Extra: quality
+Requires-Dist: hypothesis>=6.100; extra == 'quality'
+Requires-Dist: pytest-benchmark>=4.0; extra == 'quality'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=5.0; extra == 'test'
+Requires-Dist: pytest>=8.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# MarkItDown Plus
+
+Batch conversion, asset extraction, RAG-ready Markdown, JSONL chunks, and cleaner AI document pipelines for **Microsoft MarkItDown**.
+
+MarkItDown Plus is an enhancement toolkit built on top of Microsoft MarkItDown. It adds folder conversion, recursive processing, optional parallel workers, Markdown cleanup, multiple chunking strategies, lightweight asset extraction, conversion manifests, and JSONL output for RAG workflows.
+
+> This project is independent and is not affiliated with Microsoft. It is designed as a companion CLI for the Microsoft MarkItDown ecosystem.
+
+## Why MarkItDown Plus?
+
+Microsoft MarkItDown is excellent for converting individual files to Markdown. MarkItDown Plus focuses on the next step: turning many documents into clean, AI-ready project output.
+
+Key features:
+
+- Batch convert files and folders
+- Recursive directory conversion
+- Parallel conversion with `--workers`
+- Optional tqdm progress with `--progress`
+- RAG-ready JSONL chunk export
+- Chunk strategies: `heading`, `fixed`, `semantic-lite`
+- Markdown cleanup for common PDF/document artifacts
+- Basic asset extraction for DOCX / PPTX / XLSX / HTML
+- `manifest.json`, `failed.json`, and large-run JSONL manifest streaming
+- Unicode-safe output filenames
+- PayPal funding link included through GitHub Sponsors/Funding
+
+## Installation
+
+```bash
+pip install markitdown-plus
+```
+
+For progress bars:
+
+```bash
+pip install "markitdown-plus[progress]"
+```
+
+For development tests and coverage:
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+## Quick Start
+
+Convert a folder:
+
+```bash
+markitdown-plus convert ./docs --output ./out
+```
+
+Convert recursively:
+
+```bash
+markitdown-plus convert ./docs --output ./out --recursive
+```
+
+Convert only specific file types:
+
+```bash
+markitdown-plus convert ./docs --output ./out --types pdf,docx,pptx,xlsx,html,csv
+```
+
+Clean Markdown and export RAG chunks:
+
+```bash
+markitdown-plus convert ./docs --output ./out --clean --rag
+```
+
+Use parallel workers:
+
+```bash
+markitdown-plus convert ./docs --output ./out --recursive --workers 4 --progress
+```
+
+Use auto worker count:
+
+```bash
+markitdown-plus convert ./docs --output ./out --workers 0
+```
+
+Extract assets when supported:
+
+```bash
+markitdown-plus convert ./docs --output ./out --extract-assets
+```
+
+Use a specific chunking strategy:
+
+```bash
+markitdown-plus convert ./docs --output ./out --rag --chunk-strategy semantic-lite
+```
+
+## Output Structure
+
+A normal batch run creates:
+
+```text
+out/
+  markdown/
+    report.md
+  metadata/
+    report.json
+  manifest.json
+```
+
+With RAG enabled:
+
+```text
+out/
+  markdown/
+    report.md
+  chunks/
+    report.jsonl
+  metadata/
+    report.json
+  manifest.json
+```
+
+With asset extraction enabled:
+
+```text
+out/
+  markdown/
+    report.md
+  assets/
+    report_img_001.png
+    report_img_002.jpg
+  metadata/
+    report.json
+  manifest.json
+```
+
+For very large jobs, MarkItDown Plus avoids huge `manifest.json` files by streaming records:
+
+```text
+out/
+  manifest.json
+  manifest-records.jsonl
+  failed.jsonl
+```
+
+## Chunk Strategies
+
+### `heading`
+
+Default. Preserves Markdown heading paths and is best for most structured documents.
+
+```bash
+markitdown-plus convert ./docs -o ./out --rag --chunk-strategy heading
+```
+
+### `fixed`
+
+Creates stable chunk sizes and ignores heading boundaries. Useful for embedding pipelines that prefer consistent lengths.
+
+```bash
+markitdown-plus convert ./docs -o ./out --rag --chunk-strategy fixed
+```
+
+### `semantic-lite`
+
+Dependency-free rule-based topical splitting. It starts new chunks at obvious semantic cues such as headings, summary, conclusion, recommendations, and other section-like paragraphs.
+
+```bash
+markitdown-plus convert ./docs -o ./out --rag --chunk-strategy semantic-lite
+```
+
+## Asset Extraction
+
+`--extract-assets` currently supports lightweight extraction for:
+
+- `.docx`
+- `.pptx`
+- `.xlsx`
+- `.html` / `.htm` local image references
+
+PDF image extraction is intentionally left for a later version because reliable PDF asset extraction requires heavier format-specific dependencies.
+
+When assets are extracted, MarkItDown Plus appends an `Extracted Assets` section to the generated Markdown and records asset metadata in the file-level metadata JSON.
+
+## Single File Commands
+
+Convert one file directly:
+
+```bash
+markitdown-plus single report.pdf -o report.md
+```
+
+Clean an existing Markdown file:
+
+```bash
+markitdown-plus clean dirty.md -o clean.md
+```
+
+Chunk an existing Markdown file:
+
+```bash
+markitdown-plus chunk clean.md -o chunks.jsonl --chunk-strategy fixed
+```
+
+## Development
+
+```bash
+git clone https://github.com/lamguo/markitdown-plus.git
+cd markitdown-plus
+pip install -e ".[dev]"
+pytest
+```
+
+The test configuration includes a coverage gate:
+
+```bash
+pytest --cov=markitdown_plus --cov-fail-under=85
+```
+
+Optional property and benchmark tests are included. They are skipped automatically if `hypothesis` or `pytest-benchmark` is not installed.
+
+## GitHub Topics
+
+Suggested topics for the repository:
+
+```text
+markitdown
+microsoft-markitdown
+markdown
+rag
+llm
+document-conversion
+pdf-to-markdown
+docx-to-markdown
+batch-conversion
+jsonl
+asset-extraction
+ai-tools
+```
+
+## Support This Project
+
+If MarkItDown Plus helps you save time or build better AI document pipelines, you can support development here:
+
+- Star this repository
+- Support via PayPal: https://www.paypal.me/lamguo
+
+Thank you for supporting open-source development.
+
+## License
+
+MIT License.

markitdown_plus-0.2.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+markitdown_plus/__about__.py,sha256=R1j3rv8sKRRZBWgf-R2yfl9mpn86EWL2nU-4qoNxWDg,173
+markitdown_plus/__init__.py,sha256=Es4TxE9wFkHDSZOQ7W72iPyjOMvZZkY6vYBGcukKRvs,373
+markitdown_plus/assets.py,sha256=f64lizi3BsJXJ6R8nOFz_zYn8MH-OJ-y-vi7dSKgPnM,5601
+markitdown_plus/batch.py,sha256=np85srYs9iqHJ4lQdZxvOqtn6doiF-zyEar8-Sfa8jA,13992
+markitdown_plus/chunker.py,sha256=mC-gNqNRecXMNu3wCt21nEhmKeU78Vn-GiXvaj5Uqww,14327
+markitdown_plus/cleaner.py,sha256=a_g1psLKZCuZyyC588kXTC0ilPqUgL3oulVT8076LNM,5185
+markitdown_plus/cli.py,sha256=nN78PwM2Fq0bhFN3EjQ0SaHH4mMgRhydGs8qvUgj8jY,8508
+markitdown_plus/converter.py,sha256=4i2Ya-uLGxX2PXo3Y32pI2e4s0yD54aFjN-41CSNCeQ,2127
+markitdown_plus/errors.py,sha256=tr__j5b6qMHmSr89oT1RfWHCg-PzM8mZSdMuld4CheA,346
+markitdown_plus/manifest.py,sha256=AXe9SC5Jg4bB9iXJGssz5BAdLJl1UOw5UDN7hMm2Q6M,5655
+markitdown_plus/metadata.py,sha256=pt1efOZJYyCjJrH8E7WlIjgrXBTfRxopGI1ckSxRs2A,2996
+markitdown_plus/utils.py,sha256=A64niqGBmnCEYI7FVAV0jlY8aX6qI-HPZ_sDQxWM0DI,1762
+markitdown_plus-0.2.0.dist-info/METADATA,sha256=Dv5pPOICuwzBi3ZYfX9PBi-xd_qXLvCpCJDNhZ1891w,7315
+markitdown_plus-0.2.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+markitdown_plus-0.2.0.dist-info/entry_points.txt,sha256=_N3MJXJsEr2q_QflyP0nB0DLWjN5EOg4xkJ0LxuZLTk,61
+markitdown_plus-0.2.0.dist-info/licenses/LICENSE,sha256=ApuTtJxtA5_UygDm5JxFYs-v-NJ_hjSep0JkJQG6tIk,1064
+markitdown_plus-0.2.0.dist-info/RECORD,,

markitdown_plus-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

markitdown_plus-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+markitdown-plus = markitdown_plus.cli:main

markitdown_plus-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lam Guo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.