1 Examples Generating Excel Documents Using Python’s xlwt
  2 
  3 Here are some simple examples using Python’s xlwt library to dynamically generate Excel documents.
  4 
  5 Please note a useful alternative may be ezodf, which allows you to generate ODS (Open Document Spreadsheet) files for LibreOffice / OpenOffice. You can check them out at:http://packages.python.org/ezodf/index.html
 
  6 
  7 The Simplest Example
  8 import xlwt
  9 workbook = xlwt.Workbook(encoding = 'ascii')
 10 worksheet = workbook.add_sheet('My Worksheet')
 11 worksheet.write(0, 0, label = 'Row 0, Column 0 Value')
 12 workbook.save('Excel_Workbook.xls')
 13 
 14 Formatting the Contents of a Cell
 15 import
 
 xlwt
 16 workbook = xlwt.Workbook(encoding = 'ascii')
 17 worksheet = workbook.add_sheet('My Worksheet')
 18 font = xlwt.Font() # Create the Font
 19 font.name = 'Times New Roman'
 20 font.bold = True
 21 font.underline = True
 22 font.italic = True
 23 style = xlwt.XFStyle() # Create the Style
 

 24 style.font = font # Apply the Font to the Style
 25 worksheet.write(0, 0, label = 'Unformatted value')
 26 worksheet.write(1, 0, label = 'Formatted value', style) # Apply the Style to the Cell
 27 workbook.save('Excel_Workbook.xls')
 28 
 29 Attributes of the Font Object
 30 font.bold = True # May be: True, False
 31 font.italic = True # May be: True, False
 32 font.struck_out = True # May be: True, False
 33 font.underline = xlwt.Font.UNDERLINE_SINGLE # May be: UNDERLINE_NONE, UNDERLINE_SINGLE, UNDERLINE_SINGLE_ACC, UNDERLINE_DOUBLE, UNDERLINE_DOUBLE_ACC
 34 font.escapement = xlwt.Font.ESCAPEMENT_SUPERSCRIPT # May be: ESCAPEMENT_NONE, ESCAPEMENT_SUPERSCRIPT, ESCAPEMENT_SUBSCRIPT
 35 font.family = xlwt.Font.FAMILY_ROMAN # May be: FAMILY_NONE, FAMILY_ROMAN, FAMILY_SWISS, FAMILY_MODERN, FAMILY_SCRIPT, FAMILY_DECORATIVE
 36 font.charset = xlwt.Font.CHARSET_ANSI_LATIN # May be: CHARSET_ANSI_LATIN, CHARSET_SYS_DEFAULT, CHARSET_SYMBOL, CHARSET_APPLE_ROMAN, CHARSET_ANSI_JAP_SHIFT_JIS, CHARSET_ANSI_KOR_HANGUL, CHARSET_ANSI_KOR_JOHAB, CHARSET_ANSI_CHINESE_GBK, CHARSET_ANSI_CHINESE_BIG5, CHARSET_ANSI_GREEK, CHARSET_ANSI_TURKISH, CHARSET_ANSI_VIETNAMESE, CHARSET_ANSI_HEBREW, CHARSET_ANSI_ARABIC, CHARSET_ANSI_BALTIC, CHARSET_ANSI_CYRILLIC, CHARSET_ANSI_THAI, CHARSET_ANSI_LATIN_II, CHARSET_OEM_LATIN_I
 37 font.colour_index = ?
 38 font.get_biff_record = ?
 39 font.height = 0x00C8 # C8 in Hex (in decimal) = 10 points in height.
 40 font.name = ?
 41 font.outline = ?
 42 font.shadow = ?
 43 
 44 Setting the Width of a Cell
 45 import xltw
 46 workbook = xlwt.Workbook()
 47 worksheet = workbook.add_sheet('My Sheet')
 48 worksheet.write(0, 0, 'My Cell Contents')
 49 worksheet.col(0).width = 3333 # 3333 = 1" (one inch).
 50 workbook.save('Excel_Workbook.xls')
 51 
 52 Entering a Date into a Cell
 53 import xlwt
 54 import datetime
 55 workbook = xlwt.Workbook()
 56 worksheet = workbook.add_sheet('My Sheet')
 57 style = xlwt.XFStyle()
 58 style.num_format_str = 'M/D/YY' # Other options: D-MMM-YY, D-MMM, MMM-YY, h:mm, h:mm:ss, h:mm, h:mm:ss, M/D/YY h:mm, mm:ss, [h]:mm:ss, mm:ss.0
 59 worksheet.write(0, 0, datetime.datetime.now(), style)
 60 workbook.save('Excel_Workbook.xls')
 61 
 62 Adding a Formula to a Cell
 63 import xlwt
 64 workbook = xlwt.Workbook()
 65 worksheet = workbook.add_sheet('My Sheet')
 66 worksheet.write(0, 0, 5) # Outputs 5
 67 worksheet.write(0, 1, 2) # Outputs 2
 68 worksheet.write(1, 0, xlwt.Formula('A1*B1')) # Should output "10" (A1[5] * A2[2])
 69 worksheet.write(1, 1, xlwt.Formula('SUM(A1,B1)')) # Should output "7" (A1[5] + A2[2])
 70 workbook.save('Excel_Workbook.xls')
 71 
 72 Adding a Hyperlink to a Cell
 73 import xlwt
 74 workbook = xlwt.Workbook()
 75 worksheet = workbook.add_sheet('My Sheet')
 76 worksheet.write(0, 0, xlwt.Formula('HYPERLINK("http://www.google.com";"Google")')) # Outputs the text "Google" linking to http://www.google.com
 77 workbook.save('Excel_Workbook.xls')
 78 
 79 Merging Columns and Rows
 80 import xlwt
 81 workbook = xlwt.Workbook()
 82 worksheet = workbook.add_sheet('My Sheet')
 83 worksheet.write_merge(0, 0, 0, 3, 'First Merge') # Merges row 0's columns 0 through 3.
 84 font = xlwt.Font() # Create Font
 85 font.bold = True # Set font to Bold
 86 style = xlwt.XFStyle() # Create Style
 87 style.font = font # Add Bold Font to Style
 88 worksheet.write_merge(1, 2, 0, 3, 'Second Merge', style) # Merges row 1 through 2's columns 0 through 3.
 89 workbook.save('Excel_Workbook.xls')
 90 
 91 Setting the Alignment for the Contents of a Cell
 92 import xlwt
 93 workbook = xlwt.Workbook()
 94 worksheet = workbook.add_sheet('My Sheet')
 95 alignment = xlwt.Alignment() # Create Alignment
 96 alignment.horz = xlwt.Alignment.HORZ_CENTER # May be: HORZ_GENERAL, HORZ_LEFT, HORZ_CENTER, HORZ_RIGHT, HORZ_FILLED, HORZ_JUSTIFIED, HORZ_CENTER_ACROSS_SEL, HORZ_DISTRIBUTED
 97 alignment.vert = xlwt.Alignment.VERT_CENTER # May be: VERT_TOP, VERT_CENTER, VERT_BOTTOM, VERT_JUSTIFIED, VERT_DISTRIBUTED
 98 style = xlwt.XFStyle() # Create Style
 99 style.alignment = alignment # Add Alignment to Style
