Skip to content

notebooks

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

notebooks

README.md

Kotlin Notion Client - Interactive Notebooks

Interactive Jupyter notebooks for exploring the Kotlin Notion Client library. These provide hands-on examples and serve as an alternative way to understand and test the library's capabilities.

Setup

Environment Variables

Set these before running the notebooks:

export NOTION_API_TOKEN="secret_your_token_here"
export NOTION_TEST_PAGE_ID="12345678-1234-1234-1234-123456789abc"
export NOTION_TEST_DATABASE_ID="87654321-4321-4321-4321-cba987654321"

Notion Integration Setup

  1. Create an integration at https://www.notion.so/my-integrations
  2. Copy the "Internal Integration Token"
  3. Create test page(s) and database(s) in your Notion workspace
  4. Share them with your integration (Share → Invite → select your integration)

Notebooks

01-getting-started.ipynb

Introduction to the library: authentication, retrieving pages, basic error handling.

Prerequisites: NOTION_API_TOKEN, NOTION_TEST_PAGE_ID

02-reading-databases.ipynb

Working with databases and data sources: querying, filtering, sorting.

Prerequisites: NOTION_API_TOKEN, NOTION_TEST_DATABASE_ID

03-creating-pages.ipynb

Creating pages programmatically with various property types using the DSL.

Prerequisites: NOTION_API_TOKEN, NOTION_TEST_DATABASE_ID

04-working-with-blocks.ipynb

Building page content: block hierarchy, nesting, different block types.

Prerequisites: NOTION_API_TOKEN, NOTION_TEST_PAGE_ID

05-rich-text-dsl.ipynb

Text formatting with the Rich Text DSL: annotations, links, mentions, equations.

Prerequisites: NOTION_API_TOKEN, NOTION_TEST_PAGE_ID

06-advanced-queries.ipynb

Advanced querying: complex nested filters, multiple sorts, pagination.

Prerequisites: NOTION_API_TOKEN, NOTION_TEST_DATABASE_ID

07-file-uploads.ipynb

Uploading files, external imports, media blocks.

Prerequisites: NOTION_API_TOKEN, NOTION_TEST_PAGE_ID

08-whats-new-in-v0.4.ipynb

Tour of all breaking changes and new features in v0.4.0: trash API, Markdown Content API, Views API, new block types, native icons, relative date filters, and more.

Prerequisites: NOTION_API_TOKEN, NOTION_TEST_PAGE_ID, NOTION_TEST_DATABASE_ID

Notes

  • All notebooks use v0.4.1 and runBlocking { } to wrap suspend functions
  • Notebooks are designed to be modified and experimented with
  • Use a test workspace, not your production Notion workspace
  • Run each cell in order; set the required environment variables before starting

Resources