Skip to content

Bump version and add notes to README. #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 1, 2024
Merged

Bump version and add notes to README. #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2024-present U.N. Owen <void@some.where>
#
# SPDX-License-Identifier: MIT
__version__ = "0.0.2"
__version__ = "0.0.3"