Skip to main content

Git-shaped sync between Notion database views and folders of markdown files

Project description

notion-sync

Git-shaped sync between Notion database views and local folders of markdown files. Notion is the source of truth; you decide when to pull and push.

Install

pip install n-commit

First call opens a browser for OAuth. Tokens cache at ~/.config/notion-sync/tokens/.

Onboarding

mkdir my-notion && cd my-notion
n-commit add interviews --view "https://www.notion.so/…?v=…"
# repeat for each binding; the first `add` creates notion-sync.toml + .gitignore

To use the same workspace on another machine: copy notion-sync.toml to a folder and run n-commit pull. (Git, scp, Dropbox — anything that moves a 1KB text file.)

Mental model

A workspace is a directory tree containing one notion-sync.toml manifest at its root and one subfolder per binding. Each binding mirrors one Notion database view.

~/my-notion/
├── notion-sync.toml          ← the manifest (committed)
├── .gitignore                ← ignores **/.notion/
├── interviews/
│   ├── _FIELDS.md            ← cheat sheet, regenerated on bind
│   ├── jane.md               ← row ↔ file
│   └── .notion/              ← cache (gitignored)
│       ├── schema.json
│       ├── fingerprints.json
│       └── mirror/jane.md    ← last-pulled bytes
└── crm/people/
    ├── _FIELDS.md
    ├── alice.md
    └── .notion/

Manifest:

[folders."interviews"]
view = "https://www.notion.so/…?v=…"

[folders."crm/people"]
view = "https://www.notion.so/…?v=…"

Workspace is found by walking up from cwd, like git finds .git/. One file describes every binding.

Verbs

add, remove, status, pull, push, restore. Run n-commit <verb> --help for the per-verb reference. API-call cost per verb:

Verb Reads remote Writes remote Writes local Default API calls
add yes (one-time) no yes 1 list_rows + 1 fetch_schema (+ N fetch_row if --init=push)
status only --remote no no 0 (or 1 list_rows per binding)
pull yes no yes (clean only) 1 list_rows per binding + N fetch_row (cache misses only)
push yes (drift check) yes yes (echo) 3/file (drift+update+echo); 2 with --force
restore no no yes 0

Conflict / drift playbook

  • pullConflictError (dirty file + remote also changed):
    • keep local: push <file> (will DriftError if remote also moved → --force)
    • take remote: restore <file> then re-pull
    • both diverged: open file, mirror at .notion/mirror/<rel>, hand-merge, push
  • pushDriftError (mirror diverged from current remote):
    • keep local: pull --force, re-merge, push. Or push --force.
    • take remote: restore <file>
  • status --remote surfaces conflicts early — cheapest place to catch them.

Layout

File Role
notion_sync/core.py The five primitives + CLI entrypoint. All filesystem IO.
notion_sync/manifest.py notion-sync.toml read/write/find. Pure, no Notion deps.
notion_sync/frontmatter.py Pure transforms: envelope parse, props ↔ YAML, body normalize, row fingerprint, slug.
notion_sync/client.py Typed Notion MCP wrapper.
notion_sync/auth.py Generic MCP OAuth (PKCE) with fcntl.flock to serialize refresh-token rotation.
notion_sync/mcp_client.py Generic MCP transport + dynamic tool proxy.

Invariants

  • fetch_row is the single source of truth for row bytes. Never mix list_rows props with envelope-fetch props in the same path — they disagree on edge keys.
  • Mirror is always updated on pull, even on conflict. Working files are only overwritten if clean (or --force). Conflicts surface loudly via ConflictError.
  • Canonicalization for hashing. normalize_body strips presigned-S3 query strings so attachment URLs don't cause drift. CRLF → LF. Trailing whitespace stripped. Triple-newlines collapsed.
  • Read-only types are stripped on push: created_time, last_edited_time, rollup, formula.
  • notion_id is always 32-char undashed hex. Normalize at boundaries via url_to_id.
  • Comments don't bump Last edited time. Use pull <file> (always fetches) when you want comments.
  • query-database-view caps at 100 rows. Larger views truncate silently — pull <file> is the escape hatch for the tail.
  • Empty list_rows is a no-op. Not "everything was deleted".
  • OAuth refresh tokens are single-use. FileTokenStorage uses fcntl.flock so concurrent sessions don't race.
  • create_row validates the parent. Rejected property bags silently produce orphan pages on Notion's side; create_row re-fetches and verifies the parent matches.

Practices

  • frontmatter.py and manifest.py are pure. No IO outside their declared file.
  • core.py's primitives take view_url as an argument; only the CLI reads the manifest.
  • No imports inside functions. Module top only.
  • Explicit over compact. Readable loops beat dense comprehensions.

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

n_commit-0.1.0.tar.gz (27.1 kB view details)

Uploaded Source

Built Distribution

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

n_commit-0.1.0-py3-none-any.whl (31.3 kB view details)

Uploaded Python 3

File details

Details for the file n_commit-0.1.0.tar.gz.

File metadata

  • Download URL: n_commit-0.1.0.tar.gz
  • Upload date:
  • Size: 27.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for n_commit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8b83b76a5bd539a36487962613e54ead9d8ecea1530097dde5c97889bae9d4a4
MD5 269e31b5f2822df551f0c66824bf1b12
BLAKE2b-256 2245979f58645680467fa8624f821633d96f337582142b9dfa9b4666bad82604

See more details on using hashes here.

File details

Details for the file n_commit-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: n_commit-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 31.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for n_commit-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 89002fdf8a8bf828333092ebe16ff355f10fa74ed46a5d5d745247473ff18c46
MD5 82eef9fe65ab25aabf0bd06393846115
BLAKE2b-256 ecc3c5a6382bbac6acd66a9749da6502e71d4f0d40b0a5abb475746aa0395682

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