HTML to DOCX Converter (htmldocx)

0.0.6 · maintenance · verified Sun Apr 12

The `htmldocx` library provides functionality to convert HTML content into DOCX format, building upon `python-docx` and `beautifulsoup4`. While its last release was in August 2021, it is considered to be in a maintenance state, with more actively developed forks available that address limitations and bugs present in this version.

Warnings

gotcha The `htmldocx` package has not been updated since August 2021. This means it may lack modern HTML rendering features, bug fixes, or compatibility updates present in more recently developed alternatives or forks.
Fix: Consider using more actively maintained forks or alternative libraries for robust HTML to DOCX conversion, such as `html-for-docx`.
gotcha Developers who have forked this project (e.g., `html-for-docx`) have cited "limitations and bugs" in the original `pqzx/html2docx` codebase (which `htmldocx` is based on) that prevented them from completing tasks. Users may encounter similar rendering issues with complex HTML structures or specific CSS styles.
Fix: Test thoroughly with your specific HTML inputs. For advanced styling or complex layouts, prepare to use workarounds or explore alternative libraries.
gotcha Tables are not styled by default when converted. To apply styles like borders or shading, you must explicitly set the `table_style` attribute on the `HtmlToDocx` parser instance.
Fix: Set `new_parser.table_style = 'Light Shading Accent 4'` or another valid style (e.g., 'TableGrid') before adding HTML content.
gotcha No specific style is applied to paragraphs by default. While additional styling defined in HTML will be applied, a base paragraph style is not automatically set.
Fix: Set the `paragraph_style` attribute on the `HtmlToDocx` parser instance to apply a default style to all paragraphs if needed (e.g., `new_parser.paragraph_style = 'Normal'`).

Install

pip install htmldocx Install `htmldocx`

Imports

HtmlToDocx
```
from htmldocx import HtmlToDocx
```

Quickstart

Initialise `HtmlToDocx` and use `add_html_to_document` to insert HTML into a `python-docx` Document object, or use `parse_html_file` / `parse_html_string` for direct conversion.

from docx import Document
from htmldocx import HtmlToDocx

document = Document()
new_parser = HtmlToDocx()

html_content = '<h1>Hello world</h1><p>This is a paragraph.</p>'

# Add HTML to an existing Document object
new_parser.add_html_to_document(html_content, document)

# Save the document
document.save('your_file_name.docx')

# Or convert a file directly
# new_parser.parse_html_file('input.html', 'output.docx')

# Or convert from an HTML string to a new docx object
# docx_object = new_parser.parse_html_string('<h2>Another title</h2>')
# docx_object.save('another_file.docx')

view raw JSON →