Skip to main content

Automated DOCX Redlining Engine

Project description

Adeu OSS: DOCX Redlining Engine

Adeu allows AI Agents and LLMs to safely "Track Changes" in Microsoft Word documents.

Most LLMs output raw text or Markdown. Legal and compliance professionals need w:ins (insertions) and w:del (deletions) to review changes natively in Word.

Adeu solves this by treating DOCX as a "Virtual DOM". It presents a clean, readable text representation to the AI, and then reconciles the AI's edits back into the original XML structure without breaking formatting, numbering, or images.

🚀 New in v0.5.0

  • Comments & Threads: Full support for reading and replying to Word comments using CriticMarkup syntax ({==Target==}{>>Comment<<}).
  • Negotiation Actions: Agents can now ACCEPT, REJECT, or REPLY to specific changes and comments.
  • Safety: Enhanced protection against corrupting nested revisions or structural boilerplate.

Installation

pip install adeu

Ways to Use Adeu

1. As an MCP Server

Connect Adeu directly to your agentic workspace. This allows AI Agent to read contracts, propose redlines, and answer comments natively.

Add this to your claude_desktop_config.json:

{
  "mcpServers": {
    "adeu": {
      "command": "uvx",
      "args": ["adeu", "adeu-server"]
    }
  }
}

What the Agent sees: The agent receives a text view of the document where comments and changes are clearly marked:

The Vendor shall be liable for {==indirect damages==}{>>[Counsel] We request this be removed.<<}...

Available MCP Tools

Tool Description
read_docx Reads a DOCX file. supports clean_view=True to simulate "Accept All Changes" before reading.
diff_docx_files Compares two DOCX files and returns a text-based Unified Diff, ignoring formatting noise.
apply_structured_edits The Core Engine. Applies a list of "Search & Replace" edits, generating native Track Changes (w:ins/w:del).
manage_review_actions Review workflow. Allows the Agent to ACCEPT, REJECT, or REPLY to specific changes or comments by ID.
accept_all_changes Creates a clean version of the document by accepting all revisions and removing comments.

2. For Python Developers ("Vibe Coding")

Adeu handles the heavy lifting of XML manipulation so you can focus on the logic.

from adeu import RedlineEngine, DocumentEdit
from io import BytesIO

# 1. Load your contract
with open("NDA.docx", "rb") as f:
    stream = BytesIO(f.read())

# 2. Define the change (e.g., from an LLM response)
# Adeu uses "Search & Replace" logic with fuzzy matching
edit = DocumentEdit(
    target_text="State of New York",
    new_text="State of Delaware",
    comment="Standardizing governing law."
)

# 3. Apply the Redline
engine = RedlineEngine(stream, author="AI Associate")
engine.apply_edits([edit])

# 4. Save
with open("NDA_Redlined.docx", "wb") as f:
    f.write(engine.save_to_stream().getvalue())

3. The CLI

Quickly extract text or apply patches from your terminal.

# Compare two docs and get a summary
adeu diff v1.docx v2.docx

# Apply a structured edit list (JSON) to a doc
adeu apply agreement.docx edits.json --author "Reviewer Bot"

Why Adeu?

  • Native Redlines: Generates real Microsoft Word Track Changes. You can "Accept" or "Reject" them in Word.
  • Format Safe: Preserves complex numbering, headers, footers, and images. It only touches the text you change.
  • Token Efficient: Converts heavy XML into lightweight Markdown for the LLM context window.
  • Intelligent Mapping: Handles the messy internal XML of Word documents (e.g., when "Contract" is split into ["Con", "tract"] by spellcheck).

License

MIT License. Open source and free to use in commercial legal tech applications.

Project details


Download files

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

Source Distribution

adeu-0.5.4.tar.gz (36.8 kB view details)

Uploaded Source

Built Distribution

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

adeu-0.5.4-py3-none-any.whl (40.0 kB view details)

Uploaded Python 3

File details

Details for the file adeu-0.5.4.tar.gz.

File metadata

  • Download URL: adeu-0.5.4.tar.gz
  • Upload date:
  • Size: 36.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for adeu-0.5.4.tar.gz
Algorithm Hash digest
SHA256 e1f5f7eb9b99c5f8559e471912464b2e60e5fb7a0a43e3338394473bdf0cde32
MD5 7a4450ce0fa155fd144ac0b7ebb4dfde
BLAKE2b-256 542b76ac6d3c856e5a9d61c766184cd8950bdd9e598e381025d153c25bfac95b

See more details on using hashes here.

Provenance

The following attestation bundles were made for adeu-0.5.4.tar.gz:

Publisher: release.yml on dealfluence/adeu

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

File details

Details for the file adeu-0.5.4-py3-none-any.whl.

File metadata

  • Download URL: adeu-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 40.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for adeu-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a3cb4ed737aaa9d55b24aa93ad57af5d5c1e04c249c77340ee22a957fe7140f2
MD5 694f8be5fdaa4ec38129cd4431552344
BLAKE2b-256 b9cbbc6d6be1436a3dea3343bdac5c2784d069dc80e755f3c043166ede55aa8d

See more details on using hashes here.

Provenance

The following attestation bundles were made for adeu-0.5.4-py3-none-any.whl:

Publisher: release.yml on dealfluence/adeu

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page