notion-budgeter

Keeps a given Notion database up to date with transactions using Plaid.

docker-compose.yml

version: '3.7'
services:
  notion_budgeter:
    image: ghcr.io/ejach/notion-budgeter
    container_name: notion_budgeter
    environment:
      - plaid_access_token=<access_token> # optional
      - plaid_client_id=<client_id> # optional
      - plaid_secret=<secret> # optional
      - plaid_environment=<development OR sandbox> # optional, defaults to development
      - data_dir=<data_dir>
      - notion_secret=<notion_secret>
      - notion_db=<notion_db>
      - notion_custom_property=<custom_property> # optional
      - notion_icon=<notion_icon> # optional, default 🧾
      - teller_enabled=<True or False> # optional
      - teller_account_id=<teller_account_id> # optional
      - teller_access_token=<teller_access_token> # optional
      - teller_cert_path=<teller_cert_path> # optional
      - teller_key_path=<teller_key_path> # optional
      - excluded=<expense_name> # optional
    volumes:
      - /path/to/data:/path/to/data
    restart: unless-stopped

Variable	Description	Required
plaid_access_token	Token associated with financial account (see below)	❌
plaid_client_id	ID associated with a Plaid account	❌
plaid_secret	Key associated with environment	❌
plaid_environment	What Plaid environment should the program run in (development or sandbox)	❌
data_dir	Path to where the database file should be stored	✅
notion_secret	The secret token associated with your Notion integration	✅
notion_db	The database name that you want the data to be stored in (case-sensitive)	✅
notion_custom_property	Custom property in the format that Notion expects (see below)	❌
notion_icon	What icon should the expense have in Notion (Example: 💳)	❌
teller_enabled	Should the environemnt use Teller (True or False)	❌
teller_account_id	ID associated with your Teller account	❌
teller_access_token	Token associated with your Teller account	❌
teller_cert_path	Path to the Teller certificate .pem file	❌
teller_key_path	Path to the Teller key .pem file	❌
excluded	Expense name(s) that will not be written to Notion (Example: Walmart or Walmart,Amazon)	❌

Installation

Pre-requisites:

• Notion account
• A Notion Integration added to a desired database (see the Notion guide)
• Plaid account with a Development API Secret an account client_id, and an access_token from a connected financial account (see the Quickstart repository) or a Teller account with a connected financial account (see the Documentation)

NOTE: With Plaid, if you get a "Connectivity not supported" error when using the Quickstart repository to get an access_token, follow this guide.

---

Properties this program expects

'Expense' -> type: text
'Amount' -> type: number
'Date' -> type: date

You must format your Notion database to have these properties.

How to format Custom Properties

The program expects a Python-like dictionary:

{'Category': {'type': 'multi_select', 'multi_select': [{'name': '\u2754Uncategorized'}]}}

Or a list of Python-like dictionaries:

{'Category': {'type': 'multi_select', 'multi_select': [{'name': '\u2754Uncategorized'}]}, 
'Comment': {'type': 'rich_text', 'rich_text': [{'type': 'text', 'text': { 'content': 'Hello World' }}]}}

When adding these to your environment, they need to be encapsulated in quotes ""

More information on this format can be found here.

NOTE: Use a Python code beautifier like Code Beautify if you get stuck.