notion-df 0.0.3

Notion-DF: Seamlessly Connecting Notion Database with Pandas DataFrame

notion-df: Seamlessly Connecting Notion Database with Pandas DataFrame

Please Note: This project is currently in pre-alpha stage. The code are not appropriately documented and tested. Please report any issues you find.

Installation

pip install notion-df

Usage

• Before starting, please follow the instructions to create a new integration and add it to your Notion page or database.

  • We'll refer Internal Integration Token as the api_key below.

• Pandas-flavored APIs: Just need to add two additional lines of code:

  import notion_df
  notion_df.pandas() #That's it!
  
  import pandas as pd
  df = pd.read_notion(page_url, api_key=api_key)
  df.to_notion(page_url)
  

• Download your Notion table as a pandas DataFrame

  import notion_df
  df = notion_df.download(notion_database_url, api_key=api_key)
  # Equivalent to: df = pd.read_notion(notion_database_url, api_key=api_key)
  df.head()
  

  Only downloading the first `nrows` from a database

  df = notion_df.download(notion_database_url, nrows=nrows) #e.g., 10
  

• Append a local df to a Notion database:

  import notion_df
  notion_df.upload(df, notion_database_url, title="page-title", api_key=api_key)
  # Equivalent to: df.to_notion(notion_database_url, title="page-title", api_key=api_key)
  

• Upload a local df to a newly created database in a Notion page:

  import notion_df
  notion_df.upload(df, notion_page_url, title="page-title", api_key=api_key)
  # Equivalent to: df.to_notion(notion_page_url, title="page-title", api_key=api_key)
  

• Tired of typing api_key=api_key each time?

  import notion_df
  notion_df.config(api_key=api_key) # Or set an environment variable `NOTION_API_KEY`
  df = notion_df.download(notion_database_url)
  notion_df.upload(df, notion_page_url, title="page-title")
  # Similarly in pandas APIs: df.to_notion(notion_page_url, title="page-title")
  

TODOs

• Add tests for
  • load
  • upload
  • values.py
  • configs.py
  • base.py
• Better class organizations/namings for *Configs and *Values