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)
    • 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

Although mouse support is useful when running epy on Termux Android, it’s disabled by default since most people find it intrusive when using epy in desktop. But you can enable it by setting MouseSupport to true in config file.

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 and textwidth is not adjustable.

Tip Jar

PayPal

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

Uploaded Source

Built Distribution

epy_reader-2021.7.8-py3-none-any.whl (32.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for epy-reader-2021.7.8.tar.gz
Algorithm Hash digest
SHA256 cfeb9eb9f06a5e5e0f9285d81eaf8252b11071565ef64a18b52a696b591d1fd3
MD5 ffe804641becae49cf24bcfd5e9f37e2
BLAKE2b-256 f03c346222b0b4e0c596c380a69bb85af48f80afd487414a08250f6c8086e7b3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: epy_reader-2021.7.8-py3-none-any.whl
  • Upload date:
  • Size: 32.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/54.2.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.2

File hashes

Hashes for epy_reader-2021.7.8-py3-none-any.whl
Algorithm Hash digest
SHA256 3e833fe6e80f43941949e3915186438d24ae7e269ece3c2be2f8bb2785aa87ff
MD5 f9a66abf485fd5356c1ee816aa2bb8ac
BLAKE2b-256 848cc58e1adfc67b42e61b2d6b798a86601571124b430f65a62fe9b33d9921cf

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