lyz/ebops
1
0
Fork 0
Code Issues Pull requests Activity
tool designed for managing e-books and Org-mode files to facilitate analytical reading.
42 commits 11 branches 12 tags 3.3 MiB
  • Python 90.9%
  • Shell 3.9%
  • SQLPL 2.7%
  • Makefile 2.4%
  • Jinja 0.1%
Find a file
lyz a673dd20cf
 bump: version 0.3.6 → 0.3.7
2025-06-19 21:29:00 +02:00
.forgejo/workflows feat: add first version to extract epub data 2024-08-09 19:53:41 +02:00
.scripts chore: update template 2024-11-09 14:06:34 +01:00
src/ebops bump: version 0.3.6 → 0.3.7 2025-06-19 21:29:00 +02:00
tests fix: add robustness on the adding of notes 2025-06-19 21:28:12 +02:00
.copier-answers.yaml chore: update template 2024-11-09 14:06:34 +01:00
.gitignore fix: add pydantic dependency 2024-08-09 20:53:08 +02:00
.pre-commit-config.yaml initial commit 2024-08-09 10:53:56 +02:00
CHANGELOG.md bump: version 0.3.6 → 0.3.7 2025-06-19 21:29:00 +02:00
LICENSE initial commit 2024-08-09 10:53:56 +02:00
Makefile chore: update template 2024-11-09 14:06:34 +01:00
pdm.lock chore: update dependencies and template 2024-11-09 14:24:49 +01:00
pyproject.toml bump: version 0.3.6 → 0.3.7 2025-06-19 21:29:00 +02:00
README.md refactor: change the project name to ebops 2024-08-10 13:15:10 +02:00

README.md

Ebops

Eborg is a tool designed for managing e-books and Org-mode files to facilitate analytical reading. With Eborg, you can load EPUB documents, update Org-mode files with table of contents (TOC), and export highlights from your e-books.

Installing

You can install Eborg using pip:

pip install ebops

Usage

After installing Eborg, you can use the command-line interface (CLI) to perform various tasks. The CLI is accessed via the ebops command.

Commands

load

Mount an e-reader, upload an EPUB document, and update an Org-mode file with the TOC. This can be useful to be synced to Orgzly so you can add notes on the different document chapters.

ebops load [OPTIONS] EPUB_PATH [MOUNT_POINT] [BOOKS_ORGMODE_PATH]
  • EPUB_PATH: Path to the EPUB document to load.
  • MOUNT_POINT (optional): Directory where the e-reader should be mounted. Defaults to /tmp/ebook.
  • BOOKS_ORGMODE_PATH (optional): Path to the Org-mode file to update. Defaults to the environment variable BOOKS_ORGMODE_PATH if not provided.

export_highlights

Export highlights from an EPUB to an Org-mode file.

ebops export_highlights [OPTIONS] EPUB_PATH [MOUNT_POINT] [LEARN_ORGMODE_PATH]
  • EPUB_PATH: Path to the EPUB file inside the mount point.
  • MOUNT_POINT (optional): Mount point where the e-reader is connected. Defaults to /tmp/ebook.
  • LEARN_ORGMODE_PATH (optional): Path to the Org-mode file to save highlights. Defaults to the environment variable LEARN_ORGMODE_PATH if not provided.

Options

  • --version: Show the version of the tool.
  • --verbose, -v: Enable verbose logging.

License

This project is licensed under the GNU General Public License v3.0 (GPLv3).

Authors

  • Lyz