Skip to main content

Python tools and extensions for sioyek PDF reader

Project description

Python wrapper and simple addons for the sioyek PDF viewer. Install using:

python -m pip install sioyek

Note that python executable name might be different in your system, for example it might be python3 instead of python. Also note that in some AppImage builds of sioyek, "%{sioyek_path}" doesn't expand to correct AppImage, you just have to replace "%{sioyek_path}" with the exact path of sioyek AppImage on your filesystem.

Addons:

-paper_downloader

Download the paper name under cursor from google scholar or scihub and open the document. To enable add this to your prefs_user.config:

new_command _download_paper python -m sioyek.paper_downloader download "%{sioyek_path}" "%{paper_name}"
control_click_command _download_paper

Now you can download papers by control-clicking on their names like this:

https://user-images.githubusercontent.com/6392321/185757545-117b00d5-23bf-433f-8d50-6e193ef3deee.mp4

-dual_panelify

Create a dual panel version of the current PDF file.

https://user-images.githubusercontent.com/6392321/185757596-681c6bde-7297-4a9d-a5bc-02819208b3de.mp4

Config:

new_command _dual_panelify python -m sioyek.dual_panelify "%{sioyek_path}" "%{file_path}" "%{command_text}"

-embed_annotations

Embed the sioyek bookmarks and highlights into the current file.

https://user-images.githubusercontent.com/6392321/185757605-dc277f2e-5b73-49e1-98f1-57c83417f07b.mp4

Config:

new_command _embed_annotations python -m sioyek.embed_annotations "%{sioyek_path}" "%{local_database}" "%{shared_database}" "%{file_path}"

-extract_highlights

Create a new document with the highlights of the current document with pre-inserted portal into the corresponding location in the original document.

https://user-images.githubusercontent.com/6392321/185757614-c8ff1c83-fe80-4ee8-8b39-477b67fd8ffa.mp4

Config:

new_command _extract_highlights python -m sioyek.extract_highlights "%{sioyek_path}" "%{local_database}" "%{shared_database}" "%1" %{zoom_level}

-translate

Translate the text and display it in sioyek statusbar.

https://user-images.githubusercontent.com/6392321/185757622-98b9b4e2-e421-451a-8cd3-fa2af43c4986.mp4

Config:

new_command _translate_selected_text python -m sioyek.translate "%{sioyek_path}" "%{selected_text}"
new_command _translate_current_line_text python -m sioyek.translate "%{sioyek_path}" "%{line_text}"

Donation

If you enjoy sioyek, please consider donating to support its development.

Buy Me A Coffee

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sioyek-0.31.4.tar.gz (25.7 kB view details)

Uploaded Source

Built Distribution

sioyek-0.31.4-py3-none-any.whl (27.9 kB view details)

Uploaded Python 3

File details

Details for the file sioyek-0.31.4.tar.gz.

File metadata

  • Download URL: sioyek-0.31.4.tar.gz
  • Upload date:
  • Size: 25.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.6

File hashes

Hashes for sioyek-0.31.4.tar.gz
Algorithm Hash digest
SHA256 5cc2b662d53640af7583b451b7126d732962e78a3229b43113c0d21b58cab1eb
MD5 44b1f7ba427365bdc27470d185254d1c
BLAKE2b-256 d43e67be74b1cb74536aff4c6b628d58a03f1ed2cfcb99bd18431df9c978af86

See more details on using hashes here.

Provenance

File details

Details for the file sioyek-0.31.4-py3-none-any.whl.

File metadata

  • Download URL: sioyek-0.31.4-py3-none-any.whl
  • Upload date:
  • Size: 27.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.6

File hashes

Hashes for sioyek-0.31.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0fab037be2e4ec8ee05052cf92894ab7eb4004195b5a952af1204bcdcb373f37
MD5 223740d92b5b0f887b648f89e3c92707
BLAKE2b-256 1d9f40a1734e3b9085c0dc26974b954fbf1598fe1ecbe7c8630bbb942ac5276b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page