Skip to content
This repository has been archived by the owner. It is now read-only.
Reads, queries and modifies Microsoft Word 2007/2008 docx files.
Python
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
template Corrected the creation of picrelid and unique filenames, usage of Dec 14, 2013
tests fix: issue #60, some reformatting Feb 6, 2014
.gitignore release: v0.2.1 Oct 10, 2013
HACKING.markdown - Yet more doc fixes Jan 23, 2010
LICENSE - Walk template dir for zip creation Jan 2, 2010
MANIFEST.in - Media folder not installed with site-packages template, created on … Jan 26, 2010
Makefile add Makefile target to generate README.html Aug 6, 2013
README.rst Make it more prominent that the project has moved. Aug 19, 2014
SERVING_SUGGESTIONS.markdown
__init__.py Added __init__.py Sep 3, 2010
docx.py fix: issue #60, some reformatting Feb 6, 2014
example-extracttext.py PEP8 example-extracttext.py Jul 17, 2013
example-makedocument.py Add an example showing italic text. Aug 6, 2013
image1.png - Added sample pic Jan 10, 2010
screenshot.png - Documentation updates Oct 20, 2010
setup.py fix: issue #60, some reformatting Feb 6, 2014
tox.ini add tox.ini Aug 6, 2013

README.rst

This Project Has Moved!

Python DocX is now part of Python OpenXML. There's all kinds of new stuff, including Python 3 support, sister libraries for doing Excel files, and more. Check out the current Python DocX GitHub and the current Python DocX docs.

Info below is kept for archival purposes. Go use the new stuff!

Introduction

The docx module creates, reads and writes Microsoft Office Word 2007 docx files.

These are referred to as 'WordML', 'Office Open XML' and 'Open XML' by Microsoft.

These documents can be opened in Microsoft Office 2007 / 2010, Microsoft Mac Office 2008, Google Docs, OpenOffice.org 3, and Apple iWork 08.

They also validate as well formed XML.

The module was created when I was looking for a Python support for MS Word .docx files, but could only find various hacks involving COM automation, calling .Net or Java, or automating OpenOffice or MS Office.

The docx module has the following features:

Making documents

Features for making documents include:

  • Paragraphs
  • Bullets
  • Numbered lists
  • Document properties (author, company, etc)
  • Multiple levels of headings
  • Tables
  • Section and page breaks
  • Images

http://github.com/mikemaccana/python-docx/raw/master/screenshot.png

Editing documents

Thanks to the awesomeness of the lxml module, we can:

  • Search and replace
  • Extract plain text of document
  • Add and delete items anywhere within the document
  • Change document properties
  • Run xpath queries against particular locations in the document - useful for retrieving data from user-completed templates.

Getting started

Making and Modifying Documents

  • Just download python docx.

  • Use pip or easy_install to fetch the lxml and PIL modules.

  • Then run:

    example-makedocument.py
    

Congratulations, you just made and then modified a Word document!

Extracting Text from a Document

If you just want to extract the text from a Word file, run:

example-extracttext.py 'Some word file.docx' 'new file.txt'

Ideas & To Do List

  • Further improvements to image handling
  • Document health checks
  • Egg
  • Markdown conversion support

We love forks, changes and pull requests!

  • Check out the [HACKING](HACKING.markdown) to add your own changes!
  • For this project on github
  • Send a pull request via github and we'll add your changes!

Want to talk? Need help?

Email python-docx@googlegroups.com

License

Licensed under the MIT license

Short version: this code is copyrighted to me (Mike MacCana), I give you permission to do what you want with it except remove my name from the credits. See the LICENSE file for specific terms.

You can’t perform that action at this time.