|
|
@@ -1,40 +1,49 @@
|
|
|
# Keep-Exporter
|
|
|
+[
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+](https://pypi.org/project/keep-exporter/)
|
|
|
+
|
|
|
A command line utility to export Google Keep notes to markdown files with metadata stored as a frontmatter header.
|
|
|
|
|
|
-Supports exporting:
|
|
|
- - Simple notes
|
|
|
- - List notes
|
|
|
- - Images and Drawings
|
|
|
- - Audio clips
|
|
|
- - Link annotations
|
|
|
+## Features
|
|
|
+
|
|
|
+ * Exports all note types (List and Note)
|
|
|
+ * Exports all media attached to notes
|
|
|
+ * Audio, drawings, attached images, etc
|
|
|
+ * Sync Keep to directory (keeps directory looking exactly the same as Google Keep)
|
|
|
+ * Customizable date format
|
|
|
+ * Easy ISO8601 via `--iso8601`
|
|
|
+ * Password or token based authentication
|
|
|
+ * Store your login token to config file with `keep_export savetoken`
|
|
|
+ * Note metadata header in yaml frontmatter format
|
|
|
+
|
|
|
|
|
|
## Usage
|
|
|
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]
|
|
|
+Usage: keep_export [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
+Options:
|
|
|
+ --config FILE Read configuration from FILE. [default: /home/nate/.config/keep-exporter]
|
|
|
+ -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]
|
|
|
+ --header / --no-header Choose to include or exclude the frontmatter header [default: header]
|
|
|
--delete-local / --no-delete-local
|
|
|
- Choose to delete or leave as-is any notes that exist locally but not in Google Keep
|
|
|
- [default: False]
|
|
|
-
|
|
|
+ Choose to delete or leave as-is any notes that exist locally but not in Google Keep [default: no-delete-local]
|
|
|
--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]
|
|
|
-
|
|
|
+ Choose to rename or leave as-is any notes that change titles in Google Keep [default: no-rename-local]
|
|
|
+ --date-format TEXT Date format to prefix the note filenames. Reflects the created date of the note. uses strftime() [default: %Y-%m-%d]
|
|
|
+ --iso8601 Format dates in ISO8601 format.
|
|
|
--skip-existing-media / --no-skip-existing-media
|
|
|
- Skip existing media if it appears unchanged from the local copy. [default: True]
|
|
|
+ Skip existing media if it appears unchanged from the local copy. [default: skip-existing-media]
|
|
|
-h, --help Show this message and exit.
|
|
|
+
|
|
|
+Commands:
|
|
|
+ savetoken Saves the master token to your configuration file.
|
|
|
```
|
|
|
|
|
|
### Notes
|
|
|
@@ -42,7 +51,7 @@ If you are using 2 Factor Authentication (2FA) for your google account, you will
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
-There are many ways to install this, easiest are through pip or the releases page.
|
|
|
+There are many ways to install this, easiest is through pip or the releases page.
|
|
|
|
|
|
### Pip
|
|
|
The easiest way is with [pip from PyPi](https://pypi.org/project/keep-exporter/)
|
Nathan Beals