pptx2markdown 0.1.0__tar.gz

pptx2markdown-0.1.0/.gitignore

@@ -0,0 +1,32 @@
+# macOS
+.DS_Store
+
+# environment
+.env
+.python-version
+.venv/
+
+# Python
+__pycache__/
+*.py[cod]
+dist/
+build/
+*.egg-info/
+archives/
+
+# runtime inputs / outputs (never commit)
+output/
+.pptx2markdown/
+.cache/
+pptx_samples/
+/test
+*.pptx
+*.ppt
+*.pdf
+!tests/fixtures/*.pptx
+!tests/fixtures/golden/
+!tests/fixtures/golden/*.pptx
+tests/fixtures/golden/~$*.pptx
+
+# Claude Code local settings
+.claude/settings.local.json

pptx2markdown-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pptx2markdown-0.1.0/NOTICE

@@ -0,0 +1,2 @@
+PPTX2Markdown
+Copyright 2026 HANKOOK TIRE & TECHNOLOGY CO., LTD.

pptx2markdown-0.1.0/PKG-INFO

@@ -0,0 +1,265 @@
+Metadata-Version: 2.4
+Name: pptx2markdown
+Version: 0.1.0
+Summary: Convert PPTX/PPT presentations to clean, RAG-ready Markdown (text, tables, charts, SmartArt, formulas, images)
+Project-URL: Homepage, https://github.com/PPTX2Markdown/PPTX2Markdown
+Project-URL: Repository, https://github.com/PPTX2Markdown/PPTX2Markdown
+Project-URL: Issues, https://github.com/PPTX2Markdown/PPTX2Markdown/issues
+Author-email: MoonYoung02 <happy518596@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: converter,document-parsing,markdown,powerpoint,pptx,rag
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Office/Business :: Office Suites
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.12
+Requires-Dist: chart2md>=0.1.0
+Requires-Dist: olefile>=0.47
+Requires-Dist: omml2latex>=0.1.0
+Requires-Dist: pydantic<3,>=2.10.0
+Requires-Dist: pywin32>=306; platform_system == 'Windows'
+Requires-Dist: smartart2md>=0.1.1
+Description-Content-Type: text/markdown
+
+# pptx2markdown
+
+[![Quality](https://github.com/PPTX2Markdown/PPTX2Markdown/actions/workflows/quality.yml/badge.svg)](https://github.com/PPTX2Markdown/PPTX2Markdown/actions/workflows/quality.yml)
+[![PyPI](https://img.shields.io/pypi/v/pptx2markdown)](https://pypi.org/project/pptx2markdown/)
+[![Python](https://img.shields.io/pypi/pyversions/pptx2markdown)](https://pypi.org/project/pptx2markdown/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/PPTX2Markdown/PPTX2Markdown/blob/main/LICENSE)
+
+English | [한국어](https://github.com/PPTX2Markdown/PPTX2Markdown/blob/main/README.ko.md)
+
+`pptx2markdown` converts PowerPoint presentations into deterministic Markdown or
+JSON for search, RAG, and document-processing pipelines. It parses native OOXML
+structure and shape geometry directly: no OCR, vision model, API key, or cloud
+service is used.
+
+## Why pptx2markdown?
+
+- **One static pipeline** — `.pptx` content is parsed from XML, relationships,
+  and embedded package parts.
+- **Deterministic reading order** — recursive geometric XY-cut orders native
+  shapes without semantic or model-based overrides.
+- **One output contract** — Markdown and JSON are rendered from the same
+  versioned `PresentationDocument`.
+- **Rich native content** — text, headings, lists, tables, charts, SmartArt,
+  formulas, images, speaker notes, and embedded attachments are retained.
+- **Reviewable regressions** — real PPTX fixtures are checked against
+  byte-for-byte JSON and Markdown golden outputs on Linux, macOS, and Windows.
+
+## Supported content
+
+| Content | Behavior |
+| --- | --- |
+| Text and headings | Preserves text and infers headings from native placeholder and style evidence |
+| Lists | Preserves ordered and unordered list structure |
+| Tables | Renders native PowerPoint tables as Markdown tables |
+| Charts | Converts native charts through [chart2md](https://pypi.org/project/chart2md/) |
+| SmartArt | Converts diagram content through [smartart2md](https://pypi.org/project/smartart2md/) |
+| Formulas | Converts OMML equations to LaTeX through [omml2latex](https://pypi.org/project/omml2latex/) |
+| Images | Copies embedded image parts to deterministic local asset paths |
+| Speaker notes | Keeps notes separate from visible slide content |
+| Attachments | Preserves recoverable PDF, audio, video, Office, ZIP, 3D, and OLE payloads as linked files |
+
+The parser does **not** OCR text inside images, transcribe audio or video,
+reconstruct animations, interpret connector semantics, or reproduce slides
+pixel-for-pixel. PowerPoint review comments are intentionally excluded.
+
+## Requirements
+
+- Python 3.12 or newer
+- `.pptx`: no Microsoft Office or LibreOffice required
+- legacy `.ppt`: Microsoft PowerPoint on Windows or LibreOffice
+- EMF/WMF conversion: LibreOffice when conversion is needed
+
+## Installation
+
+### Let an AI agent install it
+
+A local coding agent can inspect the environment, choose an isolated install,
+optionally configure LibreOffice, and verify the CLI. Give it one of these
+prompts and review every permission request.
+
+Most agents:
+
+```text
+Read https://raw.githubusercontent.com/PPTX2Markdown/PPTX2Markdown/main/.github/agent-install.md and install pptx2markdown for this machine. You may run the commands needed for installation after explaining them. Ask me before any administrator, sudo, password, system package-manager, shell-profile, PATH, or LibreOffice change.
+```
+
+Codex interactive planning:
+
+```text
+/plan
+Read https://raw.githubusercontent.com/PPTX2Markdown/PPTX2Markdown/main/.github/agent-install.md and install pptx2markdown for this machine. You may run the commands needed for installation after explaining them. Ask me before any administrator, sudo, password, system package-manager, shell-profile, PATH, or LibreOffice change.
+```
+
+See the complete [agent installation procedure](https://github.com/PPTX2Markdown/PPTX2Markdown/blob/main/.github/agent-install.md).
+
+### Manual installation
+
+For an isolated CLI, use `uv`:
+
+```bash
+uv tool install pptx2markdown
+```
+
+Alternatively, use `pipx` or an active virtual environment:
+
+```bash
+pipx install pptx2markdown
+# or, inside an active virtual environment
+python -m pip install pptx2markdown
+```
+
+LibreOffice is optional:
+
+```bash
+# macOS
+brew install --cask libreoffice
+
+# Ubuntu / Debian
+sudo apt-get install libreoffice libreoffice-impress
+```
+
+On Windows, `.ppt` conversion uses PowerPoint COM automation when available and
+otherwise tries LibreOffice. `SOFFICE_PATH` may point to a specific LibreOffice
+executable.
+
+## Quick start
+
+```bash
+# One file -> ./output/deck/deck.md
+pptx2markdown deck.pptx
+
+# Every .pptx/.ppt in the current directory
+pptx2markdown
+
+# Multiple files and a custom output root
+pptx2markdown first.pptx second.pptx -o converted/
+
+# Canonical JSON instead of Markdown
+pptx2markdown deck.pptx --output-format json
+```
+
+Temporary Office lock files matching `~$*.pptx` are silently skipped during
+batch conversion.
+
+From Python:
+
+```python
+import pptx2markdown
+
+exit_code = pptx2markdown.convert(
+    "deck.pptx",
+    output_dir="converted",
+    output_format="markdown",
+)
+if exit_code != 0:
+    raise RuntimeError("conversion failed")
+```
+
+Example Markdown:
+
+```markdown
+[Page_1]
+
+# Quarterly results
+
+- Revenue increased 18%
+- Operating margin reached 24%
+
+| Region | Revenue |
+| --- | ---: |
+| APAC | $12.4M |
+```
+
+## CLI options
+
+| Flag | Default | Description |
+| --- | --- | --- |
+| `-o, --output-dir` | `./output` | Final Markdown/JSON and copied assets |
+| `--work-dir` | `./.pptx2markdown` | Extracted packages, analysis files, and caches |
+| `--output-format` | `markdown` | `markdown` or `json` |
+| `--headings` | `auto` | `auto` or placeholder-only `strict` heading detection |
+| `--placeholder-inheritance` | `style` | `none`, `geometry`, or `style` inheritance |
+| `--inherited-shapes` | `visible` | `none`, `visible`, or `all` layout/master shapes |
+| `--ppt-converter` | `auto` | `auto`, `powerpoint`, or `libreoffice` for `.ppt` |
+| `--verbose` | off | Debug logging |
+
+Run `pptx2markdown --help` for the authoritative CLI reference.
+
+## Output layout
+
+```text
+output/
+├── convert_manifest.json
+└── <deck-name>/
+    ├── <deck-name>.md       # or <deck-name>.json
+    ├── media/
+    └── attachments/
+
+.pptx2markdown/
+├── target_slides/
+├── structure_analysis/
+├── table_pipeline/
+└── .cache/
+```
+
+`convert_manifest.json` records file and slide status, warnings, failures, and
+block statistics. JSON output conforms to the packaged
+`PresentationDocument 1.0` schema. Source paths are reduced to a basename and
+generated links use portable `/` separators.
+
+## Reading order and determinism
+
+Reading order always uses recursive XY-cut over native shape bounding boxes. It
+splits geometric regions into columns and rows, then uses top-left order when no
+further cut is possible. Original XML order is only a deterministic tie-breaker
+or a fallback for objects without usable geometry.
+
+For identical input and options, JSON and Markdown outputs are expected to be
+byte-for-byte stable across supported operating systems. The repository keeps
+17 reviewable PPTX fixtures with both expected formats and emitted-asset hashes.
+
+## Security model
+
+Normal `.pptx` conversion is local and makes no network or model calls. OOXML
+extraction rejects path traversal, links, encrypted entries, relationship
+escapes, and packages that exceed configured archive limits. Extracted
+attachments are data from the input presentation; inspect them before opening.
+Legacy `.ppt` and some vector-image conversions invoke the selected external
+Office converter.
+
+## Documentation
+
+- [Output schema](https://github.com/PPTX2Markdown/PPTX2Markdown/blob/main/docs/output_schema.md)
+- [Main converter](https://github.com/PPTX2Markdown/PPTX2Markdown/blob/main/docs/main_converter.md)
+- [Structure analyzer](https://github.com/PPTX2Markdown/PPTX2Markdown/blob/main/docs/structure_analyzer.md)
+- [Golden PPTX suite](https://github.com/PPTX2Markdown/PPTX2Markdown/blob/main/tests/fixtures/golden/README.md)
+
+## Development
+
+```bash
+python -m pip install -e .
+python -m unittest discover -v
+python scripts/update_goldens.py --check
+ruff check src tests scripts
+ruff format --check src tests scripts
+```
+
+When parser behavior changes intentionally, review the generated Markdown and
+JSON diffs before accepting new golden snapshots.
+
+## License
+
+The project is distributed under the [Apache License 2.0](https://github.com/PPTX2Markdown/PPTX2Markdown/blob/main/LICENSE).
+Third-party golden fixture attribution is recorded in
+[`THIRD_PARTY_NOTICES.md`](https://github.com/PPTX2Markdown/PPTX2Markdown/blob/main/tests/fixtures/golden/THIRD_PARTY_NOTICES.md).