Skip to content

Commit 8086993

Browse files
committed
Merge branch 'release/0.6.5' into main
New release 0.6.5
2 parents 06d245a + cb2428c commit 8086993

File tree

8 files changed

+282
-112
lines changed

8 files changed

+282
-112
lines changed

.editorconfig

Lines changed: 0 additions & 23 deletions
This file was deleted.

.style.yapf

Lines changed: 0 additions & 2 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Changelog
2+
3+
## 0.6.5 Release (10/30/2024)
4+
- 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
5+
- Added `-w` option to convert pre-existing Keep note-to-note markdown links to wikilinks during export
6+
- Filter exported notes by create (`-cd`) or edit date (`-ed`) ( < or > date only)
7+
- Fixed exported notes update date bug to be the actual edited date vs. internal Google update date
8+
- Added warning on importing too many markdown notes may lock user out of Keep
9+
- Added EXAMPLES.md for command line examples using option switches
10+
- Added ability to export namespaces with '/' character in filenames for Logseq and Joplin
11+
- Removed old python formatting yapf settings
12+
13+
## 0.6.3|0.6.4 Release (9/16/2024)
14+
- Fixed the Dockerfile versions
15+
16+
## 0.6.2 Release (9/15/2024)
17+
- Fixed the keep.resume warning message for newer gkeepapi version >= 0.16.0
18+
- Fixed the Python 3.12+ regular expression error
19+
- Added more detail error message if KIM fails to execute
20+
21+
## 0.6.1 Release (5/26/2024)
22+
- New instructions and Dockerfile for updated versions of gkeepapi and gpsoauth to get keep token
23+
- Wikilinking now supported for Joplin notes
24+
25+
## 0.6.0 Release (1/28/2024)
26+
- Now requires Python v-3.10+ to run KIM
27+
- New Docker image to get the Keep token
28+
- Old keep-test.py module removed for new Google authentication (get_token.py added)
29+
- New simple INSTALL.md steps
30+
31+
## 0.5.4 Release (1/14/2024)
32+
- Docker image altered to use Ubuntu:22.04 to fix Google auth issues with gkeepapi
33+
- Added new flag -m to move exported images to Archive folder
34+
- Removed python deprecated imghdr library with pillow module
35+
36+
## 0.5.3 Release (11/5/2023)
37+
- Docker image creation and use
38+
- Removed captcha note in keep-test.py
39+
40+
## 0.5.2 Release (7/12/2023)
41+
- Switched audio file extensions from AAC back to M4A
42+
- Added Joplin exports -j flag to use front matter header
43+
- Removed first dash on list notes exported to Logseq with -l switch
44+
45+
## 0.5.1 Release (6/28/2023)
46+
- Fixed image overwrite if note has no title or text and using -c switch
47+
- Fixed error of markdown note imports if there are special characters within
48+
- Added create and update dates of markdown files to imported notes
49+
50+
## 0.5.0 Release (2/4/2023)
51+
This update is a major refactor of the previous versions. Updates include:
52+
- Faster export
53+
- Added Logseq switch to add bullets to exported Keep notes
54+
- Added simple import option to upload markdown files back to Keep
55+
- Removed microseconds from note create and update dates
56+
- Fixed null image bug

CONTRIBUTING.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,7 @@ All contributions should submit pull requests to the **develop** branch and not
1313
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.
1414

1515
#### Formatting
16-
Please try to observe formatting by using the yapf utility. The formatting rules have been provided in the
17-
.editorconfig and .style.yapf files included in this rep.
18-
19-
To install yapf run:
20-
```bash
21-
> pip install yapf
22-
```
23-
24-
To execute formatting run:
25-
```bash
26-
> yapf kim.py
27-
```
28-
within the same directory as the formatting rules files noted above.
16+
Please try to observe formatting by using the PEP 8 Style Guide.
2917

3018
#### Forking
3119
Contributions are welcome! Just fork this repo, make your changes and submit a pull request!

Dockerfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ RUN apt update
33
RUN apt install -y python-is-python3 python3-pip
44
RUN apt-get install -y curl
55
RUN apt-get install ca-certificates
6-
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
7-
RUN tar -zxvf tmp/keep-it-markdown-0.6.4.tar.gz
6+
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
7+
RUN tar -zxvf tmp/keep-it-markdown-0.6.5.tar.gz
88
RUN pip install keyrings.alt
9-
RUN pip install -r /keep-it-markdown-0.6.4/requirements.txt
9+
RUN pip install -r /keep-it-markdown-0.6.5/requirements.txt
1010

EXAMPLES.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
## Simple Export
2+
3+
### All user queries have the prompt:
4+
`Enter a keyword search, label search or --all' to convert Keep notes to md or '--x' to exit:`
5+
6+
#### User query and export active notes (no notes will be overwritten)
7+
`python kim.py`
8+
9+
#### User query and export only archived notes
10+
`python kim.py -a`
11+
12+
#### User query and export active notes and overwrite existing markdown notes
13+
`python kim.py -o`
14+
15+
#### User query and export active notes that were edited after Jun 15, 2023
16+
`python kim.py -ed "> 2023-06-15"`
17+
18+
#### Export all active notes in batch without user prompts
19+
`python kim.py -b --all`
20+
21+
#### Export only notes with the label #science in batch without user prompts
22+
`python kim.py -b "#science"`
23+
24+
#### Export all active notes in batch with create dates after Jan 1, 2023
25+
`python kim.py -cd "> 2023-01-01" -b --all`
26+
27+
#### Export all active notes in batch and skip over notes already exported
28+
`python kim.py -s -b --all`
29+
30+
31+
## Complex Export
32+
#### 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
33+
`python kim.py -j -m -ed "> 2023-05-14" -b --all`
34+
35+
#### 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
36+
`python kim.py -c -l -o -b "#computer"`
37+
38+
#### Export all active notes in batch preserving Keep labels with spaces and special characters, skipping over existing notes, moving them to archive after export
39+
`python kim.py -p -s -m -b --all`
40+
41+
#### Export all archived notes in batch, overwriting existing notes and modifying Keep note-to-note markdown links to wikilinks
42+
`python kim.py -a -o -w -b --all`
43+
44+
### List of options
45+
```
46+
Options:
47+
-r Will reset and not use the local keep access token in your system's keyring
48+
-o Overwrite any existing markdown files with the same name
49+
-a Search and export only archived notes
50+
-p Preserve keep labels with spaces and special characters
51+
-s Skip over any existing notes with the same title
52+
-c Use starting content within note body instead of create date for md filename
53+
-l Prepend paragraphs with Logseq style bullets and preserve namespaces
54+
-j Prepend notes with Joplin front matter tags and dates
55+
-m Move any exported Keep notes to Archive
56+
-w Convert pre-formatted markdown note-to-note links to wikilinks
57+
-i Import notes from markdown files WARNING - EXPERIMENTAL!!
58+
-cd, --cd TEXT Export notes before or after the create date - < or >|YYYY-MM-DD
59+
-ed, --ed TEXT Export notes before or after the edit date - < or >|YYYY-MM-DD
60+
-b, --search-term TEXT Run in batch mode with a specific Keep search term
61+
-t, --master-token TEXT Log in using master keep token
62+
--help Show this message and exit.
63+
```

0 commit comments

Comments
 (0)