Skip to main content

Terminal/CLI Ebook (epub, fb2, mobi, azw3) Reader

Project description

$ epy

screenshot

CLI Ebook Reader.

This is just a fork of my own epr with these extra features:

  • Supported formats:
    • Epub (.epub, .epub3)
    • FictionBook (.fb2)
    • Mobi (.mobi), but image is not supported in mobi
    • AZW3 (.azw3), some but not all (see KindleUnpack)
  • Reading progress percentage
  • Bookmarks
  • External dictionary integration (sdcv or dict)
  • Inline formats: bold and italic (depend on terminal and font capability. Italic only supported in python>=3.7)
  • Text-to-Speech (with additional setup, read below)
  • Double Spread

Installation

Via PyPI

$ pip3 install epy-reader

Via Pip+Git

$ pip3 install git+https://github.com/wustho/epy

Reading Tips Using Epy

When reading using epy you might occasionally find triple asteriks ***. That means you reach the end of some section in your ebook and the next line (right after those three asteriks, which is in new section) will start at the top of the page. This might be disorienting, so the best way to get seamless reading experience is by using next-page control (space, l or Right) instead of next-line control (j or Down).

Configuration File

Config file is available in json format which is located at:

  • Linux: ~/.config/epy/config.json or ~/.epy/config.json
  • Windows: %USERPROFILE%\.epy\config.json

Although, there are not many stuffs to configure.

Using Mouse

Pretty useful when running epy on Termux Android.

Key Action
Left Click (right side of screen) next page
Left Click (left side of screen) prev page
Right Click ToC
Scroll Up scroll up
Scroll Down scroll down
Ctrl + Scroll Up increase text width
Ctrl + Scroll Down decrease text width

Text-to-Speech

To get Text-to-Speech (TTS) support, you need to install these external dependencies:

  • pico2wave (from libttspico-utils package (Ubuntu) or svox-pico-bin package (AUR))
  • play (from sox package)

eg.

$ # Ubuntu
$ apt install libttspico-utils sox

$ # Arch
$ yay -S svox-pico-bin
$ pacman -S sox

And then make sure pico2wave and play is in $PATH.

Double Spread

Double spread is intended to mimic the behaviour of real book, so line scrolling navigation will act as scrolling page.

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

epy-reader-2021.2.3.tar.gz (21.2 kB view details)

Uploaded Source

Built Distribution

epy_reader-2021.2.3-py3-none-any.whl (32.1 kB view details)

Uploaded Python 3

File details

Details for the file epy-reader-2021.2.3.tar.gz.

File metadata

  • Download URL: epy-reader-2021.2.3.tar.gz
  • Upload date:
  • Size: 21.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for epy-reader-2021.2.3.tar.gz
Algorithm Hash digest
SHA256 9c2258fedd552bdf735bdb93e959017af11297a448edf4db250e5098587b820a
MD5 44b414e11e83e19f3f204d4b3a01c4c7
BLAKE2b-256 961a7a8684a5d8ee733e4050159acec3e104a475cd78ae026ca430e3a6aca0df

See more details on using hashes here.

File details

Details for the file epy_reader-2021.2.3-py3-none-any.whl.

File metadata

  • Download URL: epy_reader-2021.2.3-py3-none-any.whl
  • Upload date:
  • Size: 32.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for epy_reader-2021.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9aaf4be6d6022a561f7bcd6cbddce39583064a2c9363187cb10191b25b2a60b6
MD5 2ab1a1f3c31baf93ef92d0671f51aad8
BLAKE2b-256 2ab8e43b5d7afb6b99bbe6f7e6932bccd4311ce143f9620f6eefe1cdd3eb1a47

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