{"id":17017374,"url":"https://github.com/noembryo/kohighlights","last_synced_at":"2025-04-04T23:07:21.873Z","repository":{"id":46662903,"uuid":"77762058","full_name":"noembryo/KoHighlights","owner":"noembryo","description":"KOHighlights is a utility for viewing KOReader's highlights and/or export them to simple text, html, csv or markdown files.","archived":false,"fork":false,"pushed_at":"2025-01-15T23:04:17.000Z","size":7952,"stargazers_count":180,"open_issues_count":4,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-28T22:11:53.450Z","etag":null,"topics":["converter","export","highlight","highlights","koreader","pyside","pyside2","pyside6","python","reader","sync","view"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/noembryo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-01-01T01:41:14.000Z","updated_at":"2025-03-20T07:42:37.000Z","dependencies_parsed_at":"2023-01-21T20:38:52.034Z","dependency_job_id":"c7b8529d-85f4-4714-89a9-5ed56e13373c","html_url":"https://github.com/noembryo/KoHighlights","commit_stats":{"total_commits":169,"total_committers":1,"mean_commits":169.0,"dds":0.0,"last_synced_commit":"95dcf0ba4daedc634bbbb2ebc1c6a17dbe9344a3"},"previous_names":[],"tags_count":41,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noembryo%2FKoHighlights","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noembryo%2FKoHighlights/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noembryo%2FKoHighlights/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noembryo%2FKoHighlights/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/noembryo","download_url":"https://codeload.github.com/noembryo/KoHighlights/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247261600,"owners_count":20910108,"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":["converter","export","highlight","highlights","koreader","pyside","pyside2","pyside6","python","reader","sync","view"],"created_at":"2024-10-14T06:36:29.213Z","updated_at":"2025-04-04T23:07:21.846Z","avatar_url":"https://github.com/noembryo.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## General\n![kohighlights128w](https://user-images.githubusercontent.com/24675403/234561476-97283ff8-5437-49cd-b4c5-3929886cf182.png)\n\n[![made-with-python][Python]](https://www.python.org/)\n[![Generic badge][OS]][ReleaseLink]\n[![License: MIT][MIT]](LICENSE)\n[![GitHub release][Release]][ReleaseLink]\n\u003c!-- [![Github all releases][TotalDown]][ReleaseLink] --\u003e\n\u003c!-- [![Github Releases (by Release)][VersionDown]][ReleaseLink] --\u003e\n\n\n**KOHighlights** is a utility for viewing and exporting the\n[Koreader](https://github.com/koreader/koreader)'s highlights to simple text, html, csv or markdown files.  \n\n___\n#### Screenshots\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20l1.png\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20l1.png\" height=\"160\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20d1.png\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20d1.png\" height=\"160\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20l2.png\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20l2.png\" height=\"160\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20d2.png\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20d2.png\" height=\"160\"\u003e\u003c/a\u003e\n\u003c!-- \u003c/p\u003e\n\n\u003cp align=\"center\"\u003e --\u003e\n  \u003ca href=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20l3.png\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20l3.png\" height=\"160\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20d3.png\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20d3.png\" height=\"160\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20l4.png\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20l4.png\" height=\"160\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20d4.png\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/noembryo/KoHighlights/master/screens/screen%20d4.png\" height=\"160\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003c!-- ![HighLights ScreenShot](screen1.png) --\u003e\n\u003c!-- ![HighLights ScreenShot](screen2.png) --\u003e\n\u003c!-- ![HighLights ScreenShot](screen3.png) --\u003e\n\n___\n\n# [Full User Guide and Documentation](https://noembryo.github.io/KoHighlights/)\n___\n\n## Usage/Features at a glance\n\n\n* Load items by:\n    * Selecting the reader's drive or any folder that contains books that where opened with Koreader. This will automatically load all the metadata files from all subdirectories.\n    * Drag and drop files or folders. This will load the files and/or all the files inside the folders.  \n* Export the highlights of the selected books to individual files or to one merged file.\n* Supported formats for exporting:\n    * Plain text files (.txt)\n    * Hypertext document files (.html)\n    * Comma-separated values files (.csv)\n    * Markdown files (.md)\n* View the highlights and various info for a book by selecting it in the list.\n* Save the highlights to the \"Archive\" database and view them, even if your reader is not connected.\n* Merge highlights/Sync position from the same book that is read in different devices and/or sync its reading position.\n* Merge highlights/Sync position of a book with its archived version.\n* Show/hide the page, date, chapter or even the highlight (!) text while viewing or exporting the highlights of the books. \n* Double click or press the Open Book button to view the book in your system's reader.\n* Delete some or all the highlights of any book.\n* Clear/reset the .sdr folders with the metadata or the books in the eReader.\n\n### Prerequisites  \nThe progress sync plugin must be enabled in KOReader\n\n### Portable\nIn Windows, KOHighlights can run in Portable mode using a `portable_settings` directory to store its settings, that is located inside the installation directory of the app.  \nBecause of this, it is advised to not install the app inside the default `Program Files` folder if you indent to use it as portable.  \nThere are two ways to start the app in Portable mode:\n* Run the `KoHighlights Portable.exe` that is located next to the `KoHighlights.exe`.  \n* Run `KoHighlights.exe` with a `-p` argument.  \nE.g. create a shortcut for the `KoHighlights.exe` and add a space and a `-p` argument at the end of the target filename.\n\n## Downloads\nCheck the latest release on the [Downloads Page][ReleaseLink].  \nRead the version history at [App's Page](http://www.noembryo.com/apps.php?kohighlights).\n\n## Dependencies\n* **Source code:**  \nShould run in any system with Python 3.6+ (more testing required)  \nIt needs the [PySide2](https://pypi.org/project/PySide2/),\n[BeautifulSoup4](https://pypi.org/project/beautifulsoup4/),\n[packaging](https://pypi.org/project/packaging/) and\n[requests](https://pypi.org/project/requests/) libraries.  \nIn Windows, it might also need the [PyWin32](https://pypi.org/project/PyWin32/) and the [Pypiwin32](https://pypi.org/project/pypiwin32/) libraries.\nPySide6 is also supported (download the archive from the releases)\n* **Compiled binaries:**  \n  * ***Windows***:  \n  From version 2.x, KOHighlights dropped support for Windows XP.  \n  Can run on any version of Windows from Windows 7 upwards.  \n  For Windows 7, Microsoft Visual C++ 14.0 is required. Get it \n  [here](https://aka.ms/vs/17/release/vc_redist.x86.exe).  \n  The Windows 7 32bit version also needs the KB2533623 update that is included in [KB3063858](https://www.microsoft.com/en-us/download/details.aspx?id=47409) ([direct link](https://download.microsoft.com/download/C/9/6/C96CD606-3E05-4E1C-B201-51211AE80B1E/Windows6.1-KB3063858-x86.msu)).  \n  * ***Linux***:  \n  The binary is compiled using Xubuntu 18.04.  \n  Any newer version should work.\n  \n\n\n\n## Extra\nKOHighlights includes SLPPU (a converter between python and lua objects).  \nIf you want it to be globally available, get it from its\n[GitHub's page](https://github.com/noembryo/slppu) or install it with:  \n`pip install git+https://github.com/noembryo/slppu`  \n\n\n\u003c!-- ##### Stargazers over time\n\n[![Stargazers over time](https://starchart.cc/noembryo/KoHighlights.svg)](https://starchart.cc/noembryo/KoHighlights) --\u003e\n\n[Release]:https://img.shields.io/github/release/noembryo/KoHighlights.svg\n[ReleaseLink]:https://GitHub.com/noembryo/KoHighlights/releases/\n[TotalDown]:https://img.shields.io/github/downloads/noembryo/KoHighlights/total.svg\n[VersionDown]:https://img.shields.io/github/downloads/noembryo/KoHighlights/v1.2.2.0/total.svg\n[Python]:https://img.shields.io/badge/Made%20with-Python-1f425f.svg\n[OS]:https://img.shields.io/badge/OS-Windows\u0026nbsp;/\u0026nbsp;Linux-darkgreen.svg\n[MIT]:https://img.shields.io/badge/License-MIT-green.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoembryo%2Fkohighlights","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnoembryo%2Fkohighlights","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoembryo%2Fkohighlights/lists"}