Skip to content

Commit e362a65

Browse files
authored
Merge pull request #5 from JSv4/JSv4/bump-version-and-add-note-to-docs
Bump version and add notes to README.
2 parents 6e67f6e + b479de7 commit e362a65

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,20 @@ maintained, as its most recent commits dates from 2 years ago and the repo issue
2323

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

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

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

3941
### Step 2. Pure Python Comparison Engine
4042

src/python_redlines/__about__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# SPDX-FileCopyrightText: 2024-present U.N. Owen <void@some.where>
22
#
33
# SPDX-License-Identifier: MIT
4-
__version__ = "0.0.2"
4+
__version__ = "0.0.3"

0 commit comments

Comments
 (0)