Skip to content

jheddings/notional

Repository files navigation

notional

PyPI LICENSE Style

⚠️ Discontinued: I have moved away from Notion to Obsidian and will no longer update this project. If someone is interested in taking it over, please reach out. A great place to start is to complete the Pydantic v2 PR that is open.

A high level interface and object model for the Notion SDK. This is loosely modeled after concepts found in SQLAlchemy and MongoEngine. Built on the excellent notion-sdk-py library, this module provides higher-level access to the API.

That being said, if you do use this library, please drop me a message!

Installation

Install the most recent release using PyPi:

pip install notional

Note: it is recommended to use a virtual environment (venv) for installing libraries to prevent conflicting dependency versions.

Usage

Connect to the API using an integration token or an OAuth access token:

import notional

notion = notional.connect(auth=AUTH_TOKEN)

# ¡¡ fun & profit !!

Getting Help

If you are stuck, the best place to start is the Discussion area. Use this also as a resource for asking questions or providing general suggestions.

Known Issues

See Issues on github.

Feature Requests

See Issues on github.

Contributing

I built this module so that I could interact with Notion in a way that made sense to me. Hopefully, others will find it useful. If someone is particularly passionate about this area, I would be happy to consider other maintainers or contributors.

Any pull requests or other submissions are welcome. As most open source projects go, this is a side project. Large submissions will take time to review for acceptance, so breaking them into smaller pieces is always preferred. Thanks in advance!

To get started, please read the full contribution guide.