python-redlines

Generate tracked-change "redline" .docx documents by comparing two Word files.

python-redlines is the pure-Python core. The comparison engines themselves are compiled .NET binaries shipped in separate, optional companion packages — install the one(s) you need as extras:

pip install python-redlines[docxodus]          # Docxodus engine
pip install python-redlines[ooxmlpowertools]    # Open-XML-PowerTools engine
pip install python-redlines[all]                # both

Binaries are prebuilt for each platform and embedded in the companion package's wheel — no .NET SDK and no local compilation are needed to install or use it.

Usage

from python_redlines import DocxodusEngine

engine = DocxodusEngine()
redline_bytes, stdout, stderr = engine.run_redline(
    "Author Name",
    original=open("original.docx", "rb").read(),
    modified=open("modified.docx", "rb").read(),
)

DocxodusEngine accepts engine="wmlcomparer" (default) or engine="docxdiff" to select the comparison algorithm. See the project README.

If an engine's companion package is not installed, instantiating the engine raises EngineNotInstalledError with the pip install command to fix it.

See the project repository for details.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python_redlines-1.0.0.tar.gz (8.1 kB view details)

Uploaded Sep 6, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

python_redlines-1.0.0-py3-none-any.whl (6.9 kB view details)

Uploaded Sep 6, 2026 Python 3

File details

Details for the file python_redlines-1.0.0.tar.gz.

File metadata

Download URL: python_redlines-1.0.0.tar.gz
Upload date: Sep 6, 2026
Size: 8.1 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for python_redlines-1.0.0.tar.gz
Algorithm	Hash digest
SHA256	`0e5dc47c63bf38d744704e4afd318ca14e437438382d681e7a55af52b403bd44`
MD5	`2b9a558cf17cab958d2e8daeaf2400d1`
BLAKE2b-256	`c6756cea0f80329afabf9a3b168137f5e21a78c3ca35e88c5e740b2f02edd6ed`

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_redlines-1.0.0.tar.gz:

Publisher: python-publish.yml on JSv4/Python-Redlines

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: python_redlines-1.0.0.tar.gz
- Subject digest: 0e5dc47c63bf38d744704e4afd318ca14e437438382d681e7a55af52b403bd44
- Sigstore transparency entry: 2739151390
- Sigstore integration time: Sep 6, 2026
Source repository:
- Permalink: JSv4/Python-Redlines@b368d3d47fc17ce704d4b35d3f6a6b65ed3fe32a
- Branch / Tag: refs/tags/v1.0.0
- Owner: https://github.com/JSv4
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: python-publish.yml@b368d3d47fc17ce704d4b35d3f6a6b65ed3fe32a
- Trigger Event: release