kxis

kxis

Перевод документации проекта

Keep-it-markdown или KIM преобразует Google Keep notes в markdown, используя неофициальный Python Keep API, без необходимости сначала использовать Google Takeout для экспорта заметок. Теперь КИМ может также импортировать заметки markdown для сохранения. Скрипт будет выполняться в Windows, macOS или Linux.

Общая цель состоит в том, чтобы использовать Google Keep как простой способ записи необработанных заметок на всех устройствах или дополнительно использовать плагин для браузера. Затем заметки можно запросить для экспорта в файлы markdown непосредственно в приложения для создания заметок, такие как Obsidian, Logseq и/или Notion, или использовать напрямую с Typora.

Использование

После установки вы увидите:

Введите поиск по ключевому слову, метке или “--all”, чтобы преобразовать Keep notes в md, или “--x” для выхода:

Ввод условия запроса и нажатие клавиши Enter приведет к первому экспорту заметки или набора заметок в виде отдельных файлов markdown из вашего активного списка заметок.

**ПРИМЕЧАНИЕ: при первом запуске экспортированные файлы md будут созданы в подкаталоге KIM по умолчанию под названием “mdfiles” в вашем каталоге установки. Изображения экспортируются в “media” в каталоге по умолчанию. Это может быть изменено позже **.

Для первого теста используйте запрос по ключевому слову, который возвращает и преобразует максимум несколько заметок (вы можете сначала выполнить поиск в Keep, чтобы узнать, сколько заметок будет возвращено по вашему запросу/термину преобразования).

Вы можете преобразовать в md, используя одно слово, фразу или метку. ** Все запросы на конвертацию игнорируются в заметках в архиве и корзине, если вы не используете флажки опций, указанные ниже **. KIM будет оставаться активным для выполнения дополнительных преобразований, пока вы просто не нажмете -x или Ctrl-C.

Используя настройки

При первом запуске KIM создаст файл settings.cfg в каталоге, который вы выбрали для установки KIM. Вы можете изменить эти настройки с помощью текстового редактора:

google_userid = идентификатор вашей учетной записи Google (позволяет не вводить свой идентификатор).
output_path = путь к месту создания выходных файлов md (если он пуст, то это ваш каталог установки). Пользователи Windows используют косые черты, например -> c:/md-files/export. media_path = расположение экспортируемых медиафайлов (изображений, аудио) относительно вашего output_path. Если значение output_path равно /mdexport, а значение media_path равно media/data, то полный путь к носителю будет /mdexport/media/data. Пути к носителю не могут начинаться с /, mount или буквы диска.

(Параметры импорта смотрите в разделе “Настройки” ниже)

Справка и параметры

Все варианты KIM можно найти, используя

Ярлыки

Для поиска заметок по ярлыкам требуется просто ввести символ # перед поисковым запросом, например “#myLabel”. В некоторых операционных системах, таких как Linux, вам может потребоваться заключить этот термин в кавычки.

Заголовки

В экспортируемых заголовках заметок используется максимально возможное преобразование заголовков. Во многих случаях в Keep notes нет заголовков, и по умолчанию KIM будет использовать дату и время создания в качестве заголовка. Если вы хотите использовать начальную часть текста для пустых заголовков, используйте

если в тексте заметки нет заголовка или текста, то по умолчанию будет использоваться дата.

Перезапись или пропуск

KIM по умолчанию не перезаписывает файлы markdown при экспорте, главным образом потому, что у Keep notes могут быть одинаковые названия. KIM попытается переименовать дублирующиеся заметки. Однако заметки могут быть перезаписаны с помощью

все экспортированные файлы md будут перезаписаны. Однако, если две или более заметки Keep имеют одинаковое название, к заметке будет добавлена дата создания, чтобы она была уникальной.

Если вы хотите пропустить или проигнорировать заметки, которые уже были экспортированы, то

пропустите экспорт и сохраните заметки в markdown, которые уже существуют в целевом каталоге. Если две или более записи Keep notes имеют одинаковое название и файл markdown с таким именем уже существует, для всех несуществующих записей будет создан новый экспорт. (Обратите внимание, что функции перезаписи и пропуска нельзя использовать одновременно)

Joplin Front Matter

Теги Joplin не используют формат хэштега. Они предоставляются в качестве комментариев к заметкам. С помощью этого параметра КИМ будет добавлять к заметкам комментарии к Joplin, чтобы сохранить теги и даты. Вы можете включить эту функцию с помощью команды

Переместить заметки в архив после экспорта.

ВНИМАНИЕ! Это единственный параметр, который изменяет ваши заметки, даже если это просто изменение атрибута. Перед использованием этой опции обязательно сохраните резервную копию своих заметок в Google Takeout!!
Если у вас большое количество заметок, может возникнуть путаница с тем, какие из них уже были экспортированы. С помощью этого параметра все экспортированные заметки будут перемещены в архив сохранения. Вы можете включить эту функцию с помощью

