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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ebops-0.3.2.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.2.tar.gz
Algorithm Hash digest
SHA256 4190e9e89caba7b8884d9ac1379442668b50089f1c228ed1108414eca69eeafd
MD5 3c6f69e70c6a1188b4e88f79e080658e
BLAKE2b-256 24c203994c90a9a2eff1e10e1cada935babf651e4ee7af3cae5b3501657f24de

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ebops-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 28.8 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2110e8494a4ad0ebea04f6e0e4b4a7708752d97d4104443aa193df55eca1b76f
MD5 fcf14c90436e10c1d6a384bfe5fb0a40
BLAKE2b-256 a2eea9008f8e2b87c58644b634ce21361f00ee2f15eb62b55a1878aa0b90b6ab

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