note.py - Minimal Todo/Notes App Using GitHub Issues

note.py is a simple command-line tool that manages notes or todo items as GitHub issues in your private repository.

Each note is stored as a separate issue. Editing a note updates the issue body. Deleting a note closes the issue.

Basic Usage

note.py [n|e|d] [note name]

Setup

Set the environment variables NOTE_REPO and NOTE_TOKEN:

1. Create a private GitHub repository to store your notes.
2. Generate a GitHub Personal Access Token.
3. Add the following lines to your shell config (.bashrc, .zshrc, etc.), replacing the placeholders:

export NOTE_REPO="yourusername/reponame"
export NOTE_TOKEN="ghp_..."

4. Install the script:

git clone https://github.com/bojle/note.py
cd note.py
sudo cp note.py /usr/bin/

Example

Create a new note:

note.py n todo

Spaces in note names are supported:

note.py n "grocery shopping"

This opens your $EDITOR. After writing and saving, the note is pushed to GitHub as an issue.

Edit a note:

note.py e todo

Delete (close) a note:

note.py d todo

Additionally, if you use vim, add this snippet to your vimrc to update the issue when you ":w" on the file

augroup NotePush
  autocmd!
  autocmd BufWritePost *.note.md silent! !note.py push "%:t"
augroup END