ultimate-notion 0.9.6

The ultimate Python client for Notion!

Ultimate Notion is the ultimate Python client for Notion!

CI/CD
Package
Details

✨ Features

• 🐍 Pythonic API — Clean, intuitive Python interfaces with robust type annotations.
• 🗂️ CRUD operations — Create, read, update, and delete Notion pages, databases, and blocks.
• 🔎 Rich querying capabilities — Support for filters, sorting, pagination, and searching.
• 🪄 Flexible exports — Convert Notion pages to Markdown, HTML, and databases to pandas, Polars.
• ⬆️ File upload support — Easily upload and manage files in Notion pages and databases.
• 🧩 Built atop notion-sdk-py — Enhancing the functionality of the popular low-level client.
• 💯 100% feature parity — Full compatibility with all notion-sdk-py capabilities and more.
• 🖥️ Command line interface — Convenient CLI for quick operations and automation scripts.
• 🔒 Token-based authentication — Secure access using Notion integration tokens.
• 🚀 One-step setup — Getting up to speed with a simple setup guide.
• 📜 MIT licensed — Released under the permissive MIT license for maximum flexibility.

👉 Want to learn more? Explore the full feature breakdown.

📦 Installation

Install the most recent release using PyPI with:

pip install ultimate-notion

or to install all additional dependencies, use:

pip install 'ultimate-notion[all]'

🧪 Installing the Development Version

To install the latest (potentially unstable) version directly from the main branch on GitHub:

pip install git+https://github.com/ultimate-notion/ultimate-notion.git@main

or with all optional dependencies:

pip install 'ultimate-notion[all] @ git+https://github.com/ultimate-notion/ultimate-notion.git@main'

🚀 Usage

Make sure you have set the environment variable NOTION_TOKEN to your Notion integration token. Then it's as simple as:

import ultimate_notion as uno

PAGE_TITLE = 'Getting Started'

with uno.Session() as notion:
    page = notion.search_page(PAGE_TITLE).item()
    page.show()

# Alternatively, without a context manager:
notion = uno.Session()
page = notion.search_page(PAGE_TITLE).item()
page.show()
notion.close()

Check out the official Ultimate Notion documentation for more details. Especially the page about creating a Notion integration to get the token.

💬 Getting help

If you are stuck with a problem and need help or just want to brag about what you did, the Discussion area is the right place for you. Here, you can ask questions, provide suggesions and discuss with other users.

🤝 Contributing

After having cloned this repository:

1. make sure hatch is installed globally, e.g. pipx install hatch,
2. make sure pre-commit is installed globally, e.g. with pipx install pre-commit,

and then you are already set up to start hacking. Use hatch run test to run the unit tests or hatch run vcr-only to run the offline unit tests using VCR.py. Regenerate the cassettes with hatch run vcr-rewrite. Check out the environment setup of hatch in pyproject.toml for many more commands.

If you are using VS Code, it's quite convenient to create a file .vscode/.env with

NOTION_TOKEN=TOKEN_TO_YOUR_TEST_NOTION_ACCOUNT
ULTIMATE_NOTION_CONFIG=/path/to/repo/.ultimate-notion/config.toml

Check out this page about contributing for more details.

📄 License & Credits

Ultimate Notion is released under the terms of the MIT license. It is built on top of notion-sdk-py and was initially inspired by notional, with the overall project structure adapted from hatch. Documentation is created using Material for MkDocs and hosted on GitHub Pages.