Хранение токенов аутентификации

Когда вы запустите KIM в первый раз и войдете в систему с помощью своего пароля, он сохранит ваш аутентифицированный токен Google Keep в надежном хранилище вашего компьютера (macOS - Keychain, Windows Credential Locker и Linux Secret Service или KWallet). При следующем запуске KIM вам не нужно будет повторно вводить пароль.

Если вам нужно изменить или сбросить свой токен доступа или вам неудобно сохранять токен в надежном хранилище, просто запустите KIM с флагом -r (ПРИМЕЧАНИЕ: это изменилось с версии 0.2.0).:

Пакетный режим

KIM можно запустить с помощью вашего собственного скрипта, используя флаг -b. Например, запустив:

> python kim.py -b ‘мой поисковый запрос’ или > python kim.py -b --all

KIM будет выполняться без запросов на ввод, если в файле настроек.cfg указан ваш идентификатор Google ID, и вы сохранили свой токен доступа Keep, запустив KIM один раз вручную на своем устройстве. Убедитесь, что флаг -b является последним из всех флагов параметров при их объединении.

Архивные заметки

У КИМ есть возможность экспортировать только сохраненные архивные заметки. При использовании этой опции все другие типы заметок игнорируются

Экспорт архива можно комбинировать с параметрами -o и -b.

Использование понятия

КИМ отмечает, что экспорт в markdown, похоже, успешно импортирован в понятие. Однако Notion ПО-прежнему не удается импортировать вложенные изображения со ссылками (что, по-видимому, является общей проблемой импорта Notion md на данный момент). Notion также привязывает базовые идентификаторы ко всем заметкам с перекрестными ссылками, чтобы при импорте не возникало автоматической перекрестной привязки (будущая функция). Кроме того, теги в Notion не поддерживаются, поэтому сохраняемые метки будут просто текстовыми хэштегами в заметке, по которым доступен поиск.

Использование с Joplin

Экспорт заметок KIM markdown также очень хорошо работает при импорте в Joplin. Использование флага -j добавит ярлыки Keep в качестве ** Joplin front matter**, чтобы автоматически добавлять их в качестве тегов. Большинство типов уценки в Keep notes должны быть успешно преобразованы, даже если Keep не может их отобразить. Например, вы можете начать создавать перекрестные ссылки на заметки в Keep, используя двойные скобки Wikilink внутри заметки, подобной этой [[Название другой заметки Keep]]. Викилинкование между Keep notes автоматически преобразуется в стандартные ссылки для заметок Joplin markdown, соединяющие заметки друг с другом.

Logseq Use

Заметки будут импортированы в Logseq аналогично описанию использования Obsidian, однако вам необходимо указать путь к файлам формата mdf в папке “страницы” в Logseq. Для правильного отображения изображений обязательно укажите путь к мультимедиа в ../assets. Кроме того, для корректного форматирования заметок была добавлена экспериментальная функция. Был настроен новый переключатель (-l) для добавления маркеров абзацев в каждую экспортируемую заметку, чтобы Logseq лучше отображал их.

Использование Typora

KIM старается придерживаться строгих правил markdown, чтобы обеспечить максимальную совместимость. При использовании Typora при экспорте KIM markdown проблем обнаружено не было.

Список задач по функциям

Добавить сохранение аудио-файлов и файлов рисунков
Добавить флаг перезаписи для замены заметок
Очистить код из MVP
Экспортировать из Google Takeout и сохранять резервные копии
Создать простой инсталлятор
Создать сценарии установки для Windows, macOS и Linux
Привязать Keep notes к ссылкам Notion для перекрестной привязки импорта md
Сохранять заметки по электронной почте
Перемещать импорт
Версия Docker

Установка

Установите Python на свой компьютер.
Скачайте архив с проектом Keep-it-markdown.
Распакуйте файлы из архива в любую папку на вашем компьютере.
Откройте терминал или командную строку и перейдите в папку с проектом.
Установите все необходимые зависимости, выполнив команду pip install -r requirements.txt.
Запустите скрипт get_token.py для получения токена доступа к Google Keep.
Сохраните полученный токен и используйте его для запуска скрипта kim.py.
Для однократного использования или использования без сохранения токена и экспортированных заметок можно запустить скрипт в Docker.
Для постоянного использования на компьютере установите Keep-it-markdown, установите зависимости и сохраните токен в keystore.

Использование с различными приложениями:

Joplin: Используйте флаг -j для добавления меток Keep в качестве фронтменов Joplin.
Logseq: Импортируйте заметки в Logseq, установив путь к файлам и папке с медиафайлами.
Notion: Заметки импортируются в Notion, но ссылки на изображения не поддерживаются.
Typora: Keep-it-markdown совместим со строгой разметкой Markdown.

Планируемые функции: