ultimate-notion 0.1

Ultimate Notion is the ultimate Python library for Notion 🚀 It allows you to access and modify your Notion databases and pages in the most convenient and pythonic way.

CI/CD
Package
Details

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]

Usage

import ultimate_notion as uno

TOKEN = "secret_YOUR_TOKEN_HERE"
# Change PAGE_TITLE to the title of your page
PAGE_TITLE = "Getting Started"

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

# Alternatively, without a context manager:
notion = uno.Session.get_or_create(auth=TOKEN)
# `auth` can be omitted if `NOTION_TOKEN` is set in the environment, i.e.
# notion = uno.Session.get_or_create()
# which also works for the context manager
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. The documentation is made with Material for MkDocs and is hosted on GitHub Pages.

Contributing

After having cloned this repository:

1. make sure hatch in installed globally, e.g. pipx install hatch,
2. make sure pre-commit is installed globally, e.g. with pipx install pre-commit,
3. optionally run hatch config set dirs.env.virtual .direnv to let VS Code find your virtual environments,

and then you are already set up to start hacking. Use hatch run cov or hatch run no-cov to run the unitest with or without coverage reports, respectively. Check out the environment setup of hatch in pyproject.toml for many more commands.

If you are using VS Code, then it's quite convenient to add a file .env in your checkout with:

[pytest]
env =
    NOTION_AUTH_TOKEN=secret_YOUR_TOKEN_TO_YOUR_TEST_NOTION_ACCOUNT

Check out this page about contributing for more details.

License & Credits

Ultimate Notion is distributed under the terms of the MIT license. To start this project off a lot of inspiration and code was taken from hatch and notional. Ultimate Notion highly depends on notion-sdk-py.