Skip to main content

A powerful object-oriented Python library for easy interaction with Notion.so databases

Project description

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)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

notion_toolkit-0.1.2.tar.gz (28.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

notion_toolkit-0.1.2-py3-none-any.whl (28.6 kB view details)

Uploaded Python 3

File details

Details for the file notion_toolkit-0.1.2.tar.gz.

File metadata

  • Download URL: notion_toolkit-0.1.2.tar.gz
  • Upload date:
  • Size: 28.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.9.12 Darwin/21.3.0

File hashes

Hashes for notion_toolkit-0.1.2.tar.gz
Algorithm Hash digest
SHA256 174efce5b179826ff24e9ae4fdd2be7c749086761f2a22bb18d5128ed06a7089
MD5 691fca9b7105882748d874e84af5a8be
BLAKE2b-256 fa9b24c6d1cd7723e4fed6eee1a2851e8f43c4deb667b99e6889adc443a84ccb

See more details on using hashes here.

File details

Details for the file notion_toolkit-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: notion_toolkit-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 28.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.9.12 Darwin/21.3.0

File hashes

Hashes for notion_toolkit-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5081d40560e34d1983973066e79656209e2afa636f09fb2193c589ab9bd0844e
MD5 2862c76e00b99ac521881cecab75ea0b
BLAKE2b-256 2d92a9882885b2d2a422636da7a9ffba0bc45a2bc9d8a5f59f5c2f17709d196f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page