Ready to get started?

Learn more about the CData Python Connector for OneNote or download a free trial:

Download Now

Use Dash to Build to Web Apps on OneNote Data

The CData Python Connector for OneNote enables you to create Python applications that use pandas and Dash to build OneNote-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 OneNote, the pandas module, and the Dash framework, you can build OneNote-connected web applications for OneNote data. This article shows how to connect to OneNote with the CData Connector and use pandas and Dash to build a simple web app for visualizing OneNote data.

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

Connecting to OneNote Data

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

OneNote uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the Help documentation for more information.

After installing the CData OneNote Connector, follow the procedure below to install the other required modules and start accessing OneNote 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 OneNote Data 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.onenote as mod
import plotly.graph_objs as go

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

cnxn = mod.connect("OAuthClientId=MyApplicationId; OAuthClientSecret=MySecretKey; CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

Execute SQL to OneNote

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 Id, notebook_displayName FROM Notebooks WHERE Id = 'Jq74mCczmFXk1tC10GB'", 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-onenoteedataplot'

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 OneNote data and configure the app layout.

trace = go.Bar(x=df.Id, y=df.notebook_displayName, name='Id')

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='OneNote Notebooks 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 OneNote data.

python onenote-dash.py

Free Trial & More Information

Download a free, 30-day trial of the OneNote Python Connector to start building Python apps with connectivity to OneNote data. 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.onenote as mod
import plotly.graph_objs as go

cnxn = mod.connect("OAuthClientId=MyApplicationId; OAuthClientSecret=MySecretKey; CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

df = pd.read_sql("SELECT Id, notebook_displayName FROM Notebooks WHERE Id = 'Jq74mCczmFXk1tC10GB'", cnxn)
app_name = 'dash-onenotedataplot'

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.Id, y=df.notebook_displayName, name='Id')

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='OneNote Notebooks Data', barmode='stack')
		})
], className="container")

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