Merge branch 'release/0.6.5' into main

New release 0.6.5

CHANGELOG.md

@@ -0,0 +1,56 @@
+# Changelog
+
+## 0.6.5 Release (10/30/2024)
+- Added support for the *Markdown for Google Keep* plugin - ignore of any pre-existing markdown web links in notes and Keep note-to-note linking relative urls  
+- Added `-w` option to convert pre-existing Keep note-to-note markdown links to wikilinks during export  
+- Filter exported notes by create (`-cd`) or edit date (`-ed`) ( < or > date only)  
+- Fixed exported notes update date bug to be the actual edited date vs. internal Google update date  
+- Added warning on importing too many markdown notes may lock user out of Keep  
+- Added EXAMPLES.md for command line examples using option switches  
+- Added ability to export namespaces with '/' character in filenames for Logseq and Joplin  
+- Removed old python formatting yapf settings  
+
+## 0.6.3|0.6.4 Release (9/16/2024)
+- Fixed the Dockerfile versions    
+
+## 0.6.2 Release (9/15/2024)
+- Fixed the keep.resume warning message for newer gkeepapi version >= 0.16.0  
+- Fixed the Python 3.12+ regular expression error  
+- Added more detail error message if KIM fails to execute  
+
+## 0.6.1 Release (5/26/2024)
+- New instructions and Dockerfile for updated versions of gkeepapi and gpsoauth to get keep token  
+- Wikilinking now supported for Joplin notes  
+
+## 0.6.0 Release (1/28/2024)
+- Now requires Python v-3.10+ to run KIM  
+- New Docker image to get the Keep token  
+- Old keep-test.py module removed for new Google authentication (get_token.py added)  
+- New simple INSTALL.md steps
+
+## 0.5.4 Release (1/14/2024)
+- Docker image altered to use Ubuntu:22.04 to fix Google auth issues with gkeepapi  
+- Added new flag -m to move exported images to Archive folder  
+- Removed python deprecated imghdr library with pillow module  
+
+## 0.5.3 Release (11/5/2023)
+- Docker image creation and use  
+- Removed captcha note in keep-test.py  
+
+## 0.5.2 Release (7/12/2023)
+- Switched audio file extensions from AAC back to M4A  
+- Added Joplin exports -j flag to use front matter header  
+- Removed first dash on list notes exported to Logseq with -l switch  
+
+## 0.5.1 Release (6/28/2023)
+- Fixed image overwrite if note has no title or text and using -c switch  
+- Fixed error of markdown note imports if there are special characters within  
+- Added create and update dates of markdown files to imported notes  
+
+## 0.5.0 Release (2/4/2023)
+This update is a major refactor of the previous versions. Updates include:  
+- Faster export  
+- Added Logseq switch to add bullets to exported Keep notes  
+- Added simple import option to upload markdown files back to Keep  
+- Removed microseconds from note create and update dates  
+- Fixed null image bug  

CONTRIBUTING.md

@@ -13,19 +13,7 @@ All contributions should submit pull requests to the **develop** branch and not
 Please try to submit pull requests that are more incremental in nature vs. a big bang approach. Small feature and bug fixes are more appropriate for evolving this utility. 
 
 #### Formatting
-Please try to observe formatting by using the yapf utility. The formatting rules have been provided in the
-.editorconfig and .style.yapf files included in this rep.
-
-To install yapf run:
-```bash
-> pip install yapf
-```
-
-To execute formatting run:
-```bash
-> yapf kim.py 
-```
-within the same directory as the formatting rules files noted above.
+Please try to observe formatting by using the PEP 8 Style Guide. 
 
 #### Forking
 Contributions are welcome! Just fork this repo, make your changes and submit a pull request!

Dockerfile

@@ -3,8 +3,8 @@ RUN apt update
 RUN apt install -y python-is-python3 python3-pip
 RUN apt-get install -y curl
 RUN apt-get install ca-certificates
-RUN curl -L -o tmp/keep-it-markdown-0.6.4.tar.gz https://github.com/djsudduth/keep-it-markdown/archive/refs/tags/0.6.4.tar.gz
-RUN tar -zxvf tmp/keep-it-markdown-0.6.4.tar.gz
+RUN curl -L -o tmp/keep-it-markdown-0.6.5.tar.gz https://github.com/djsudduth/keep-it-markdown/archive/refs/tags/0.6.5.tar.gz
+RUN tar -zxvf tmp/keep-it-markdown-0.6.5.tar.gz
 RUN pip install keyrings.alt
-RUN pip install -r /keep-it-markdown-0.6.4/requirements.txt
+RUN pip install -r /keep-it-markdown-0.6.5/requirements.txt
 

EXAMPLES.md

@@ -0,0 +1,63 @@
+## Simple Export
+
+### All user queries have the prompt:
+`Enter a keyword search, label search or --all' to convert Keep notes to md or '--x' to exit:`
+
+#### User query and export active notes (no notes will be overwritten)
+`python kim.py`
+
+#### User query and export only archived notes
+`python kim.py -a`
+
+#### User query and export active notes and overwrite existing markdown notes
+`python kim.py -o`
+
+#### User query and export active notes that were edited after Jun 15, 2023
+`python kim.py -ed "> 2023-06-15"`
+
+#### Export all active notes in batch without user prompts
+`python kim.py -b --all`
+
+#### Export only notes with the label #science in batch without user prompts
+`python kim.py -b "#science"`
+
+#### Export all active notes in batch with create dates after Jan 1, 2023
+`python kim.py -cd "> 2023-01-01" -b --all`
+
+#### Export all active notes in batch and skip over notes already exported
+`python kim.py -s -b --all`
+
+
+## Complex Export
+#### Export all active notes in batch formatted to Joplin front matter headers, and move them to archive after export with edit dates after May 14, 2024
+`python kim.py -j -m -ed "> 2023-05-14" -b --all`
+
+#### Export all active notes with the label #computer in batch using the first note line as the markdown file title if the title is missing (50 chars max), preserve Logseq namespaces and format Logseq bullets, and overwriting any existing notes
+`python kim.py -c -l -o -b "#computer"`
+
+#### Export all active notes in batch preserving Keep labels with spaces and special characters, skipping over existing notes, moving them to archive after export
+`python kim.py -p -s -m -b --all`
+
+#### Export all archived notes in batch, overwriting existing notes and modifying Keep note-to-note markdown links to wikilinks
+`python kim.py -a -o -w -b --all`
+
+### List of options
+```
+Options:
+  -r  Will reset and not use the local keep access token in your system's keyring  
+  -o  Overwrite any existing markdown files with the same name  
+  -a  Search and export only archived notes  
+  -p  Preserve keep labels with spaces and special characters  
+  -s  Skip over any existing notes with the same title  
+  -c  Use starting content within note body instead of create date for md filename  
+  -l  Prepend paragraphs with Logseq style bullets and preserve namespaces 
+  -j  Prepend notes with Joplin front matter tags and dates  
+  -m  Move any exported Keep notes to Archive  
+  -w  Convert pre-formatted markdown note-to-note links to wikilinks  
+  -i  Import notes from markdown files WARNING - EXPERIMENTAL!!  
+  -cd, --cd TEXT  Export notes before or after the create date - < or >|YYYY-MM-DD  
+  -ed, --ed TEXT  Export notes before or after the edit date - < or >|YYYY-MM-DD  
+  -b, --search-term TEXT  Run in batch mode with a specific Keep search term  
+  -t, --master-token TEXT  Log in using master keep token
+  --help Show this message and exit.
+```