https://gitlab.com/guilhermigg/notyon

An unnoficial Notion SDK for Python.
https://gitlab.com/guilhermigg/notyon

Notion API notion python python3

Last synced: 3 days ago
JSON representation

An unnoficial Notion SDK for Python.

• Host: gitlab.com
• URL: https://gitlab.com/guilhermigg/notyon
• Owner: guilhermigg
• License: mit
• Created: 2022-02-19T03:47:03.004Z (almost 3 years ago)
• Default Branch: main
• Last Synced: 2024-04-24T13:11:02.796Z (9 months ago)
• Topics: Notion API, notion, python, python3
• Stars: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Notyon

![PyPI - Status](https://img.shields.io/pypi/status/notyon?color=orange&style=flat-square)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/Notyon?color=yellow&logo=python&logoColor=yellow&style=flat-square)

![PyPI - Downloads](https://img.shields.io/pypi/dm/notyon?style=flat-square)

![PyPI](https://img.shields.io/pypi/v/notyon?label=version&logo=notion&logoColor=orange&style=flat-square)

![PyPI - License](https://img.shields.io/pypi/l/notyon?style=flat-square)

## Notion SDK for Python

![Notyon Logo](images/logo-notyon.png)

Notyon is an open source Python package that implements the [Notion API](https://developers.notion.com/reference/intro) in Python.

## Installation

Run the following command to install:

`pip install notyon`

## How to get your Notion auth token

Follow this tutorial: [Get your Notion auth token](docs/get_notion_token.md)

## Basic Example

```python

import notyon as Notion # Import Notyon

# Create an notion client instance

client = Notion.client("auth_token")

# Find a Database

# If found: Returns a Database instance

# If not found: Returns None

found_database = Notion.Database.find(client, "Database name")

# Get database info

db_title = found_database.title

db_id = found_database.id

# Retrieve database content

content = found_database.retrieve()

## Create a database

# If created: Returns a Database instance

# If didn't create: Returns None

# First, get the page_id (parent)[

page_id = "page-id-example"

# Second, create the model

model = Notion.Model("Database title")

model.add([

    #{"field name": "field type"}

    {"name": "text"},

    {"description": "rich_text"}

])

created_database = Notion.Database.create(client, page_id, model)

```

## Roadmap 🗺️

- 🗃️ Database 1 (v0.1)

    - [x] Retrieve

    - [x] Create

- 🗃️ Database 2 (v0.2)

    - [ ] Update

    - [ ] Query

- 📄 Pages 1 (v0.3)

    - [ ] Retrieve

    - [ ] Create

    - [ ] Delete

- 📄 Pages 2 (v0.4)

    - [ ] Update

    - [ ] Query

- 🔳 Blocks 1 (v0.5)

    - [ ] Retrieve

    - [ ] Create

- 🔳 Blocks 2 (v0.6)

    - [ ] Update

    - [ ] Query

- 👤 Users (v0.7)

    - [ ] Retrieve an user

    - [ ] List

- 🔍️ Search (v0.8)

    - [ ] Query pages

- 🖇️ [Retrieve a page property item](https://developers.notion.com/reference/retrieve-a-page-property) (0.9)

- 🔑 [Retrieve your token's bot user](https://developers.notion.com/reference/get-self) (1.0)