Skip to main content

Manage e-book and org files to make analytical reading easy

Project description

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

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

ebops-0.3.7.tar.gz (3.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ebops-0.3.7-py3-none-any.whl (29.2 kB view details)

Uploaded Python 3

File details

Details for the file ebops-0.3.7.tar.gz.

File metadata

  • Download URL: ebops-0.3.7.tar.gz
  • Upload date:
  • Size: 3.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for ebops-0.3.7.tar.gz
Algorithm Hash digest
SHA256 e48dc98a769af32fc94213e8a9ff0102f3fd2c70302822138d2cc565d22b4c1c
MD5 4b4198bf488abadea22a627972f0f77f
BLAKE2b-256 0e2531bd403704b35837abf84811f4859e55095977ec91fef7202c1f7bc0559a

See more details on using hashes here.

File details

Details for the file ebops-0.3.7-py3-none-any.whl.

File metadata

  • Download URL: ebops-0.3.7-py3-none-any.whl
  • Upload date:
  • Size: 29.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for ebops-0.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 2940e60a1b7cdc3f2049ea6fed343eebb6f869cc57d0163ff647cab38bed339c
MD5 99dec889162a8dbbbdff86b5c997ed64
BLAKE2b-256 8368119f1eb61e52cde9ace99cbff00df21f5ed531cd83af57093b9a70704d42

See more details on using hashes here.

Supported by

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