100 worksheet.write(0, 0, 'Cell Contents', style)
101 workbook.save('Excel_Workbook.xls')
102 
103 Adding Borders to a Cell
104 # Please note: While I was able to find these constants within the source code, on my system (using LibreOffice,) I was only presented with a solid line, varying from thin to thick; no dotted or dashed lines.
105 import xlwt
106 workbook = xlwt.Workbook()
107 worksheet = workbook.add_sheet('My Sheet')
108 borders = xlwt.Borders() # Create Borders
109 borders.left = xlwt.Borders.DASHED # May be: NO_LINE, THIN, MEDIUM, DASHED, DOTTED, THICK, DOUBLE, HAIR, MEDIUM_DASHED, THIN_DASH_DOTTED, MEDIUM_DASH_DOTTED, THIN_DASH_DOT_DOTTED, MEDIUM_DASH_DOT_DOTTED, SLANTED_MEDIUM_DASH_DOTTED, or 0x00 through 0x0D.
110 borders.right = xlwt.Borders.DASHED
111 borders.top = xlwt.Borders.DASHED
112 borders.bottom = xlwt.Borders.DASHED
113 borders.left_colour = 0x40
114 borders.right_colour = 0x40
115 borders.top_colour = 0x40
116 borders.bottom_colour = 0x40
117 style = xlwt.XFStyle() # Create Style
118 style.borders = borders # Add Borders to Style
119 worksheet.write(0, 0, 'Cell Contents', style)
120 workbook.save('Excel_Workbook.xls')
121 
122 Setting the Background Color of a Cell
123 import xlwt
124 workbook = xlwt.Workbook()
125 worksheet = workbook.add_sheet('My Sheet')
126 pattern = xlwt.Pattern() # Create the Pattern
127 pattern.pattern = xlwt.Pattern.SOLID_PATTERN # May be: NO_PATTERN, SOLID_PATTERN, or 0x00 through 0x12
128 pattern.pattern_fore_colour = 5 # May be: 8 through 63. 0 = Black, 1 = White, 2 = Red, 3 = Green, 4 = Blue, 5 = Yellow, 6 = Magenta, 7 = Cyan, 16 = Maroon, 17 = Dark Green, 18 = Dark Blue, 19 = Dark Yellow , almost brown), 20 = Dark Magenta, 21 = Teal, 22 = Light Gray, 23 = Dark Gray, the list goes on...
129 style = xlwt.XFStyle() # Create the Pattern
130 style.pattern = pattern # Add Pattern to Style
131 worksheet.write(0, 0, 'Cell Contents', style)
132 workbook.save('Excel_Workbook.xls')
133 
134 TODO: Things Left to Document
135 - Panes -- separate views which are always in view
136 - Border Colors (documented above, but not taking effect as it should)
137 - Border Widths (document above, but not working as expected)
138 - Protection
139 - Row Styles
140 - Zoom / Manification
141 - WS Props?
142 Source Code for reference available at: https://secure.simplistix.co.uk/svn/xlwt/trunk/xlwt/