Use pandas to Visualize X-Cart Data in Python

Ready to get started?

Download for a free trial:

Download Now

Learn more:

X-Cart Python Connector

Python Connector Libraries for X-Cart Data Connectivity. Integrate X-Cart with popular Python tools like Pandas, SQLAlchemy, Dash & petl.



The CData Python Connector for X-Cart enables you use pandas and other modules to analyze and visualize live X-Cart data in Python.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Python Connector for X-Cart, the pandas & Matplotlib modules, and the SQLAlchemy toolkit, you can build X-Cart-connected Python applications and scripts for visualizing X-Cart data. This article shows how to use the pandas, SQLAlchemy, and Matplotlib built-in functions to connect to X-Cart data, execute queries, and visualize the results.

With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live X-Cart data in Python. When you issue complex SQL queries from X-Cart, the driver pushes supported SQL operations, like filters and aggregations, directly to X-Cart and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to X-Cart Data

Connecting to X-Cart data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

An API Key must be created for your XCart Installation. In order to obtain the API Key, you need to install and configure the REST API Module for your X-Cart installation.

  • Login to your X-Cart Installation. Click on My addons on the bottom of the left side-bar navigation panel.
  • Search for REST API Module. Install the Module.
  • After the module has been installed, you need to set it up.
    • Go to the Settings section for the REST API Module.
    • On the settings page specify the API Key (only read)
  • Set the ApiKey and Url to the connection property to connect to data.

Follow the procedure below to install the required modules and start accessing X-Cart through Python objects.

Install Required Modules

Use the pip utility to install the pandas & Matplotlib modules and the SQLAlchemy toolkit:

pip install pandas
pip install matplotlib
pip install sqlalchemy

Be sure to import the module with the following:

import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engine

Visualize X-Cart Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with X-Cart data.

engine = create_engine("xcart:///?Url=https://example.com/shop&ApiKey=MyApiKey")

Execute SQL to X-Cart

Use the read_sql function from pandas to execute any SQL statement and store the resultset in a DataFrame.

df = pandas.read_sql("SELECT ProfileId, FirstName FROM PROFILES WHERE Language = 'en'", engine)

Visualize X-Cart Data

With the query results stored in a DataFrame, use the plot function to build a chart to display the X-Cart data. The show method displays the chart in a new window.

df.plot(kind="bar", x="ProfileId", y="FirstName")
plt.show()

Free Trial & More Information

Download a free, 30-day trial of the X-Cart Python Connector to start building Python apps and scripts with connectivity to X-Cart data. Reach out to our Support Team if you have any questions.



Full Source Code

import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engin

engine = create_engine("xcart:///?Url=https://example.com/shop&ApiKey=MyApiKey")
df = pandas.read_sql("SELECT ProfileId, FirstName FROM PROFILES WHERE Language = 'en'", engine)

df.plot(kind="bar", x="ProfileId", y="FirstName")
plt.show()