Skip to content

Latest commit

 

History

History
157 lines (116 loc) · 6.51 KB

README.md

File metadata and controls

157 lines (116 loc) · 6.51 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Notion-DB

Notion-DB is a powerful object-oriented client for the Notion API that allows you to easily access and work with notion Databases. Learn how to use it and create your own Notion integrations in minutes!
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. License
  5. Contact

About The Project

Notion-DB is a powerful object-oriented client for the Notion API that allows you to easily access and work with notion Databases. Learn how to use it and create your own Notion integrations in minutes!

(back to top)

Getting Started

This is an example on how to get started with using the API client. To see more specific uses please refer to the Documentation. Also refer to the Notion API documentation for more information on the API itself.

Installation

  1. Install the package using pip

    pip install notion-toolkit

  2. Get an API key at https://www.notion.so/my-integrations

Example Usage

Adding a row to an existing database

Update Notion database properties with custom Schema objects

(back to top)

Package Overview

The main classes are: Connector, Database, Row, and Schema

  • Connector objects are used to connect to the Notion API and work with the API.

  • Schema objects are used to create new databases and rows. They are also used to update existing databases and rows. Schema objects only contain the structure of the database or row, not the data.

  • Row objects contain values, and work with existing rows and create new ones. They are similar to Pandas series,

  • Database objects are used to work with existing databases and create new ones, as a collection of rows.

Schema and Row objects contain Properties

Property Values make up each entry in a Row object, and they contain values and properties for a row cell. The client supports all property types that are supported by the Notion API and makes it easy to automatically parse Python types.

Schema Properties are used to create new databases and rows, or to validate row objects. They do not hold any values, but hold attributes about the column type in the database, such as the name, and format. The client supports all property types that are supported by the Notion API.

For more examples, please refer to the Documentation

(back to top)

Contributing

Please feel free to contribute in any way!

License

Distributed under the GNU 3 License.

(back to top)

Contact

Matt Prodani - mattp@nyu.edu

Repository Link: https://github.com/mattprodani/notion-db

(back to top)