basic-notion 0.0.4

Client-agnostic model wrapper for Notion API

basic-notion

Client-agnostic model wrapper for Notion API.

This library does not do any interaction over the network itself, so it can be used with any existing client that exposes as output and accepts as input raw JSONable data.

Note that this project is at its infancy stage, so major changes in its structure and API are quite possible and even probable in the near future.

Installation

Just like any other python package out there, it can be installed via pip:

pip install basic-notion

Basic Examples

Describing Models

from basic_notion.base import NotionPage, NotionPageList
from basic_notion.field import SelectField, TitleField 


class ReadingListItem(NotionPage):
    type: SelectField = SelectField(property_name='Type')
    name: TitleField = TitleField(property_name='Name')


class ReadingList(NotionPageList[ReadingListItem]):
    _ITEM_CLS = ReadingListItem

Using With notion-sdk-py

import asyncio
import os

from notion_client import AsyncClient
from basic_notion.query import Query

from models import ReadingList


async def get_reading_list() -> ReadingList:
    database_id = os.environ.get('DATABASE_ID')
    notion_token = os.environ.get('NOTION_TOKEN')
    notion = AsyncClient(auth=notion_token)
    data = await notion.databases.query(
        **Query.database(
            database_id
        ).filter(
            # Construct filter using model's field
            # (only one filter expression is supported)
            ReadingList.item.type.filter.equals('Book')
        ).sorts(
            # And, similarly, the result's sorting
            # (multiple fields can be listed here)
            ReadingList.item.name.sort.ascending
        ).serialize()
    )
    return ReadingList(data=data)


def print_reading_list(reading_list: ReadingList) -> None:
    for item in reading_list.items():
        print(f'[{item.type.name}] {item.name.one_item.content}')


async def main() -> None:
    reading_list = await get_reading_list()
    print_reading_list(reading_list)


asyncio.run(main())

(assuming you put the previous code in models.py)

See notion-sdk-py's homepage for more info on the client: https://github.com/ramnes/notion-sdk-py

Links

Homepage on GitHub: https://github.com/altvod/basic-notion

Project's page on PyPi: https://pypi.org/project/basic-notion/

Notion API: https://developers.notion.com/