docx-utils 0.1.3

Creation and manipulation of Open XML documents (mainly docx).

Overview

Creation and manipulation of Open XML documents (mainly docx).

• Free software: MIT license

Features

This library allow you to:

• Convert Open XML documents into flat OPC format.

Installation

pip install docx-utils

Using the library

Using the library to convert an Open XML document into flat OPC format:

>>> from docx_utils.flatten import opc_to_flat_opc
>>> opc_to_flat_opc("sample.docx", "sample.xml")

Command Line Interface (CLI)

Printing the online help:

$ docx_utils --help
Usage: docx_utils [OPTIONS] COMMAND [ARGS]...

  Docx utilities

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  flatten  Convert an Open XML document into flat OPC format.

Converting an Open XML document into flat OPC format:

$ docx_utils flatten sample.docx sample.xml
Converting 'sample.docx' to flat XML...
Conversion done: 'sample.xml'.

Documentation

https://docx-utils.readthedocs.io/en/latest/

Development

To run the all tests run:

tox

Changelog

v0.1.3 (2020-07-15)

Fixed

• Correct the project’s dependencies: Enum34 is only required for Python versions < 3.4.

• Add the docx_utils.exceptions module: Exception hierarchy for the docx-utils package.

• Fix #1:

  • Add the on_error option in the docx_utils.flatten.opc_to_flat_opc function in order to ignore (or raise an exception) when a part URI cannot be resolved during the Microsoft Office document parsing.

  • Change the command line interface: add the --on-error option to handle parsing error.

Other

• Continuous Integration: add configurations for Python 3.7 and Python 3.8.

v0.1.2 (2018-07-26)

Fixed

• Drop support for PyPy: it seams that lxml is not available for this Python implementation.

• Drop support for Python 3.7: this Python version is not yet available on all platform. However, it is known to work on Ubuntu with the python-3.7-dev release.

Other

• Use the pseudo-tags start-exclude/end-exclude in CHANGELOG.rst and README.rst to exclude text from the generated PKG-INFO during setup.

v0.1.1 (2018-07-25)

Fixed

• Fix wheel version on PyPi.

v0.1.1 (2018-07-24)

Added

• First release.