EasyXLS

How to export List to Excel in custom format in Python

EasyXLS Excel library can be used to export Excel files with Python on Windows, Linux, Mac or other operating systems. The integration vary depending on the operating system or if the bridge for .NET Framework of Java is chosen:

EasyXLS on Windows using .NET Framework with Python

If you opt for the .NET version of EasyXLS, the below code requires Pythonnet, a bridge between Python and .NET Framework.

Step 1: Download and install EasyXLS Excel Library for .NET

To download the trial version of EasyXLS Excel Library, press the below button:

Download EasyXLS™ Excel Library for .NET

If you already own a license key, you may login and download EasyXLS from your account.

Step 2: Install Pythonnet

For the installation you need to run "pip" command as it follows. Pip is a package-management system used to install and manage software packages written in Python.
<Python installation path>\Scripts>pip install "pythonnet.whl"

Step 3: Include EasyXLS library into project

EasyXLS.dll must be added to your project. EasyXLS.dll can be found after installing EasyXLS, in "Dot NET version" folder.

Step 4: Run Python code that exports list to Excel

Execute the following Python code that exports a list of data with formatting to Excel.

"""--------------------------------------------------------------------
Tutorial 02

This code sample shows how to export List to Excel file in Python.
The List contains data from a SQL database.
The cells are formatted using a user-defined format.
--------------------------------------------------------------------"""

import clr
import gc
import sqlite3

clr.AddReference('EasyXLS')
from EasyXLS import *
from EasyXLS.Util import *
from EasyXLS.Constants import *
from System.Drawing import *

print("Tutorial 02\n-----------\n")

# Create an instance of the class that exports Excel files
workbook = ExcelDocument()

# Create the database connection
conn = sqlite3.connect('chinook.db')

# Query the database
cursor = conn.execute("SELECT strftime('%m/%d/%Y', I.InvoiceDate), C.FirstName || ' ' || C.LastName, "
                      "I.BillingAddress, I.BillingCity, I.BillingState, I.BillingCountry, "
                      "I.Total FROM Invoices I INNER JOIN Customers C ON "
                      "I.CustomerId=C.CustomerId LIMIT 100")
rows = cursor.fetchall()

# Create the list that stores the query values
lstRows = List()

# Add the report header row to the list
lstHeaderRow = List()
lstHeaderRow.addElement("Invoice date")
lstHeaderRow.addElement("Customer name")
lstHeaderRow.addElement("Billing address")
lstHeaderRow.addElement("Billing city")
lstHeaderRow.addElement("Billing state")
lstHeaderRow.addElement("Billing country")	
lstHeaderRow.addElement("Total")	
lstRows.addElement(lstHeaderRow)

# Add the query values from the database to the list
for row in rows:
    RowList = List()
    RowList.addElement(row[0])
    RowList.addElement(row[1])	
    RowList.addElement(row[2])
    RowList.addElement(row[3])
    RowList.addElement(row[4])
    RowList.addElement(row[5])
    RowList.addElement(row[6])
    lstRows.addElement(RowList)

# Create an instance of the class used to format the cells in the report
xlsAutoFormat = ExcelAutoFormat()
        
# Set the formatting style of the header
xlsHeaderStyle = ExcelStyle(Color.LightGreen)
xlsHeaderStyle.setFontSize(12)
xlsAutoFormat.setHeaderRowStyle(xlsHeaderStyle)

