# 📄 WOT-PDF - Advanced PDF Generation
[](https://badge.fury.io/py/wot-pdf)
[](https://pypi.org/project/wot-pdf/)
[](https://opensource.org/licenses/MIT)
**Professional PDF generation with dual-engine architecture (Typst + ReportLab fallback)**
## ✨ Features
🎯 **Dual PDF Engines**
- **Primary**: System Typst CLI (superior typography)
- **Fallback**: ReportLab (100% reliability)
📚 **Book Generation**
- Convert markdown directories to professional books
- 5 professional templates (Academic, Technical, Corporate, Educational, Minimal)
- Automatic table of contents
- Cross-reference management
🎨 **Professional Templates**
- Academic papers with citations
- Technical documentation
- Corporate reports
- Educational materials
- Clean minimal design
⚡ **Advanced Features**
- Batch processing
- Custom styling
- Rich CLI interface
- GUI frontend (optional)
- Professional typography
## 🚀 Quick Start
### Installation
```bash
pip install wot-pdf
```
### Basic Usage
```bash
# Generate single PDF
wot-pdf --input document.md --output result.pdf
# Create professional book
wot-pdf book ./docs/ book.pdf --template technical
# List available templates
wot-pdf templates
# GUI mode (if installed)
wot-pdf-gui
```
### Python API
```python
from wot_pdf import PDFGenerator, generate_book
# Simple generation
generator = PDFGenerator()
result = generator.generate("document.md", "output.pdf")
# Book generation
result = generate_book(
input_dir="./docs/",
output_file="book.pdf",
template="technical"
)
```
## 📖 Templates
| Template | Best For | Features |
|----------|----------|----------|
| `academic` | Research papers | Citations, bibliography, equations |
| `technical` | Documentation | Code blocks, diagrams, TOC |
| `corporate` | Business reports | Professional styling, charts |
| `educational` | Learning materials | Exercises, callouts, examples |
| `minimal` | Simple documents | Clean, fast generation |
## 🛠️ Installation Options
### Minimal Installation
```bash
pip install wot-pdf
```
### With Development Tools
```bash
pip install wot-pdf[dev]
```
### With GUI Support
```bash
pip install wot-pdf[gui]
```
### With Documentation Tools
```bash
pip install wot-pdf[docs]
```
## 📋 Requirements
- **Python**: 3.8+
- **System Typst CLI** (recommended): [Install from typst.app](https://typst.app)
- **ReportLab**: Automatically installed (fallback engine)
## 🎯 Use Cases
✅ **Technical Documentation**
- API references
- User manuals
- Installation guides
✅ **Academic Publishing**
- Research papers
- Thesis documents
- Conference proceedings
✅ **Business Reports**
- Quarterly reports
- Project documentation
- Presentation materials
✅ **Educational Content**
- Course materials
- Tutorials
- Reference guides
## 📊 Comparison
| Feature | wot-pdf | pandoc | WeasyPrint |
|---------|---------|--------|------------|
| Typst Integration | ✅ | ❌ | ❌ |
| Fallback Engine | ✅ | ❌ | ❌ |
| Professional Templates | ✅ | Limited | Limited |
| Book Generation | ✅ | Manual | Manual |
| GUI Interface | ✅ | ❌ | ❌ |
| CLI Interface | ✅ | ✅ | Limited |
## 🔧 Configuration
Create `.wot-pdf.yaml` in your project:
```yaml
default_template: technical
output_directory: ./generated/
typst:
enabled: true
timeout: 60
reportlab:
compression: true
embed_fonts: true
```
## 🤝 Contributing
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
## 📜 License
MIT License - see [LICENSE](LICENSE) file for details.
## 🔗 Links
- 📚 [Documentation](https://wot-pdf.readthedocs.io)
- 🐛 [Issues](https://github.com/work-organizing-tools/wot-pdf/issues)
- 💬 [Discussions](https://github.com/work-organizing-tools/wot-pdf/discussions)
- 🌟 [Source Code](https://github.com/work-organizing-tools/wot-pdf)
---
**Made with ❤️ by the Work Organizing Tools team**
Raw data
{
"_id": null,
"home_page": null,
"name": "wot-pdf",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "pdf, typst, reportlab, markdown, book, generation, professional",
"author": null,
"author_email": "Work Organizing Tools <info@wot-tools.com>",
"download_url": "https://files.pythonhosted.org/packages/d3/8f/462f5f875fad7718b9e20686abbe5143a5761c5be75daf15ecfcb710dde7/wot_pdf-1.0.2.tar.gz",
"platform": null,
"description": "# \ud83d\udcc4 WOT-PDF - Advanced PDF Generation\r\n\r\n[](https://badge.fury.io/py/wot-pdf)\r\n[](https://pypi.org/project/wot-pdf/)\r\n[](https://opensource.org/licenses/MIT)\r\n\r\n**Professional PDF generation with dual-engine architecture (Typst + ReportLab fallback)**\r\n\r\n## \u2728 Features\r\n\r\n\ud83c\udfaf **Dual PDF Engines**\r\n- **Primary**: System Typst CLI (superior typography)\r\n- **Fallback**: ReportLab (100% reliability)\r\n\r\n\ud83d\udcda **Book Generation**\r\n- Convert markdown directories to professional books\r\n- 5 professional templates (Academic, Technical, Corporate, Educational, Minimal)\r\n- Automatic table of contents\r\n- Cross-reference management\r\n\r\n\ud83c\udfa8 **Professional Templates**\r\n- Academic papers with citations\r\n- Technical documentation\r\n- Corporate reports \r\n- Educational materials\r\n- Clean minimal design\r\n\r\n\u26a1 **Advanced Features**\r\n- Batch processing\r\n- Custom styling\r\n- Rich CLI interface\r\n- GUI frontend (optional)\r\n- Professional typography\r\n\r\n## \ud83d\ude80 Quick Start\r\n\r\n### Installation\r\n\r\n```bash\r\npip install wot-pdf\r\n```\r\n\r\n### Basic Usage\r\n\r\n```bash\r\n# Generate single PDF\r\nwot-pdf --input document.md --output result.pdf\r\n\r\n# Create professional book\r\nwot-pdf book ./docs/ book.pdf --template technical\r\n\r\n# List available templates\r\nwot-pdf templates\r\n\r\n# GUI mode (if installed)\r\nwot-pdf-gui\r\n```\r\n\r\n### Python API\r\n\r\n```python\r\nfrom wot_pdf import PDFGenerator, generate_book\r\n\r\n# Simple generation\r\ngenerator = PDFGenerator()\r\nresult = generator.generate(\"document.md\", \"output.pdf\")\r\n\r\n# Book generation\r\nresult = generate_book(\r\n input_dir=\"./docs/\",\r\n output_file=\"book.pdf\", \r\n template=\"technical\"\r\n)\r\n```\r\n\r\n## \ud83d\udcd6 Templates\r\n\r\n| Template | Best For | Features |\r\n|----------|----------|----------|\r\n| `academic` | Research papers | Citations, bibliography, equations |\r\n| `technical` | Documentation | Code blocks, diagrams, TOC |\r\n| `corporate` | Business reports | Professional styling, charts |\r\n| `educational` | Learning materials | Exercises, callouts, examples |\r\n| `minimal` | Simple documents | Clean, fast generation |\r\n\r\n## \ud83d\udee0\ufe0f Installation Options\r\n\r\n### Minimal Installation\r\n```bash\r\npip install wot-pdf\r\n```\r\n\r\n### With Development Tools\r\n```bash\r\npip install wot-pdf[dev]\r\n```\r\n\r\n### With GUI Support\r\n```bash\r\npip install wot-pdf[gui]\r\n```\r\n\r\n### With Documentation Tools\r\n```bash\r\npip install wot-pdf[docs]\r\n```\r\n\r\n## \ud83d\udccb Requirements\r\n\r\n- **Python**: 3.8+\r\n- **System Typst CLI** (recommended): [Install from typst.app](https://typst.app)\r\n- **ReportLab**: Automatically installed (fallback engine)\r\n\r\n## \ud83c\udfaf Use Cases\r\n\r\n\u2705 **Technical Documentation**\r\n- API references\r\n- User manuals \r\n- Installation guides\r\n\r\n\u2705 **Academic Publishing**\r\n- Research papers\r\n- Thesis documents\r\n- Conference proceedings\r\n\r\n\u2705 **Business Reports**\r\n- Quarterly reports\r\n- Project documentation\r\n- Presentation materials\r\n\r\n\u2705 **Educational Content**\r\n- Course materials\r\n- Tutorials\r\n- Reference guides\r\n\r\n## \ud83d\udcca Comparison\r\n\r\n| Feature | wot-pdf | pandoc | WeasyPrint |\r\n|---------|---------|--------|------------|\r\n| Typst Integration | \u2705 | \u274c | \u274c |\r\n| Fallback Engine | \u2705 | \u274c | \u274c |\r\n| Professional Templates | \u2705 | Limited | Limited |\r\n| Book Generation | \u2705 | Manual | Manual |\r\n| GUI Interface | \u2705 | \u274c | \u274c |\r\n| CLI Interface | \u2705 | \u2705 | Limited |\r\n\r\n## \ud83d\udd27 Configuration\r\n\r\nCreate `.wot-pdf.yaml` in your project:\r\n\r\n```yaml\r\ndefault_template: technical\r\noutput_directory: ./generated/\r\ntypst:\r\n enabled: true\r\n timeout: 60\r\nreportlab:\r\n compression: true\r\n embed_fonts: true\r\n```\r\n\r\n## \ud83e\udd1d Contributing\r\n\r\nWe welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.\r\n\r\n## \ud83d\udcdc License\r\n\r\nMIT License - see [LICENSE](LICENSE) file for details.\r\n\r\n## \ud83d\udd17 Links\r\n\r\n- \ud83d\udcda [Documentation](https://wot-pdf.readthedocs.io)\r\n- \ud83d\udc1b [Issues](https://github.com/work-organizing-tools/wot-pdf/issues)\r\n- \ud83d\udcac [Discussions](https://github.com/work-organizing-tools/wot-pdf/discussions)\r\n- \ud83c\udf1f [Source Code](https://github.com/work-organizing-tools/wot-pdf)\r\n\r\n---\r\n\r\n**Made with \u2764\ufe0f by the Work Organizing Tools team**\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Advanced PDF generation with Typst and ReportLab engines",
"version": "1.0.2",
"project_urls": {
"Documentation": "https://wot-pdf.readthedocs.io",
"Homepage": "https://github.com/work-organizing-tools/wot-pdf",
"Issues": "https://github.com/work-organizing-tools/wot-pdf/issues",
"Repository": "https://github.com/work-organizing-tools/wot-pdf.git"
},
"split_keywords": [
"pdf",
" typst",
" reportlab",
" markdown",
" book",
" generation",
" professional"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ac8b84163966d057e8bf5001e28dee52737c8b61fb46cea0812d96f340c63c19",
"md5": "47bddcc8d6b324c28964b333a0d08a97",
"sha256": "130f4ebc34309eb600c2989f35eee436d1c3666983b8f480ddddd47635327ada"
},
"downloads": -1,
"filename": "wot_pdf-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "47bddcc8d6b324c28964b333a0d08a97",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 30748,
"upload_time": "2025-08-14T23:06:06",
"upload_time_iso_8601": "2025-08-14T23:06:06.536166Z",
"url": "https://files.pythonhosted.org/packages/ac/8b/84163966d057e8bf5001e28dee52737c8b61fb46cea0812d96f340c63c19/wot_pdf-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d38f462f5f875fad7718b9e20686abbe5143a5761c5be75daf15ecfcb710dde7",
"md5": "de2e5e271b95a6b4e9dad88b406fd152",
"sha256": "46fa4f01fa2974ab1ec0860fd38b9b05ffe1d370c89af30733e6a11200155bc8"
},
"downloads": -1,
"filename": "wot_pdf-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "de2e5e271b95a6b4e9dad88b406fd152",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 25883,
"upload_time": "2025-08-14T23:06:07",
"upload_time_iso_8601": "2025-08-14T23:06:07.876414Z",
"url": "https://files.pythonhosted.org/packages/d3/8f/462f5f875fad7718b9e20686abbe5143a5761c5be75daf15ecfcb710dde7/wot_pdf-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-14 23:06:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "work-organizing-tools",
"github_project": "wot-pdf",
"github_not_found": true,
"lcname": "wot-pdf"
}
JSON
