agent-markdown-pdf 0.1.0__tar.gz

agent_markdown_pdf-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 [2026] [HKUDS CLI-Anything Team]
+
+   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.

agent_markdown_pdf-0.1.0/PKG-INFO

@@ -0,0 +1,331 @@
+Metadata-Version: 2.4
+Name: agent-markdown-pdf
+Version: 0.1.0
+Summary: Agent-friendly Markdown-to-PDF CLI with HTML preview and JSON diagnostics
+Author: rainp
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/ABClize/mdtopdf
+Project-URL: Repository, https://github.com/ABClize/mdtopdf
+Project-URL: Issues, https://github.com/ABClize/mdtopdf/issues
+Keywords: markdown,pdf,markdown-to-pdf,weasyprint,obsidian,cli,agent,automation,json
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+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 :: Documentation
+Classifier: Topic :: Printing
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0.0
+Requires-Dist: markdown-it-py>=3.0.0
+Requires-Dist: mdit-py-plugins>=0.4.0
+Requires-Dist: pygments>=2.0.0
+Requires-Dist: latex2mathml>=3.81.0
+Requires-Dist: matplotlib>=3.10.0
+Requires-Dist: mini-racer>=0.14.1
+Requires-Dist: weasyprint>=69.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: build>=1.2.0; extra == "dev"
+Requires-Dist: twine>=5.0.0; extra == "dev"
+Dynamic: license-file
+
+<h1 align="center">mdtopdf: Agent-friendly Markdown-to-PDF CLI</h1>
+
+<p align="center">
+  <strong>Agents write Markdown. People need PDFs. mdtopdf handles the step in between.</strong><br>
+  Local rendering, HTML preview, and JSON diagnostics give agents and scripts a stable document output path.
+</p>
+
+<p align="center">
+  <a href="https://github.com/ABClize/mdtopdf/blob/main/README_CN.md">中文文档</a>
+</p>
+
+<p align="center">
+  <a href="#quick-start"><img src="https://img.shields.io/badge/Quick_Start-2_min-blue?style=for-the-badge" alt="Quick Start"></a>
+  <a href="#agent-workflow"><img src="https://img.shields.io/badge/Agent_Friendly-JSON_Output-green?style=for-the-badge" alt="Agent Friendly"></a>
+  <a href="#visual-output"><img src="https://img.shields.io/badge/PDF_Pages-Rendered-purple?style=for-the-badge" alt="Rendered PDF pages"></a>
+  <a href="https://pypi.org/project/agent-markdown-pdf/"><img src="https://img.shields.io/pypi/v/agent-markdown-pdf.svg?style=for-the-badge" alt="PyPI version"></a>
+  <a href="https://github.com/ABClize/mdtopdf/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-yellow?style=for-the-badge" alt="License"></a>
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/pypi/pyversions/agent-markdown-pdf.svg" alt="Python versions">
+  <img src="https://img.shields.io/badge/output-JSON_%2B_Human-blueviolet" alt="JSON and human output">
+  <img src="https://img.shields.io/badge/backend-WeasyPrint-2f855a" alt="WeasyPrint backend">
+  <img src="https://img.shields.io/badge/status-alpha-f59e0b" alt="Alpha status">
+</p>
+
+**One command** gives agents a controlled Markdown-to-PDF path.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ABClize/mdtopdf/main/assets/readme/cover.png" alt="mdtopdf cover" width="900">
+</p>
+
+---
+
+## Why it works for agents
+
+Agents are good at writing Markdown. The problem is the handoff: PDFs exported
+through ad hoc paths rarely share the same style. `mdtopdf` gives the user a
+command-line interface where the style can be defined up front.
+
+- **Agent-friendly** - `mdtopdf --help` is an interface description an agent can read.
+- **JSON when it matters** - conversion, HTML preview, environment checks, and theme listing can return machine-readable output.
+- **Local files in, local files out** - no browser dependency, no upload step, no remote rendering service.
+- **More than plain Markdown** - Obsidian links, highlights, frontmatter, comments, and callouts are rendered.
+
+## Quick start
+
+Install from PyPI:
+
+```shell
+python -m pip install agent-markdown-pdf
+```
+
+The PyPI distribution is `agent-markdown-pdf`; it installs the `mdtopdf` command.
+
+Check the machine:
+
+```shell
+mdtopdf doctor --json
+```
+
+Convert a file:
+
+```shell
+mdtopdf convert report.md -o report.pdf --overwrite
+```
+
+Try the bundled visual test document:
+
+```shell
+git clone https://github.com/ABClize/mdtopdf.git
+cd mdtopdf
+python -m pip install -e .[dev]
+mdtopdf html examples/visual-test-en.md -o visual-test-en.html --overwrite
+mdtopdf convert examples/visual-test-en.md -o visual-test-en.pdf --overwrite --json
+```
+
+The same visual test is also available in Chinese at
+`examples/visual-test-cn.md`.
+
+## Agent workflow
+
+```shell
+mdtopdf doctor --json
+mdtopdf convert report.md -o report.pdf --overwrite --json
+```
+
+Use HTML preview when layout needs a quick look:
+
+```shell
+mdtopdf html report.md -o report.html --overwrite --json
+mdtopdf convert report.md -o report.pdf --overwrite --json
+```
+
+`convert --json` returns the input path, output path, file size, theme, and
+render method. If conversion fails in JSON mode, the error is structured enough
+for an agent to show the command, explain the likely cause, and retry after a
+fix.
+
+## Visual output
+
+The gallery below is rendered from the final PDF produced by
+`examples/visual-test-en.md`. It shows the actual pages an agent can hand back
+to a user: headings, callouts, tables, code, math, images, Mermaid, and
+pagination.
+
+| Page 1 | Page 2 |
+| --- | --- |
+| <img src="https://raw.githubusercontent.com/ABClize/mdtopdf/main/assets/readme/pdf-page-en-1.png" alt="PDF page 1" width="420"> | <img src="https://raw.githubusercontent.com/ABClize/mdtopdf/main/assets/readme/pdf-page-en-2.png" alt="PDF page 2" width="420"> |
+| Page 3 | Page 4 |
+| <img src="https://raw.githubusercontent.com/ABClize/mdtopdf/main/assets/readme/pdf-page-en-3.png" alt="PDF page 3" width="420"> | <img src="https://raw.githubusercontent.com/ABClize/mdtopdf/main/assets/readme/pdf-page-en-4.png" alt="PDF page 4" width="420"> |
+| Page 5 | Page 6 |
+| <img src="https://raw.githubusercontent.com/ABClize/mdtopdf/main/assets/readme/pdf-page-en-5.png" alt="PDF page 5" width="420"> | <img src="https://raw.githubusercontent.com/ABClize/mdtopdf/main/assets/readme/pdf-page-en-6.png" alt="PDF page 6" width="420"> |
+
+## How it works
+
+```text
+Markdown -> markdown-it-py HTML -> theme/custom CSS -> WeasyPrint PDF
+```
+
+Mermaid rendering is optional. If a local `mmdc` command exists, Mermaid blocks
+render to SVG. If it is missing, conversion still succeeds and Mermaid blocks
+remain visible as highlighted code.
+
+## Features
+
+| Feature | Notes |
+| --- | --- |
+| JSON output | `--json` is available for conversion, HTML preview, doctor, and theme listing. |
+| Environment checks | `doctor --json` checks Python imports, native WeasyPrint libraries, Windows DLL paths, and Mermaid availability. |
+| Local rendering | Markdown, CSS, math, Mermaid SVG generation, and PDF export stay on the machine. |
+| HTML preview | Generate standalone HTML before PDF export for fast visual inspection. |
+| Obsidian compatibility | Wikilinks, aliases, frontmatter hiding, comments, highlights, and typed callouts. |
+| Document Markdown | Tables, task lists, footnotes, heading anchors, fenced code, and Pygments highlighting. |
+| KaTeX math | Inline and block TeX render with bundled KaTeX assets, without a CDN. |
+| Safe HTML default | Common inline document tags are allowed; unsafe raw HTML stays escaped unless opted in. |
+| Python API | Convert Markdown strings or files from your own code. |
+
+## Commands
+
+Render a PDF:
+
+```shell
+mdtopdf convert report.md -o report.pdf
+mdtopdf convert report.md -o report.pdf --overwrite
+```
+
+Preview HTML:
+
+```shell
+mdtopdf html report.md -o report.html --overwrite
+```
+
+Set document metadata and page chrome:
+
+```shell
+mdtopdf convert report.md -o report.pdf --title "Report"
+mdtopdf convert report.md -o report.pdf --header "Report" --footer "Draft"
+mdtopdf convert report.md -o report.pdf --no-header --no-footer
+```
+
+Use extra CSS or resource lookup paths:
+
+```shell
+mdtopdf convert report.md -o report.pdf --css print.css
+mdtopdf convert report.md -o report.pdf --base-url assets
+mdtopdf convert report.md -o report.pdf --resource-dir attachments
+```
+
+Return JSON:
+
+```shell
+mdtopdf --json convert report.md -o report.pdf --overwrite
+mdtopdf doctor --json
+mdtopdf themes list --json
+```
+
+Allow raw HTML only for trusted local Markdown:
+
+```shell
+mdtopdf convert trusted.md -o trusted.pdf --unsafe-html
+```
+
+## Python API
+
+```python
+from mdtopdf import (
+    markdown_file_to_html,
+    markdown_file_to_pdf,
+    markdown_to_html,
+    markdown_to_pdf,
+)
+
+rendered = markdown_to_html("# Report\n\n==highlight==")
+print(rendered.html)
+
+markdown_to_pdf("# Report\n\nBody", "report.pdf", title="Report", overwrite=True)
+markdown_file_to_html("report.md", output_path="report.html", overwrite=True)
+markdown_file_to_pdf("report.md", output_path="report.pdf", overwrite=True)
+```
+
+## Markdown support
+
+`mdtopdf` supports:
+
+- CommonMark
+- Tables
+- Strikethrough
+- Task lists
+- Footnotes
+- Heading anchors
+- Fenced code blocks with Pygments highlighting
+- Obsidian-style `==highlight==` marks
+- Obsidian-style `[[target|alias]]` wikilinks
+- Obsidian-style `%%comment%%` comments outside code
+- Obsidian/YAML frontmatter hiding at the start of the file
+- Obsidian-style callouts such as `> [!note] Title`
+- Safe inline HTML tags such as `<br>`, `<kbd>`, `<mark>`, `<sup>`, and `<sub>`
+- TeX math through `$inline$`, `$$block$$`, and common `amsmath` environments
+- Mermaid diagrams through local `mmdc`, when installed
+
+Raw HTML is disabled by default except for the safe subset above. For trusted
+local Markdown, pass `--unsafe-html`.
+
+## Mermaid diagrams
+
+Install a persistent local renderer:
+
+```shell
+npm install -g @mermaid-js/mermaid-cli
+```
+
+`mdtopdf` does not call Mermaid.ink and does not download Mermaid CLI through
+`npx` during conversion. Run `mdtopdf doctor --json` to check whether Mermaid
+rendering is available.
+
+## Platform notes
+
+`mdtopdf` requires Python 3.10+ and installs its Python dependencies from PyPI:
+`click`, `markdown-it-py`, `mdit-py-plugins`, `pygments`, `latex2mathml`,
+`matplotlib`, `mini-racer`, and `weasyprint`.
+
+WeasyPrint also needs native libraries such as Pango, GLib, and Cairo. Linux
+and macOS package managers usually provide them through system packages.
+
+On Windows, install the native libraries separately. A common MSYS2 setup is:
+
+```powershell
+winget install MSYS2.MSYS2
+```
+
+Then install Pango from an MSYS2 MINGW64 shell:
+
+```shell
+pacman -S mingw-w64-x86_64-pango
+```
+
+Finally, point WeasyPrint at the DLL directory from PowerShell. Adjust the path
+if MSYS2 is installed somewhere else:
+
+```powershell
+setx WEASYPRINT_DLL_DIRECTORIES "C:\msys64\mingw64\bin"
+```
+
+Run this after installation:
+
+```shell
+mdtopdf doctor --json
+```
+
+## Development
+
+```shell
+git clone https://github.com/ABClize/mdtopdf.git
+cd mdtopdf
+python -m pip install -e .[dev]
+python -m pytest tests/ -q
+```
+
+Build and check the package:
+
+```shell
+python -m build
+python -m twine check dist/*
+```
+
+## License
+
+Apache-2.0. Bundled KaTeX assets are distributed under the MIT license; see
+`mdtopdf/vendor/katex/LICENSE`.