joplin-utils

Collection of tools for working with Joplin, the open source note taking app. These python tools make use of the Joplin Data API, which is available whenever the clipper server is running.

Dependencies

Python

On Mac, you can use Homebrew to install a newer version of Python alongside the system version.

brew install python

You can install Python packages with

pip3 install <package>

They will install into the site-package directory

/usr/local/lib/python3.10/site-packages

Python modules

These tools make use of other python modules you'll need:

• PyMuPDF
• Click
• Requests

Install them with pip:

pip3 install click
pip3 install requests
pip3 install PyMuPDF

file-uploader.py

⭐ This utility is based on the excellent "Hot Folder" implementation by @JackGruber

This module enables uploading of a specified file as a note (with tags, etc) into Joplin via the API. It was designed to support integration into Hazel automation workflows.

Images and text (Mimetype text/plain) are inserted directly into the note, other Files are added as attachment.

Note: The file is deleted after processing!

If you want to insert files directly as text, define them with the --as-plain switch.

Example

python3 file-uploader.py -n "Inbox" -p "/Users/djvreeman/joplin-import" -f "2022 08 30 - TSC Update Webinar.pdf" --tag "pdf,presentation,HL7"

Parameters

• -t Joplin Authorization token. Default: Ask for token and store token

  • If no token is specified, the script will ask for it and then store it in the script's directory for later use when called without the -t option.

• -u Joplin Web Clipper URL. Default http://localhost:41184

• -d Specify the notebook in which to place newly created notes. Default: @Inbox

• -p Folder for monitoring

• --as-plain Specify file extensions comma separated for input as text. Example: .md, .json

• --tag Specify of comma separated Tags which should be added to the note. Example: scan, todo

• --preview Create a preview of the first site from an PDF file.

joplin-process-email.py

Need to write this section yet

uses config-example.ini for loading Joplin and IMAP settings