{"id":13478212,"url":"https://github.com/ahrm/sioyek-python-extensions","last_synced_at":"2025-09-12T13:44:31.157Z","repository":{"id":59751051,"uuid":"525036346","full_name":"ahrm/sioyek-python-extensions","owner":"ahrm","description":"Python wrapper and simple addons for sioyek PDF viewer","archived":false,"fork":false,"pushed_at":"2025-02-22T07:15:20.000Z","size":99,"stargazers_count":197,"open_issues_count":18,"forks_count":11,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-09T11:06:13.427Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ahrm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-08-15T15:19:00.000Z","updated_at":"2025-05-05T13:49:36.000Z","dependencies_parsed_at":"2024-01-13T19:20:04.686Z","dependency_job_id":"2f7869aa-0bdc-4798-af98-4827254f2491","html_url":"https://github.com/ahrm/sioyek-python-extensions","commit_stats":{"total_commits":32,"total_committers":1,"mean_commits":32.0,"dds":0.0,"last_synced_commit":"5317e955e80169ffb392122ced738c2ca22ce510"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahrm%2Fsioyek-python-extensions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahrm%2Fsioyek-python-extensions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahrm%2Fsioyek-python-extensions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahrm%2Fsioyek-python-extensions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ahrm","download_url":"https://codeload.github.com/ahrm/sioyek-python-extensions/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254509477,"owners_count":22082892,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T16:01:54.079Z","updated_at":"2025-05-16T10:08:47.336Z","avatar_url":"https://github.com/ahrm.png","language":"Python","readme":"Python wrapper and simple addons for the sioyek PDF viewer. Install using:\n```\npython -m pip install sioyek\n```\nNote that python executable name might be different in your system, for example it might be `python3` instead of `python`.\nAlso 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.\n\nAddons:\n\n### -`paper_downloader`\nDownload the paper name under cursor from google scholar or scihub and open the document. To enable add this to your `prefs_user.config`:\n```\nnew_command _download_paper python -m sioyek.paper_downloader download \"%{sioyek_path}\" \"%{paper_name}\" \"%{selected_text}\" [Your Email, If Using Unpaywall]\ncontrol_click_command _download_paper\n```\nNow you can download papers by control-clicking on their names like this:\n\n\nhttps://user-images.githubusercontent.com/6392321/185757545-117b00d5-23bf-433f-8d50-6e193ef3deee.mp4\n\n\n### -`dual_panelify`\nCreate a dual panel version of the current PDF file.\n\n\nhttps://user-images.githubusercontent.com/6392321/185757596-681c6bde-7297-4a9d-a5bc-02819208b3de.mp4\n\nConfig:\n```\nnew_command _dual_panelify python -m sioyek.dual_panelify \"%{sioyek_path}\" \"%{file_path}\" \"%{command_text}\"\n```\n\n### -`embed_annotations`\nEmbed the sioyek bookmarks and highlights into the current file.\n\n\nhttps://user-images.githubusercontent.com/6392321/185757605-dc277f2e-5b73-49e1-98f1-57c83417f07b.mp4\n\nConfig:\n```\nnew_command _embed_annotations python -m sioyek.embed_annotations \"%{sioyek_path}\" \"%{local_database}\" \"%{shared_database}\" \"%{file_path}\"\n```\n\n### -`extract_highlights`\nCreate a new document with the highlights of the current document with pre-inserted portal into the corresponding location in the original document.\n\n\nhttps://user-images.githubusercontent.com/6392321/185757614-c8ff1c83-fe80-4ee8-8b39-477b67fd8ffa.mp4\n\nConfig:\n```\nnew_command _extract_highlights python -m sioyek.extract_highlights \"%{sioyek_path}\" \"%{local_database}\" \"%{shared_database}\" \"%1\" %{zoom_level}\n```\n\n\n### -`translate`\nTranslate the text and display it in sioyek statusbar.\n\n\nhttps://user-images.githubusercontent.com/6392321/185757622-98b9b4e2-e421-451a-8cd3-fa2af43c4986.mp4\n\nConfig:\n```\nnew_command _translate_selected_text python -m sioyek.translate \"%{sioyek_path}\" \"%{selected_text}\"\nnew_command _translate_current_line_text python -m sioyek.translate \"%{sioyek_path}\" \"%{line_text}\"\n```\n\n### -`import_annotations`\nImport PDF bookmarks and highlights into sioyek so that they are searchable.\n\nhttps://user-images.githubusercontent.com/6392321/205930859-79b5efb9-d159-4d92-9382-1641ae3cf01d.mp4\n\nConfig:\n```\nnew_command _import_annotations python -m sioyek.import_annotations \"%{sioyek_path}\" \"%{local_database}\" \"%{shared_database}\" \"%{file_path}\"\n```\n\n### -`remove_annotation`\nRemove PDF annotations.\n\nhttps://user-images.githubusercontent.com/6392321/205931274-ef2b20e5-0aec-478c-9dd8-ff83a5ba498b.mp4\n\nConfig:\n```\nnew_command _remove_annotations python -m sioyek.remove_annotation \"%{sioyek_path}\" \"%{local_database}\" \"%{shared_database}\" \"%{file_path}\" \"%{selected_rect}\"\n```\n\n### -`add_text`\nAdd text annotation to the PDF.\n\n\n\nhttps://user-images.githubusercontent.com/6392321/205931938-938da231-8f2c-4f85-92a3-d7adf320f5f2.mp4\n\n\nConfig:\n```\nnew_command _add_text python -m sioyek.add_text \"%{sioyek_path}\" \"%{local_database}\" \"%{shared_database}\" \"%{file_path}\" \"%{selected_rect}\" \"%{command_text}\"\nnew_command _add_red_text python -m sioyek.add_text \"%{sioyek_path}\" \"%{local_database}\" \"%{shared_database}\" \"%{file_path}\" \"%{selected_rect}\" \"%{command_text}\" fontsize=5 text_color=255,0,0\n```\n\n\n## User Scripts\nHere is a list of scripts created by sioyek users:\n* A script to import annotations for koreader: https://github.com/blob42/koreader-sioyek-import\n\n## Donation\nIf you enjoy sioyek, please consider donating to support its development.\n\n\u003ca href=\"https://www.buymeacoffee.com/ahrm\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/default-orange.png\" alt=\"Buy Me A Coffee\" height=\"41\" width=\"174\"\u003e\u003c/a\u003e\n","funding_links":["https://www.buymeacoffee.com/ahrm"],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahrm%2Fsioyek-python-extensions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fahrm%2Fsioyek-python-extensions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahrm%2Fsioyek-python-extensions/lists"}