Ready to get started?

Download a free trial of the OneNote Connector to get started:

 Download Now

Learn more:

Microsoft OneNote Icon OneNote Python Connector

Python Connector Libraries for Microsoft OneNote Data Connectivity. Integrate Microsoft OneNote with popular Python tools like Pandas, SQLAlchemy, Dash & petl.

Use SQLAlchemy ORMs to Access OneNote Data in Python

The CData Python Connector for OneNote enables you to create Python applications and scripts that use SQLAlchemy Object-Relational Mappings of OneNote data.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData Python Connector for OneNote and the SQLAlchemy toolkit, you can build OneNote-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to OneNote data to query, update, delete, and insert 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 CData Connector 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.

Follow the procedure below to install SQLAlchemy and start accessing OneNote through Python objects.

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit and SQLAlchemy ORM package:

pip install sqlalchemy pip install sqlalchemy.orm

Be sure to import the appropriate modules:

from sqlalchemy import create_engine, String, Column from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.orm import sessionmaker

Model OneNote Data in Python

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

NOTE: Users should URL encode the any connection string properties that include special characters. For more information, refer to the SQL Alchemy documentation.

engine = create_engine("onenote:///?OAuthClientId=MyApplicationId& OAuthClientSecret=MySecretKey& CallbackURL=http://localhost:33333&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Declare a Mapping Class for OneNote Data

After establishing the connection, declare a mapping class for the table you wish to model in the ORM (in this article, we will model the Notebooks table). Use the sqlalchemy.ext.declarative.declarative_base function and create a new class with some or all of the fields (columns) defined.

base = declarative_base() class Notebooks(base): __tablename__ = "Notebooks" Id = Column(String,primary_key=True) notebook_displayName = Column(String) ...

Query OneNote Data

With the mapping class prepared, you can use a session object to query the data source. After binding the Engine to the session, provide the mapping class to the session query method.

Using the query Method

engine = create_engine("onenote:///?OAuthClientId=MyApplicationId& OAuthClientSecret=MySecretKey& CallbackURL=http://localhost:33333&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt") factory = sessionmaker(bind=engine) session = factory() for instance in session.query(Notebooks).filter_by(Id="Jq74mCczmFXk1tC10GB"): print("Id: ", instance.Id) print("notebook_displayName: ", instance.notebook_displayName) print("---------")

Alternatively, you can use the execute method with the appropriate table object. The code below works with an active session.

Using the execute Method

Notebooks_table = Notebooks.metadata.tables["Notebooks"] for instance in session.execute( == "Jq74mCczmFXk1tC10GB")): print("Id: ", instance.Id) print("notebook_displayName: ", instance.notebook_displayName) print("---------")

For examples of more complex querying, including JOINs, aggregations, limits, and more, refer to the Help documentation for the extension.

Insert OneNote Data

To insert OneNote data, define an instance of the mapped class and add it to the active session. Call the commit function on the session to push all added instances to OneNote.

new_rec = Notebooks(Id="placeholder", Id="Jq74mCczmFXk1tC10GB") session.add(new_rec) session.commit()

Update OneNote Data

To update OneNote data, fetch the desired record(s) with a filter query. Then, modify the values of the fields and call the commit function on the session to push the modified record to OneNote.

updated_rec = session.query(Notebooks).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.Id = "Jq74mCczmFXk1tC10GB" session.commit()

Delete OneNote Data

To delete OneNote data, fetch the desired record(s) with a filter query. Then delete the record with the active session and call the commit function on the session to perform the delete operation on the provided records (rows).

deleted_rec = session.query(Notebooks).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()

Free Trial & More Information

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