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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: epub-reader-1.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-1.0.1.tar.gz
Algorithm Hash digest
SHA256 bc7ddc78245bf6aced6810ff74af77e59973e6d8cde7474dd6c6da15cf94069d
MD5 dab8a92601fe43e9dad111a23adbe675
BLAKE2b-256 97c9683638ef9e945a2a68d3440ffac1b528c1ec09d2e0b6b68639a068b0893f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: epub_reader-1.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-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8be73dfc25310887679e3ef0ec77c93f06e6604ab479ac27d0308e31fabd3a9a
MD5 534e2977389558a6d9106aa641cb11c5
BLAKE2b-256 ffeb91b527eaf1f81d37442a8005d935840a619a10f69f703f295a72ebbf795e

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