pyhwp2md

Convert HWP (Hangul Word Processor) and HWPX files to Markdown format.

Features

• 🔄 Convert both HWP (binary) and HWPX (XML) files
• 📝 Extracts text, paragraphs, and tables
• 📊 Converts tables to Markdown pipe format
• 🎯 Simple CLI interface
• 🐍 Python 3.10+ support

Quick Start

Run without installation (uvx)

# Convert directly without installing
uvx pyhwp2md document.hwp

# Save to file
uvx pyhwp2md document.hwp -s

# Specify output path
uvx pyhwp2md document.hwpx -o output.md

Installation

Using pip

pip install pyhwp2md

Using uv

uv pip install pyhwp2md

From source

git clone https://github.com/pitzcarraldo/pyhwp2md.git
cd pyhwp2md
pip install -e .

Usage

Command Line

# Output to stdout (default)
pyhwp2md document.hwp

# Save to .md file in same directory
pyhwp2md document.hwp -s
pyhwp2md document.hwpx --save

# Specify output path
pyhwp2md document.hwp -o output.md

Python API

from pyhwp2md import convert

# Convert and get markdown string
markdown = convert("document.hwp")
print(markdown)

# Convert and save to file
markdown = convert("document.hwpx", output_path="output.md")

Supported Formats

Supported Elements

• ✅ Paragraphs
• ✅ Headings (H1-H6)
• ✅ Tables
• ✅ Lists (bulleted/numbered)
• ✅ Line breaks
• ⚠️ Images (coming soon)
• ⚠️ Links (partial support)

Development

Setup

# Clone repository
git clone https://github.com/pitzcarraldo/pyhwp2md.git
cd pyhwp2md

# Install with dev dependencies
pip install -e .[dev]

Running Tests

# Run tests
pytest

# Run tests with coverage
pytest --cov=pyhwp2md

# Run linter
ruff check src/ tests/

# Run type checker
mypy src/

Dependencies

• pyhwp - HWP binary file parser
• python-hwpx - HWPX XML file parser

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Acknowledgments

• pyhwp by mete0r
• python-hwpx by airmang

Links

• PyPI Package
• GitHub Repository
• Issue Tracker