Skip to content

v2.0.0 — Docxodus 14.1.0

Latest
Latest

Choose a tag to compare

View all tags
@JSv4 JSv4 released this 24 Oct 15:14
v2.0.0
e639de8
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Python-Redlines 2.0.0 bundles Docxodus v14.1.0 and fixes incompatible wrapper/engine installations. This is a major release to make the change in generated redlines an explicit upgrade boundary. Python call signatures and supported comparison settings remain compatible with 1.0.0; comparison markup, revision granularity and counts can change.

Upgrade

pip install --upgrade 'python-redlines[docxodus]==2.0.0'

Every extra now pins its engine companion to exactly the wrapper's release version. Update separately pinned companion packages and lockfiles to 2.0.0 too. All three packages release together: python-redlines, python-redlines-docxodus, and python-redlines-ooxmlpowertools.

Review representative documents and refresh any output snapshots or revision-count expectations before updating production. A single-character CJK edit now marks only the changed character. Edits within unchanged content-control and custom-XML wrappers can be marked inside the wrapper rather than replacing the whole wrapper. The project's fixture still reports 10 revisions, but other documents can produce different output.

See the 2.0.0 migration guide. Upgrades from 0.3.0 must also follow the existing 1.0.0 migration steps: the removed engine, detail_threshold and simplify_move_markup settings remain unsupported. XmlPowerToolsEngine remains available and deprecated.

Fixes and engine update

  • Fix #34: extras require matching companion versions, preventing fresh installs from pairing a wrapper with an incompatible engine. Published 0.3.0 and 1.0.0 metadata cannot be changed; users staying on those releases must pin both packages explicitly.
  • Failed engine commands now raise EngineExecutionError, a subprocess.CalledProcessError subclass whose message includes captured stderr and stdout. Existing exception handlers and the returncode, cmd, stdout/output, and stderr attributes remain compatible.
  • Build the Docxodus engine from v14.1.0, pinned to commit 1b05750689afc432d24a5e9fd9849a01899a9994. See the upstream release history for the full engine changes.
  • Add regression coverage for package metadata, failure diagnostics and cleanup, future version bumps, and single-character CJK edits.

Changes

  • #33: correct HTML-preview documentation.
  • #36: pin companion releases and expose engine diagnostics.
  • #37: upgrade Docxodus to v14.1.0 and verify CJK granularity.
  • #38: prepare the 2.0.0 version and migration guide.

Validation: all nine Linux/macOS/Windows × Python 3.9/3.11/3.12 test jobs, builds for all six engine-wheel targets, core wheel/sdist checks, and Action self-tests passed. Codex reviews found no actionable defects in the engine update, dependency fix, or release preparation.

Full comparison from v1.0.0

Assets 2
Loading