How to add images to a Word document with python-docx?

Use the add_picture method on a paragraph or run object, such as document.add_picture('image.png'), and adjust properties like width and height for customization. Refer to the documentation for advanced options like inline vs. floating images.

python-docx vs reportlab for document generation?

python-docx is best for Word .docx files with a focus on Microsoft Word compatibility, while reportlab is for PDF generation with more layout control. Choose python-docx if your output must be in Word format; use reportlab for PDFs or complex printing needs.

Can python-docx handle Word macros or VBA scripts?

No, python-docx does not support macros or VBA automation; it is limited to content and formatting manipulation within the .docx structure, so for macro-enabled documents, you need other tools or manual editing.

How to extract specific text or tables from a .docx file?

Use the Document class to load the file, then access paragraphs or tables via attributes like document.paragraphs or document.tables, and iterate through them to filter or extract data based on patterns or indices.

Is python-docx good for generating invoices or contracts dynamically?

Yes, it excels at templating by allowing you to create documents with placeholders and replace text programmatically, making it ideal for business documents like invoices where data from databases can be inserted automatically.

How to apply custom styles or fonts in python-docx?

Define styles using the document.styles.add_style method or modify existing ones, then apply them to paragraphs or runs. However, advanced styling might require direct XML manipulation due to limitations in the API.

Open-Awesome

python-docx

MITPython

A Python library for reading, creating, and updating Microsoft Word (.docx) files.

GitHub

5.6k stars1.3k forks0 contributors

What is python-docx?

python-docx is a Python library that allows developers to programmatically create, read, and modify Microsoft Word documents in the .docx format. It solves the problem of automating Word document generation and manipulation, eliminating the need for manual editing or relying on GUI-based tools for document processing tasks.

Target Audience

Python developers who need to automate Word document creation, data reporting, or document processing workflows, particularly in data analysis, business automation, and content generation applications.

Value Proposition

Developers choose python-docx because it provides a pure Python solution for Word document automation without requiring Microsoft Office installation, offering a straightforward API that simplifies working with the complex OpenXML document format.

Overview

Create and modify Word documents with Python

Use Cases

Best For

Automating report generation from data sources
Creating templated documents with dynamic content
Batch processing and modifying multiple Word documents
Extracting text and data from existing .docx files
Generating invoices, contracts, or other business documents programmatically
Building document automation tools for content management systems

Not Ideal For

Projects requiring support for legacy .doc (pre-2007) Word formats
Applications needing real-time collaboration features like Google Docs or Word Online
Tasks involving complex document elements such as embedded Excel sheets or ActiveX controls
High-performance batch processing of very large documents (over 100+ pages) due to potential memory overhead

Pros & Cons

Pros

Pure Python Solution

Does not require Microsoft Office installation, enabling server-side automation and cross-platform use, as highlighted in the value proposition.

Clean, Pythonic API

Abstracts the complexities of OpenXML with an intuitive interface, allowing easy operations like document.add_paragraph() for quick document creation and modification.

Comprehensive Feature Set

Supports key Word features including text formatting, table manipulation, and style application, making it suitable for automated report generation and data extraction.

Easy Installation and Setup

Can be installed via pip with a single command, and the README provides a straightforward example for getting started with basic document handling.

Cons

Limited to .docx Format

Only works with Word 2007+ files, so projects needing older .doc formats or other document types require additional libraries or tools.

Incomplete Feature Coverage

Lacks support for advanced Word features like macros, comments tracking, or automatic table of contents, which may necessitate manual XML workarounds.

Documentation Reliance

Relies on external readthedocs documentation that can be sparse for advanced use cases, as the README is minimal and points users elsewhere for details.

Open Source Alternative To

python-docx is an open-source alternative to the following products:

VBA for Word

VBA for Word is Visual Basic for Applications integrated into Microsoft Word, allowing automation of tasks, custom functions, and document manipulation.

Microsoft Word Automation

Frequently Asked Questions

Related Projects

markitdown

Python tool for converting files and office documents to Markdown.

Stars147,541

Forks10,115

Last commit13 days ago

docling

Get your documents ready for gen AI

A pure-python PDF library capable of splitting, merging, cropping, and transforming the pages of PDF files

Stars10,031

Forks1,580

Last commit3 days ago

Kreuzberg

A polyglot document intelligence framework with a Rust core. Extract text, metadata, images, and structured information from PDFs, Office documents, images, and 97+ formats. Available for Rust, Python, Ruby, Java, Go, PHP, Elixir, C#, R, C, TypeScript (Node/Bun/Wasm/Deno)- or use via CLI, REST API, or MCP server.

Stars8,455

Forks497