Skip to main content

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

Project description

$ epy

Downloads

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
    
  • Via AUR

    $ yay -S epy-git
    

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

https://paypal.me/wustho

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

Uploaded Source

Built Distribution

epy_reader-2021.7.16-py3-none-any.whl (32.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for epy-reader-2021.7.16.tar.gz
Algorithm Hash digest
SHA256 23cf70ce4b2a60b7e8e35afb5609c9a0d2565be7000bf6f0fa69c6156e8efe74
MD5 514bfac0f087ad7e66dae4759f17b140
BLAKE2b-256 297e79be0c1bc391da8f72e3ecd57e81f7f5581ea488e56f9b1eb42624b9c038

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for epy_reader-2021.7.16-py3-none-any.whl
Algorithm Hash digest
SHA256 9657eccb3a8d9f96c64f923fbc904bc0b11f15afdf5854b3c2595638647d679d
MD5 17d3eb902f49d3efb79343e3ecdefa98
BLAKE2b-256 a40110b0c5bb88f9991551fcc593208b72048101a247dcb6a3b42528e0d9fb36

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