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-1.0.2.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

epub_reader-1.0.2-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for epub-reader-1.0.2.tar.gz
Algorithm Hash digest
SHA256 f21b9dd5fd919f7a66c276de981503470d0218502d7222ab043e691f4f1d4b72
MD5 3ffe383fa5d68ba87725ba74e5bbccc9
BLAKE2b-256 db78501cc701247a19140e37fc708b3f643c663bc93bd039e9d347a08385f35e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: epub_reader-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 7.4 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-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 301b240acf3109e50206a3eea73715a74a2d11df078d2c0e0f16f9b63e7c6bc7
MD5 a45be9adaa9fc25ac333e5fc1d0d9c66
BLAKE2b-256 cd76782e5652c9246300f2ee1fd807bfdc8a45e3dea8fc6d82622dfff479c23a

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