Ready to get started?

Learn more about the or download a free trial:

Download Now

Use Dash to Build to Web Apps on PowerShell Scripts

The CData Python Connector for PowerShell enables you to create Python applications that use pandas and Dash to build PowerShell-connected web apps.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Python Connector for PowerShell, the pandas module, and the Dash framework, you can build PowerShell-connected web applications for PowerShell scripts. This article shows how to connect to PowerShell with the CData Connector and use pandas and Dash to build a simple web app for visualizing PowerShell scripts.

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

Connecting to PowerShell Scripts

Connecting to PowerShell scripts 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.

The ScriptLocation, under the Data section, must be set to a valid script location.

After installing the CData PowerShell Connector, follow the procedure below to install the other required modules and start accessing PowerShell through Python objects.

Install Required Modules

Use the pip utility to install the required modules and frameworks:

pip install pandas
pip install dash
pip install dash-daq

Visualize PowerShell Scripts in Python

Once the required modules and frameworks are installed, we are ready to build our web app. Code snippets follow, but the full source code is available at the end of the article.

First, be sure to import the modules (including the CData Connector) with the following:

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.powershell as mod
import plotly.graph_objs as go

You can now connect with a connection string. Use the connect function for the CData PowerShell Connector to create a connection for working with PowerShell scripts.

cnxn = mod.connect("ScriptLocation='%Public%\Documents\CData PowerShell Scripts';ExecuteQuery=True;")

Execute SQL to PowerShell

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

df = pd.read_sql("SELECT ProcessName, CPU FROM Process WHERE ProcessName = 'RemoteConnectorService'", cnxn)

Configure the Web App

With the query results stored in a DataFrame, we can begin configuring the web app, assigning a name, stylesheet, and title.

app_name = 'dash-powershelledataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'

Configure the Layout

The next step is to create a bar graph based on our PowerShell scripts and configure the app layout.

trace = go.Bar(x=df.ProcessName, y=df.CPU, name='ProcessName')

app.layout = html.Div(children=[html.H1("CData Extension + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(title='PowerShell Process Data', barmode='stack')
		})
], className="container")

Set the App to Run

With the connection, app, and layout configured, we are ready to run the app. The last lines of Python code follow.

if __name__ == '__main__':
    app.run_server(debug=True)

Now, use Python to run the web app and a browser to view the PowerShell scripts.

python powershell-dash.py

Free Trial & More Information

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



Full Source Code

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.powershell as mod
import plotly.graph_objs as go

cnxn = mod.connect("ScriptLocation='%Public%\Documents\CData PowerShell Scripts';ExecuteQuery=True;")

df = pd.read_sql("SELECT ProcessName, CPU FROM Process WHERE ProcessName = 'RemoteConnectorService'", cnxn)
app_name = 'dash-powershelldataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'
trace = go.Bar(x=df.ProcessName, y=df.CPU, name='ProcessName')

app.layout = html.Div(children=[html.H1("CData Extension + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(title='PowerShell Process Data', barmode='stack')
		})
], className="container")

if __name__ == '__main__':
    app.run_server(debug=True)