<h1 style="font-size: 50px; text-align: center; margin: 0; padding: 0">PyNotion</h1>

<div style="text-align: center;">

<a href="https://pypi.org/project/pynotionclient/"><img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/pynotionclient?color=brightgreen&logo=pypi&style=for-the-badge"></a>

<a href="https://github.com/pythonhubdev/PyNotion/commits/main"><img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/pythonhubdev/PyNotion?style=for-the-badge"></a>

<a href="https://github.com/pythonhubdev/PyNotion/blob/main/LICENSE"><img alt="GitHub license" src="https://img.shields.io/github/license/pythonhubdev/PyNotion?color=brightgreen&style=for-the-badge"></a>

<a href="https://github.com/Quantivio/PyNotion/actions"><img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/quantivio/PyNotion/formatting.yaml?style=for-the-badge"></a>

<a href="https://black.readthedocs.io/en/stable/"><img alt="Code Style" src="https://img.shields.io/static/v1?label=CodeStyle&message=Black&color=%3CCOLOR%3E&style=for-the-badge"></a>

<a href="https://www.python.org/"><img alt="Static Badge" src="https://img.shields.io/badge/Python-Lang?style=for-the-badge&label=Made%20With%20%E2%9D%A4%EF%B8%8F"></a>

</div>

<p style="text-align: center;">

PyNotion is a simple and intuitive Python library for accessing the Notion API. With PyNotion, you can easily integrate and automate Notion tasks within your Python projects.

</p>

<p style="text-align: center;">

<strong>Please note that PyNotion is currently under development and may not yet be suitable for production use.</strong>

</p>

1. Querying a database using a dictionary

```python

from pynotionclient import PyNotion

from examples.config import base_config

from pynotionclient.schema.database import NotionDatabaseResponseSchema

py_notion_client = PyNotion(token=base_config.notion_secret_token)

# Create necessary properties as dictionary

filter_dict = {"page_size": 100, "filter": {"property": "Name", "rich_text": {"contains": "Home"}}}

response_dict_payload: NotionDatabaseResponseSchema = py_notion_client.database.query_database(

database_id=base_config.database_id, payload=filter_dict

)

```

2. Querying a database using a Pydantic model

```python

from pynotionclient import PyNotion

from examples.config import base_config

from pynotionclient.schema.database import RichTextFilter, PropertyFilter, Filter, NotionDatabaseResponseSchema

py_notion_client = PyNotion(token=base_config.notion_secret_token)

# Create necessary filter objects from Pydantic models and use them to query the database.

rich_text_filter = RichTextFilter(contains="Game")

property_filter = PropertyFilter(property="Name", rich_text=rich_text_filter)

filter_object = Filter(page_size=100, filter=property_filter)

response_filter_payload: NotionDatabaseResponseSchema = py_notion_client.database.query_database(

database_id=base_config.database_id, payload=filter_object)

```

#### Response for querying a database

> PyNotion client gives you the response as a Pydantic model. You can access the response as a dictionary or as a Pydantic model. The response is a NotionDatabaseResponseSchema model which has the following properties: https://developers.notion.com/reference/database

3. Creating a Database

```python

from dotenv import load_dotenv

from examples.config import base_config

from pynotionclient import PyNotion

from pynotionclient.schema.database import (

ParentConfiguration,

IconConfiguration,

TextConfiguration,

ExternalConfiguration,

CoverConfiguration,

SelectOptionsConfiguration,

SelectOptionsListConfig,

TitleConfiguration,

RichTextConfiguration,

CheckboxConfiguration,

SelectConfiguration,

ContentConfiguration,

MultiSelectConfiguration,

NumberConfiguration,

NumberFormats,

NumberFormatConfiguration,

DatabasePropertyConfiguration,

)

load_dotenv()

py_notion_client = PyNotion(token=base_config.notion_secret_token)

# # Create database payload

parent_payload = ParentConfiguration(

type="page_id", page_id=base_config.page_id

) # The parent is the page where the database will be created.

icon_payload = IconConfiguration(

type="emoji", emoji="🎮"

) # The icon is the icon that will be displayed on the database.

text = TextConfiguration(

content="Game"

) # The text is the text that will be displayed as the title of the database.

content = ContentConfiguration(

type="text", plain_text="Game", href="https://www.google.com", text=text

) # The content has other info's of the title.

# Cover schema

cover = CoverConfiguration(

type="external", external=ExternalConfiguration(url="https://www.google.com")

)

# # Forming select options schema

properties = {

"Name": TitleConfiguration().model_dump(),

"Description": RichTextConfiguration().model_dump(),

"In stock": CheckboxConfiguration().model_dump(),

"Food Group": SelectConfiguration(

select=SelectOptionsListConfig(

options=[

SelectOptionsConfiguration(color="green", name="Code"),

SelectOptionsConfiguration(color="red", name="Game"),

],

)

).model_dump(),

"Cusines": MultiSelectConfiguration(

multi_select=SelectOptionsListConfig(

options=[

SelectOptionsConfiguration(color="green", name="Code"),

SelectOptionsConfiguration(color="red", name="Game"),

],

)

).model_dump(),

"Price": NumberConfiguration(

number=NumberFormatConfiguration(

format=NumberFormats.NUMBER_WITH_COMMAS,

),

).model_dump(),

}

print(properties)

create_database_payload = DatabasePropertyConfiguration(

title=[content],

cover=cover,

parent=parent_payload,

icon=icon_payload,

properties=properties,

)

response = py_notion_client.database.create_database(

payload=create_database_payload,

)

print(response.json())

```

3. Install Poetry: `pip install poetry or pip3 install poetry`

3. If you encounter an error, run: `git config --global --unset-all core.hooksPath or git config --unset-all core.hooksPath`

We welcome contributions to PyNotion! Before making a major change, please open an issue to discuss your proposed changes. To submit a contribution, simply create a pull request.