repo2word 0.0.1

Convert a Python package directory into a single syntax-highlighted Word (.docx) document.

repo2word

Convert a Python package directory (the folder that directly contains the root __init__.py) into a single Word (.docx) file: each *.py file is a section with a path heading, line numbers, and syntax-highlighted code.

Requirements

• Python 3.14+
• Pandoc installed and on your PATH (or pass pandoc_path= to the API)

On macOS: brew install pandoc. On Ubuntu/Debian: sudo apt-get install pandoc.

Installation

pip install repo2word

(or uv add repo2word). Pandoc is an external dependency and is not installed by pip — see Requirements.

Usage

from pathlib import Path
from repo2word import repo2word

repo2word(Path("path/to/mypackage"), Path("out.docx"))

path/to/mypackage must be the package root (it must contain __init__.py). The parent directory of the output .docx must already exist unless you pass mkdir_parents=True.

Development

uv sync --all-groups
uv run ruff check . && uv run ruff format .
uv run mypy .
uv run pytest

License

Apache-2.0