obsidian-notion-sync 0.2

Sync Obsidian notes to Notion via GitHub

Obsidian Notion Sync

A tool to sync Obsidian notes to Notion via GitHub.

Installation

pip install obsidian-notion-sync

Usage

Configuration

Before using the tool, you need to set up the following environment variables:

Variable	Description	Example
GITHUB_TOKEN	Your GitHub personal access token	ghp_1234...
NOTION_TOKEN	Your Notion integration token	secret_5678...
OBSIDIAN_DIR	Path to your Obsidian vault	/Users/you/ObsidianVault
REPO_NAME	Name for the GitHub repository	My-Second-Brain
NOTION_DATABASE_ID	ID of your Notion database	abc123...

Setting up tokens

1. GitHub Token:

   • Go to GitHub Settings → Developer Settings → Personal Access Tokens
   • Create a new token with 'repo' permissions

2. Notion Token:

   • Go to www.notion.so/my-integrations
   • Create a new integration
   • Copy the integration token

3. Notion Database ID:

   • Create a new database in Notion
   • Copy the database ID from the URL (it's the part after the workspace name and before the '?')

Usage

Basic sync:

obsidian-notion-sync

Enable debug logging:

obsidian-notion-sync --debug

View help:

obsidian-notion-sync --help

Example Configuration Script

You can create a shell script to set up your environment:

#!/bin/bash
export GITHUB_TOKEN="your_github_token"
export NOTION_TOKEN="your_notion_token"
export OBSIDIAN_DIR="/path/to/your/obsidian/vault"
export REPO_NAME="your-repo-name"
export NOTION_DATABASE_ID="your_database_id"

obsidian-notion-sync --debug

Save this as run-sync.sh, make it executable (chmod +x run-sync.sh), and run it with ./run-sync.sh.

Troubleshooting

If you encounter errors:

1. Check that all environment variables are set correctly:

   echo $GITHUB_TOKEN
   echo $NOTION_TOKEN
   echo $OBSIDIAN_DIR
   echo $REPO_NAME
   echo $NOTION_DATABASE_ID
   

2. Ensure your Obsidian vault path exists and is accessible

3. Verify that your GitHub token has the necessary permissions

4. Check that your Notion integration is properly configured and has access to the database

Support

If you encounter any issues, please file them on our GitHub repository's issue tracker.

License

obisidian-notion-sync is distributed under the terms of the MIT license.

Directory structure:

# obsidian_notion_sync/
# ├── .github/
# │   └── workflows/
# │       └── publish.yml
# ├── src/
# │   └── obsidian_notion_sync/
# │       ├── __init__.py
# │       ├── cli.py
# │       ├── config.py
# │       ├── sync.py
# │       ├── github_manager.py
# │       ├── git_manager.py
# │       └── exceptions.py
# ├── tests/
# │   └── __init__.py
# ├── .gitignore
# ├── LICENSE
# ├── README.md
# ├── pyproject.toml
# └── setup.cfg