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.5.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.5-py3-none-any.whl (29.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ebops-0.3.5.tar.gz
Algorithm Hash digest
SHA256 4955d441cf790ae0c14374fe7b89e0ccbdad03e46e3e44231cdcc1893195a2aa
MD5 c925aa29a8a4ba0d508291071ca06c62
BLAKE2b-256 8dbd56686878bc3d1f656bd2392822d99caaacd15e21bf64e8690669004547cd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ebops-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 29.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.2

File hashes

Hashes for ebops-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8f9aca6aca11511140bdba7d4da59e67c24e887ca9420dd10432395fdf16f5b9
MD5 377bf6d19b9de2849c3fe4bd7a4d929c
BLAKE2b-256 7feacfd9c87dfe306e160faacd755e85f66eb3e8480d9253cb89e7d38519045f

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