zot2sioyek 0.1.8

Script to embed zotero database highlights to sioyek pdf reader database.

Zotero to Sioyek Highlights Manager

---

Python script to embed zotero highlights to sioyek, and other utils.

• 🐍 Python sqlite3 and pyzotero Based Script

[!WARNING] Tested only in linux

📖 Contents

• ✨ Features
• 📚 Requirements
  • 🐍 Conda
• 📦 Installation
• 🔧 Configuration
  • 🎨 Colors
• 📝 TODO
• 🤝 Contributing
• 💓 Aknowledgements

✨ Features

• Embed zotero highlights to the sioyek database:

python zot2sioyek.py --insert-highlights "/path/to/file.pdf"

• Print in terminal the text of all the highlights from a zotero file, colored with the highlight color

python zot2sioyek.py --print-annotation-text "/path/to/file.pdf"

• To see all available commands:

python zot2sioyek.py --help

[!NOTE] If installed through pip, you can run only zot2sioyek instead of python zot2sioyek.py.

📚 Requirements

Requirements are automatic installed when this script is installed with pip

• pyzotero

• pymupdf

• PyQt5

• regex

• sqlite3

python -m pip install pyzotero pymupdf PyQt5 regex sqlite3

🐍 Conda

If wanted, requirements may be installed with conda, to run this script in a conda environment.

Inside this repo, run:

conda env create --file env.yml

📦 Installation

python -m pip install zot2sioyek

🔧 Configuration

To use this script define the variables in zot2sioyek.py:

• SIOYEK_PATH: Sioyek binary path.

• LOCAL_DATABASE_FILE_PATH: Sioyek .db local database file path.

• SHARED_DATABASE_FILE_PATH: Sioyek .db shared database file path.

• ZOTERO_LIBRARY_ID: Your personal library ID available Here, in the section Your userID for use in API calls.

• ZOTERO_API_KEY: Api key, you can obtain Here.

• ZOTERO_LIBRARY_TYPE: Zotero library type, can be 'user' or 'group'.

• ZOTERO_LOCAL_DIR: Zotero local storage folder, like /home/user/Zotero/storage.

• ZOTERO_TO_SIOYEK_COLORS: Sioyek highlight type letter associated to each zotero highlight color (Optional).

[!NOTE] The variables can also be defined as envrinoment variables (at your .zshrc/.bashrc etc...), with the exact same names as the script variables above, and ZOTERO_TO_SIOYEK_COLORS if defined should be defined as a string like: export ZOTERO_TO_SIOYEK_COLORS='{ "#5fb236": "h", "#a28ae5": "i", "#e56eee": "i", "#2ea8e5": "d", "#ff6666": "e", "#f19837": "r", "#ffd400": "s"}'

🎨 Colors

• This script defines ZOTERO_TO_SIOYEK_COLORS variable based on the most close colors of default sioyek config, to the zotero highlight colors. The conversion looks like the following (Zotero colors in the upper row, sioyek colors in the lower row):

• If you want to have the exact same colors of zotero highlights in sioyek, add the following to your sioyek prefs_user.config:

highlight_color_g 0.37 0.70 0.21
highlight_color_a 0.63 0.54 0.90
highlight_color_p 0.90 0.43 0.93
highlight_color_b 0.18 0.66 0.90
highlight_color_r 1.00 0.40 0.40
highlight_color_o 0.95 0.60 0.22
highlight_color_y 1.00 0.83 0.00

• Or to any highlight letter you want, since the defined letter on prefs_user.config and the script variable ZOTERO_TO_SIOYEK_COLORS match.

📝 TODO

• Embed all zotero database highlights starting from a specified date.

• Create import from sioyek database to zotero database highlights.

  • Currently, I couldn't find a way of adding zotero highlights through pyzotero, or through zotero api/sql. If anyone knows how to do it, please message or email me so that I can update this script, or feel free to implement the needed updates and send a pull request, I'll be very thankful.

🤝 Contributing

Feel free to make pending or other optimizations and pull requests, this script is still under development and any contribution is very much appreciated.

• Clone the repo to your local environment:

💓 Aknowledgements

• Ahrm for developing Sioyek PDF reader.

• Urschrei for Pyzotero

• Blob42 for Koreader-sioyek-import, which parts of this script was based from.

• The Zotero team.