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)

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.

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

Uploaded Source

Built Distribution

epy_reader-2021.2.2-py3-none-any.whl (31.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: epy-reader-2021.2.2.tar.gz
  • Upload date:
  • Size: 20.6 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.2.tar.gz
Algorithm Hash digest
SHA256 cdb12709afd426341f8a357b200445735ea0ffd97d70a8cff63570005215c2ea
MD5 5ff1c89f5d6647e6d1a4a56b542b6012
BLAKE2b-256 af49ffc484316fc8da3e54e0d3c40f01486f6556651272b90c6e7ae2f53083d3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: epy_reader-2021.2.2-py3-none-any.whl
  • Upload date:
  • Size: 31.7 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ef143008e4d1757ae2472477f8bd049cad9b5f4611945f646205deda2fa2e7a9
MD5 bb01719ca2d782bf9c325a686b8637f9
BLAKE2b-256 00cac631978433ac3a50ecc2f1ca02304adcc306b6a36eb73bd9c3d18d41103a

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