A command line utility to export Google Keep notes to markdown files with metadata stored as a frontmatter header.
- Simple notes
- List notes
- Images and Drawings
- Audio clips
- Link annotations
If you do not supply a username or password before running it, you will be prompted to input them.
Usage: keep_export [OPTIONS] Options: --config FILE Read configuration from FILE. -u, --user TEXT Google account email (prompt if empty) [env var: GKEEP_USER; required] -p, --password TEXT Google account password (prompt if empty). Either this or token is required. [env var: GKEEP_PASSWORD] -t, --token TEXT Google account token from prior run. Either this or password is required. -d, --directory DIRECTORY Output directory for exported notes [default: ./gkeep-export] --header / --no-header Choose to include or exclude the frontmatter header [default: True] --delete-local / --no-delete-local Choose to delete or leave as-is any notes that exist locally but not in Google Keep [default: False] --rename-local / --no-rename-local Choose to rename or leave as-is any notes that change titles in Google Keep [default: False] --date-format TEXT Date format to use for the prefix of the note filenames. Reflects the created date of the note. [default: %Y-%m-%d] --skip-existing-media / --no-skip-existing-media Skip existing media if it appears unchanged from the local copy. [default: True] -h, --help Show this message and exit.
If you are using 2 Factor Authentication (2FA) for your google account, you will need to generate an app password for keep. You can do so on your Google account management page.
There are many ways to install this, easiest are through pip or the releases page.
The easiest way is with pip from PyPi
pip3 install keep-exporter
Download the Wheel
Download the wheel from the releases page and then install with pip:
pip install keep_exporter*.whl
Download or git clone
- Clone the repository
https://github.com/ndbeals/keep-exporteror download from the releases page and extract the source code.
cdinto the extracted directory
- With poetry installed, run
poetry installin the project root directory
poetry buildwill build the installable wheel
cd distthen run
Some users have had issues with the requests library detailed in this issue when using
pipx. The solution is to change the requests library version.
pipx install keep-exporter pipx inject keep-exporter requests===2.23.0