docx Mail Merge

Performs a Mail Merge on Office Open XML (docx) files. Can be used on any system without having to install Microsoft Office Word. Supports Python 2.7, 3.2 and up.

Installation

Installation with pip: :

$ pip install docx-mailmerge

Usage

Open the file. :

from mailmerge import MailMerge
document = MailMerge('input.docx')

List all merge fields. :

print document.get_merge_fields()

Merge fields, supplied as kwargs. :

document.merge(field1='docx Mail Merge',
               field2='Can be used for merging docx documents')

Merge table rows. In your template, add a MergeField to the row you would like to designate as template. Supply the name of this MergeField as anchor parameter. The second parameter contains the rows with key-value pairs for the MergeField replacements. :

document.merge_rows('col1',
                    [{'col1': 'Row 1, Column 1', 'col2': 'Row 1 Column 1'},
                     {'col1': 'Row 2, Column 1', 'col2': 'Row 2 Column 1'},
                     {'col1': 'Row 3, Column 1', 'col2': 'Row 3 Column 1'}]

Starting in version 0.2.0 you can also combine these two separate calls into a single call to merge. :

document.merge(field1='docx Mail Merge',
               col1=[
                   {'col1': 'A'},
                   {'col1': 'B'},
               ])

Starting in version 0.2.0 there's also the feature for template mergingg. This creates a copy of the template for each item in the list, does a merge, and separates the them by page breaks. :

document.merge_pages([
    {'field1': "Foo", 'field2: "Copy #1"},
    {'field1': "Bar", 'field2: "Copy #2"},
])

Write document to file. This should be a new file, as ZipFile cannot modify existing zip files. :

document.write('output.docx')

Todo / Wish List

Preserve formatting of the merge field, currently it defaults to the formatting of the containing text.
Image merging.

Contributing

Fork the repository on GitHub and start hacking
Create / fix the unit tests
Send a pull request with your changes

Unit tests

In order to make sure that the library performs the way it was designed, unit tests are used. When providing new features, or fixing bugs, there should be a unit test that demonstrates it. Run the test suite: