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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: epub-reader-1.0.0.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.0.tar.gz
Algorithm Hash digest
SHA256 241d77ff73b959635560be1b136eb94de3e796ac640242e9859f3d891e5421cb
MD5 a81cc498648499af1bb29799d6016db9
BLAKE2b-256 a43732a6d56338c641a2dd98de2af1868737612a59ac3ece186921ee96b864d4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: epub_reader-1.0.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 767674623156af1b8361422bbd1b033f6db111b9d1710fbda518b263bdebeeaf
MD5 0435bbf7b77c0c4f57826a7cd646ef69
BLAKE2b-256 8a511552bebe7c7f6e3686f9410c7d60093d9aaae5619078dd16dc539d2daf7f

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