Here are some easy instructions to get you up and running with the XlsxWriter module.
The first step is to install the XlsxWriter module. There are several ways to do this.
$ sudo pip install XlsxWriter
Windows users can omit
sudo at the start of the command.
pip doesn’t work you can try
$ sudo easy_install XlsxWriter
If you download a tarball of the latest version of XlsxWriter you can install it as follows (change the version number to suit):
$ tar -zxvf XlsxWriter-1.2.3.tar.gz $ cd XlsxWriter-1.2.3 $ sudo python setup.py install
A tarball of the latest code can be downloaded from GitHub as follows:
$ curl -O -L http://github.com/jmcnamara/XlsxWriter/archive/master.tar.gz $ tar zxvf master.tar.gz $ cd XlsxWriter-master/ $ sudo python setup.py install
The XlsxWriter source code and bug tracker is in the XlsxWriter repository on GitHub. You can clone the repository and install from it as follows:
$ git clone https://github.com/jmcnamara/XlsxWriter.git $ cd XlsxWriter $ sudo python setup.py install
If the installation went correctly you can create a small sample program like the following to verify that the module works correctly:
import xlsxwriter workbook = xlsxwriter.Workbook('hello.xlsx') worksheet = workbook.add_worksheet() worksheet.write('A1', 'Hello world') workbook.close()
Save this to a file called
hello.py and run it as follows:
$ python hello.py
This will output a file called
hello.xlsx which should look something like
If you downloaded a tarball or cloned the repo, as shown above, you should also have a directory called examples with some sample applications that demonstrate different features of XlsxWriter.
Once you are happy that the module is installed and operational you can have a look at the rest of the XlsxWriter documentation. Tutorial 1: Create a simple XLSX file is a good place to start.