1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
|
python-docx
===========
Release v\ |version| (:ref:`Installation <install>`)
*python-docx* is a Python library for creating and updating Microsoft Word
(.docx) files.
What it can do
--------------
.. |img| image:: /_static/img/example-docx-01.png
Here's an example of what |docx| can do:
============================================ ===============================================================
|img| ::
from docx import Document
from docx.shared import Inches
document = Document()
document.add_heading('Document Title', 0)
p = document.add_paragraph('A plain paragraph having some ')
p.add_run('bold').bold = True
p.add_run(' and some ')
p.add_run('italic.').italic = True
document.add_heading('Heading, level 1', level=1)
document.add_paragraph('Intense quote', style='Intense Quote')
document.add_paragraph(
'first item in unordered list', style='List Bullet'
)
document.add_paragraph(
'first item in ordered list', style='List Number'
)
document.add_picture('monty-truth.png', width=Inches(1.25))
records = (
(3, '101', 'Spam'),
(7, '422', 'Eggs'),
(4, '631', 'Spam, spam, eggs, and spam')
)
table = document.add_table(rows=1, cols=3)
hdr_cells = table.rows[0].cells
hdr_cells[0].text = 'Qty'
hdr_cells[1].text = 'Id'
hdr_cells[2].text = 'Desc'
for qty, id, desc in records:
row_cells = table.add_row().cells
row_cells[0].text = str(qty)
row_cells[1].text = id
row_cells[2].text = desc
document.add_page_break()
document.save('demo.docx')
============================================ ===============================================================
User Guide
----------
.. toctree::
:maxdepth: 1
user/install
user/quickstart
user/documents
user/text
user/sections
user/hdrftr
user/api-concepts
user/styles-understanding
user/styles-using
user/shapes
API Documentation
-----------------
.. toctree::
:maxdepth: 2
api/document
api/settings
api/style
api/text
api/table
api/section
api/shape
api/dml
api/shared
api/enum/index
Contributor Guide
-----------------
.. toctree::
:maxdepth: 1
dev/analysis/index
|