How to Visualize CircleCI Data in Python with pandas

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

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

Connecting to CircleCI Data

Connecting to CircleCI 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.

Using API Key Authentication

CircleCI uses personal API tokens to authenticate API requests. To generate a personal API token, log in to your CircleCI account, navigate to User Settings > Personal API Tokens, and click Create New Token. Copy the token value immediately as it is only shown once.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your CircleCI personal API token.

Example connection string:

Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';

Follow the procedure below to install the required modules and start accessing CircleCI 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 CircleCI Data in Python

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

engine = create_engine("api:///?Profile=C:\profiles\CircleCI.apip&AuthScheme=APIKey&ProfileSettings='APIKey=your_personal_api_token'")

Execute SQL to CircleCI

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

df = pandas.read_sql("SELECT ,  FROM Artifacts WHERE ProjectSlug = 'github/MyOrg/my-repo'", engine)

Visualize CircleCI Data

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

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

Free Trial & More Information

Download a free, 30-day trial of the CData API Driver for Python to start building Python apps and scripts with connectivity to CircleCI 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("api:///?Profile=C:\profiles\CircleCI.apip&AuthScheme=APIKey&ProfileSettings='APIKey=your_personal_api_token'")
df = pandas.read_sql("SELECT ,  FROM Artifacts WHERE ProjectSlug = 'github/MyOrg/my-repo'", engine)

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