https://github.com/clach04/koreader-to-markdown
clone of https://git.sr.ht/~harmtemolder/koreader-to-markdown
https://github.com/clach04/koreader-to-markdown
koreader markdown
Last synced: 3 months ago
JSON representation
clone of https://git.sr.ht/~harmtemolder/koreader-to-markdown
- Host: GitHub
- URL: https://github.com/clach04/koreader-to-markdown
- Owner: clach04
- License: gpl-3.0
- Created: 2023-08-20T00:27:48.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-20T00:28:03.000Z (almost 2 years ago)
- Last Synced: 2025-01-19T03:16:12.680Z (5 months ago)
- Topics: koreader, markdown
- Language: Python
- Homepage: https://git.sr.ht/~harmtemolder/koreader-to-markdown
- Size: 32.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KOReader to Markdown
Read bookmarks from [KOReader](https://koreader.rocks/) sidecars to Markdown files per book, prefixed with the date you added the most recent bookmark
## How-to
2. Run `pipenv install` to install all dependencies from `Pipfile`
- [Install `pipenv`](https://github.com/pypa/pipenv#installation) if you
don't have it yet
1. Run `make` to download `slpp.py`
3. Start your KOReader's SSH server without a password and make note of its IP address
4. Make sure you can connect to it using `ssh` from your terminal. See
[this](https://github.com/koreader/koreader/wiki/SSH) for more info
5. Rename `example.env` to `.env` and add the host (IP address) and user (typically `root`) of your KOReader's SSH
6. Run `koreader-to-markdown.py`
1. If your SSH key requires a passphrase, you will be prompted
7. Copy the result from `output` to your [Obsidian](https://obsidian.md/) vault, or wherever you want to have your highlights as Markdown
## Credits
- [`paramiko`](https://www.paramiko.org/) to read your KOReader's sidecars over SSH
- [`python-dotenv`](https://github.com/theskumar/python-dotenv) to read the contents of `.env`
- [`inquirer`](https://github.com/magmax/python-inquirer) to ask for your SSH key's passphrase, if needed