Skip to content

Commit

Permalink
Merge pull request #5 from JSv4/JSv4/bump-version-and-add-note-to-docs
Browse files Browse the repository at this point in the history
Bump version and add notes to README.
  • Loading branch information
JSv4 authored Apr 1, 2024
2 parents 6e67f6e + b479de7 commit e362a65
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,20 @@ maintained, as its most recent commits dates from 2 years ago and the repo issue

As a first step, our project aims to bring the existing capabilities of WmlCompare into the Python world. Thankfully,
XML Power Tools is full cross-platform as it is written in .NET and compiles with the still-maintained .NET 8. The
resulting binaries can be compiled for the latest versions of Windows and Linux (Ubuntu specifically, though other
distributions should work fine too).
resulting binaries can be compiled for the latest versions of Windows, OSX and Linux (Ubuntu specifically, though other
distributions should work fine too). We have included an OSX build but do not have an OSX machine to test on. Please
report an issues by opening a new Issue.

The initial release has a single engine `XmlPowerToolsEngine`, which is just a Python wrapper for a simple C# utility
written to leverage WmlComparer for 1-to-1 redlines. We hope this provides a stop-gap capability to Python developers
seeking .docx redline capabilities.

**Note**, we don't plan to fork or maintain Open-XML-PowerTools. [Version 4.4.0](https://www.nuget.org/packages/Open-Xml-PowerTools/),
which appears to only be compatible with [Open XML SDK < 3.0.0](https://www.nuget.org/packages/DocumentFormat.OpenXml) works
for now, it needs to be made compatible with the latest versions of the Open XML SDK to extend its life. There are
also some [issues](https://github.com/dotnet/Open-XML-SDK/issues/1634) it seems the only maintainer of
Open-XML-PowerTools probably won't fix, and understanding the existing code base is no small task.
for now, it needs to be made compatible with the latest versions of the Open XML SDK to extend its life. **There are
also some [issues](https://github.com/dotnet/Open-XML-SDK/issues/1634)**, and it seems the only maintainer of
Open-XML-PowerTools probably won't fix, and understanding the existing code base is no small task. Please be aware that
**Open XML PowerTools is not a perfect comparison engine, but it will work for many purposes. Use at your own risk.**

### Step 2. Pure Python Comparison Engine

Expand Down
2 changes: 1 addition & 1 deletion src/python_redlines/__about__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2024-present U.N. Owen <[email protected]>
#
# SPDX-License-Identifier: MIT
__version__ = "0.0.2"
__version__ = "0.0.3"

0 comments on commit e362a65

Please sign in to comment.