Metadata-Version: 2.4
Name: msdoc2docx
Version: 0.36.0
Summary: A specification-driven, pure-Python Word binary .doc to .docx converter
Author: doc2docx contributors
License-Expression: MIT
Project-URL: Homepage, https://github.com/HuiTurn/doc2docx
Project-URL: Repository, https://github.com/HuiTurn/doc2docx
Project-URL: Issues, https://github.com/HuiTurn/doc2docx/issues
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# doc2docx

`doc2docx` is a pure-Python converter from Microsoft Word 97–2003 binary
`.doc` files to modern `.docx` files. The conversion engine follows the
published Microsoft Office binary-format specifications and does not invoke
Microsoft Word, LibreOffice, COM, Java, or another conversion executable.

The project is usable for a growing set of real documents, but it is not yet a
complete implementation of every legacy Word feature. Unsupported or lossy
content is reported explicitly instead of being silently presented as a fully
faithful conversion.

## Highlights

- Reads CFB/OLE Word documents with deterministic, bounded parsers.
- Opens XOR-obfuscated, classic RC4, and RC4 CryptoAPI password-protected
  documents when a password is supplied.
- Preserves text, common character and paragraph formatting, fonts, styles,
  native numbered and bulleted lists, tables, page layout, section page and
  line numbering, paragraph text frames, floating table positioning, headers,
  and footers.
- Converts footnotes and endnotes—including custom separators, placement, and
  numbering controls—plus comments, named bookmarks, safe document-local
  reference fields, common date/metadata/page/statistic fields, and positioned
  textboxes to native WordprocessingML structures.
- Preserves core document metadata such as title, author, subject, keywords,
  revision, and creation/modification dates.
- Restores inline and floating PNG, JPEG, BMP/DIB, TIFF, EMF, and WMF pictures
  in the main document and header/footer stories, including rotation, flips,
  tight/through wrap polygons, and common floating preset shapes such as
  polygons, stars, arrows, lines, and plaques.
- Preserves confirmed embedded OLE ObjectPool storages as native DOCX embedded
  objects, and retains Macintosh PICT payloads for consumers that can render
  them.
- Produces a structured diagnostic report for unsupported, repaired, or
  approximated source features.
- Writes deterministic OPC packages using only the Python standard library at
  runtime.

## Installation

```console
python -m pip install msdoc2docx
```

Python 3.11 or newer is required.

## Command line

Convert beside the input file:

```console
doc2docx input.doc
```

Choose the output path and save a JSON report:

```console
doc2docx input.doc -o output.docx --report report.json
```

For a password-protected document, prefer a UTF-8 password file so the secret
does not appear in the process command line:

```console
doc2docx protected.doc --password-file password.txt
```

Inspect a source file without converting it:

```console
doc2docx inspect input.doc --json
```

Convert a directory while preserving its relative layout and write one JSON
summary for successful and failed files:

```console
doc2docx batch input-directory -o output-directory --recursive --report batch.json
```

## Python API

```python
from doc2docx import convert

result = convert("input.doc", "output.docx", password="secret")
print(result.report.to_dict())
```

The source document is opened read-only. The destination and JSON reports are
written through temporary files and atomically replaced after validation or
serialization; the converter will not overwrite the input file. Report paths
are also checked against source and output paths, including every input and
destination in batch mode.

## Current limitations

Grouped/custom OfficeArt geometry and advanced drawing effects remain
incomplete. Unsupported geometry with a reliable wrap contour is retained as
an explicitly diagnosed contour approximation; geometry without such evidence
is deferred. Linked or unanchored OLE storages are not activated or guessed;
only confirmed embedded-object anchors are packaged. Macintosh PICT images are
retained as original media, although rendering them depends on support in the
DOCX consumer. The legacy macro story has no safe WordprocessingML equivalent
and is deliberately omitted. Fields that can execute actions or access
external content are kept as cached text. Some legacy layout behavior can only
be approximated in WordprocessingML and is called out in the conversion report.

See [CHANGELOG.md](CHANGELOG.md) for milestone and release details.

## Development

Run the standard-library test suite from a source checkout:

```console
PYTHONPATH=src python -m unittest discover -v
```

Build distributable artifacts with:

```console
python -m build
```

Real-document regression tests may use LibreOffice to create or render test
artifacts, but LibreOffice is not used by the converter itself.

## Specifications

- [MS-DOC: Word Binary File Format](https://learn.microsoft.com/openspecs/office_file_formats/ms-doc/ccd7b486-7881-484c-a137-51170af7cc22)
- [MS-ODRAW: Office Drawing Binary File Format](https://learn.microsoft.com/openspecs/office_file_formats/ms-odraw/)