# Set the formatting style of the cells (alternating style)
xlsEvenRowStripesStyle = ExcelStyle(Color.FloralWhite)
xlsEvenRowStripesStyle.setFormat("$0.00")
xlsEvenRowStripesStyle.setHorizontalAlignment(Alignment.ALIGNMENT_LEFT)
xlsAutoFormat.setEvenRowStripesStyle(xlsEvenRowStripesStyle)
xlsOddRowStripesStyle = ExcelStyle(Color.FromArgb(240, 247, 239))
xlsOddRowStripesStyle.setFormat("$0.00")
xlsOddRowStripesStyle.setHorizontalAlignment (Alignment.ALIGNMENT_LEFT)
xlsAutoFormat.setOddRowStripesStyle(xlsOddRowStripesStyle)
xlsLeftColumnStyle = ExcelStyle(Color.FloralWhite)
xlsLeftColumnStyle.setFormat("mm/dd/yyyy")
xlsLeftColumnStyle.setHorizontalAlignment (Alignment.ALIGNMENT_LEFT)
xlsAutoFormat.setLeftColumnStyle(xlsLeftColumnStyle)

# Export the Excel file
print("Writing file C:\\Samples\\Tutorial02 - export List to Excel with formatting.xlsx.")
workbook.easy_WriteXLSXFile_FromList(
         "c:\\Samples\\Tutorial02 - export List to Excel with formatting.xlsx", lstRows, xlsAutoFormat, "Sheet1")

# Confirm export of Excel file
sError = workbook.easy_getError()

if sError == "":
    print("\nFile successfully created.\n\n")
else:
    print("\nError encountered: " + sError + "\n\n")

# Close the database connection
cursor.close()
conn.close()

# Dispose memory
gc.collect()

EasyXLS on Linux, Mac, Windows using Java with Python

If you opt for the Java version of EasyXLS, a similar code as above requires Py4J, Pyjnius or any other bridge between Python and Java.

Step 1: Download and install EasyXLS Excel Library for Java

To download the trial version of EasyXLS Excel Library, press the below button:

Download EasyXLS™ Excel Library for Java

If you already own a license key, you may login and download EasyXLS from your account.

Step 2: Install Py4j

For the Py4j installation you need to run "pip" command as it follows. Pip is a package-management system used to install and manage software packages written in Python.
<Python installation path>\Scripts>pip install "py4j.whl"

Step 3: Create additional Java program

The following Java code needs to be running in the background prior to executing the Python code.

import py4j.GatewayServer;

public class GatewayServerApp {
  public static void main(String[] args) {
    GatewayServerApp app = new GatewayServerApp();
    // app is now the gateway.entry_point
    GatewayServer server = new GatewayServer(app);
    server.start();
  }
}


Step 4: Add py4j library to CLASSPATH

py4j.jar must be added to your classpath of the additional Java program. py4j.jar can be found after installing Py4j, in "<Python installation path>\share\py4j" folder.

Step 5: Add EasyXLS library to CLASSPATH

EasyXLS.jar must be added to your classpath of the additional Java program. EasyXLS.jar can be found after installing EasyXLS, in "Lib" folder.

Step 6: Run additional Java program

Start the gateway server application and it will implicitly start Java Virtual Machine as well.

Step 7: Run Python code that exports list to Excel

Execute a code as below Python code that exports a list of data with formatting to Excel.

"""---------------------------------------------------------------
Tutorial 02

This code sample shows how to export List to Excel file in Python.
The List contains data from a SQL database
The cells are formatted using a user-defined format.
---------------------------------------------------------------"""

import gc
import sqlite3

from py4j.java_gateway import JavaGateway
from py4j.java_gateway import java_import 
gateway = JavaGateway()

java_import(gateway.jvm,'EasyXLS.*')
java_import(gateway.jvm,'EasyXLS.Constants.*')
java_import(gateway.jvm,'EasyXLS.Util.*')
java_import(gateway.jvm,'java.awt.Color')

print("Tutorial 02\n-----------\n")

# Create an instance of the class that exports Excel files
workbook = gateway.jvm.ExcelDocument()

# Create the database connection
conn = sqlite3.connect('chinook.db')

# Query the database
cursor = conn.execute("SELECT strftime('%m/%d/%Y', I.InvoiceDate), C.FirstName || ' ' || C.LastName, "
                      "I.BillingAddress, I.BillingCity, I.BillingState, I.BillingCountry, "
                      "I.Total FROM Invoices I INNER JOIN Customers C ON "
                      "I.CustomerId=C.CustomerId LIMIT 100")
