Skip to main content

Python CLI Epub reader with page navigation, bookmarks management, search management, save pages and book to text files and reading sessions to save and load your current progress

Project description

Python CLI EPUB Reader

Python CLI Epub reader with page navigation, bookmarks management, search management, save pages and book to text files and reading sessions to save and load your current progress

Installation

You can install the package via pip:

pip install epub-reader

Usage

After installation, you can run the EPUB reader from any directory:

epub-reader

This command will scan the current directory for EPUB files and allow you to read them interactively.

Features

  • Scans and lists EPUB files in any directory in which you run epub-reader
  • Reads all HTML/XHTML pages in an EPUB file
  • Extracts and displays title and author from EPUB metadata, and lists them as choices for the user to start reading the contents of the EPUB file
  • Cleans and displays text content
  • Allows navigation through pages with "n" (next), "p" (previous), "sp" (save page), "sb" (save book), "q" (quit), "j" (jump to page), "jp" (jump to percentage), "jb" (jump to bookmark), "db" (delete bookmark), "dab" (delete all bookmarks), "sh" (view search history), "ds" (delete search history), "das" (delete all search history), "al" (adjust lines per screen)
  • Enhanced page lines depending on punctuation rather than HTML parsed content
  • Save a page or the whole EPUB text to a text file .txt
  • Saves reading session including current page, progress, bookmarks, and search history, and loading them so you never lose your progress.
  • Colorized output for enhanced readability
  • Graceful exit using CTRL+C

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

epub-reader-0.0.1.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

epub_reader-0.0.1-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file epub-reader-0.0.1.tar.gz.

File metadata

  • Download URL: epub-reader-0.0.1.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.5

File hashes

Hashes for epub-reader-0.0.1.tar.gz
Algorithm Hash digest
SHA256 ce296a215eaab9cc33634916be8fc0796b700993fb54e42f9716172225dabc87
MD5 59ce17715159222b9b979f0701c731ad
BLAKE2b-256 c3bfa77449122cb6f02557949483936626467431ae42eebf4fc222a346293678

See more details on using hashes here.

File details

Details for the file epub_reader-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: epub_reader-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.5

File hashes

Hashes for epub_reader-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c1f71a4aef44d9c3c42540090b8e26d227f8b7901a8775759d695f27468df69e
MD5 2c493b8c7391a3468d7471e5f48bd87b
BLAKE2b-256 44199ca41e0c2c786f36b1e1d1b99986581adf7648b22a46131e1a9abd412183

See more details on using hashes here.

Supported by

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