rows = cursor.fetchall()

# Create the list that stores the query values
lstRows = gateway.jvm.List()

# Add the report header row to the list
lstHeaderRow = gateway.jvm.List()
lstHeaderRow.addElement("Invoice date")
lstHeaderRow.addElement("Customer name")
lstHeaderRow.addElement("Billing address")
lstHeaderRow.addElement("Billing city")
lstHeaderRow.addElement("Billing state")
lstHeaderRow.addElement("Billing country")	
lstHeaderRow.addElement("Total")	
lstRows.addElement(lstHeaderRow)

# Add the query values from the database to the list
for row in rows:
    RowList = gateway.jvm.List()
    RowList.addElement(row[0])
    RowList.addElement(row[1])	
    RowList.addElement(row[2])
    RowList.addElement(row[3])
    RowList.addElement(row[4])
    RowList.addElement(row[5])
    RowList.addElement(row[6])
    lstRows.addElement(RowList)

# Create an instance of the class used to format the cells in the report
xlsAutoFormat = gateway.jvm.ExcelAutoFormat()
        
# Set the formatting style of the header
xlsHeaderStyle = gateway.jvm.ExcelStyle(gateway.jvm.Color(144, 238, 144))
xlsHeaderStyle.setFontSize(12)
xlsAutoFormat.setHeaderRowStyle(xlsHeaderStyle)

# Set the formatting style of the cells (alternating style)
xlsEvenRowStripesStyle = gateway.jvm.ExcelStyle(gateway.jvm.Color(255, 250, 240))
xlsEvenRowStripesStyle.setFormat("$0.00")
xlsEvenRowStripesStyle.setHorizontalAlignment(gateway.jvm.Alignment.ALIGNMENT_LEFT)
xlsAutoFormat.setEvenRowStripesStyle(xlsEvenRowStripesStyle)
xlsOddRowStripesStyle = gateway.jvm.ExcelStyle(gateway.jvm.Color(240, 247, 239))
xlsOddRowStripesStyle.setFormat("$0.00")
xlsOddRowStripesStyle.setHorizontalAlignment (gateway.jvm.Alignment.ALIGNMENT_LEFT)
xlsAutoFormat.setOddRowStripesStyle(xlsOddRowStripesStyle)
xlsLeftColumnStyle = gateway.jvm.ExcelStyle(gateway.jvm.Color(255, 250, 240))
xlsLeftColumnStyle.setFormat("mm/dd/yyyy")
xlsLeftColumnStyle.setHorizontalAlignment (gateway.jvm.Alignment.ALIGNMENT_LEFT)
xlsAutoFormat.setLeftColumnStyle(xlsLeftColumnStyle)

# Export the Excel file
print("Writing file C:\\Samples\\Tutorial02 - export List to Excel with formatting.xlsx.")
workbook.easy_WriteXLSXFile_FromList(
     "c:\\Samples\\Tutorial02 - export List to Excel with formatting.xlsx", lstRows, xlsAutoFormat, "Sheet1")

# Confirm export of Excel file
sError = workbook.easy_getError()

if sError == "":
    print("\nFile successfully created.\n")
else:
    print("\nError encountered: " + sError + "\n\n")

# Close the database connection
cursor.close()
conn.close()

# Dispose memory
gc.collect()

EasyXLS Excel libraries:

.NET
Excel Library for Python .NET
full .NET version to import, export or convert Excel files
Excel Writer for Python .NET
.NET version to create and export Excel files
-
Java
Excel Library for Python Java
full Java version to import, export or convert Excel files
Excel Writer for Python Java
Java version to create and export Excel files
Download EasyXLS™ Excel Library for Python

File formats:

MS Excel 97 - 2003
MS Excel 2007 - 2010
MS Excel 2013
MS Excel 2016
MS Excel 2019
XLSXXLSMXLSBXLS
XMLHTMLCSVTXT