epy-reader 2022.1.2

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

$ epy

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
• Seamless (disabled by default, read below)

Note on v2021.10.23 and beyond

There happened major refactoring for epy in version v2021.10.23 which harness a lot of new stuffs in python standard libraries starting from python>=3.7, so epy won't be compatible with older python version and won't be backward compatible with older epy configuration and reading states. So if you decide to install this version, you will lose your reading progress with older epy.

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

If you really want to get seamless reading experience, you can set SeamlessBetweenChapters to true in configuration file. But it has its drawback with more memory usage, that's why it's disabled by default.

Configuration File

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

• Linux: ~/.config/epy/configuration.json or ~/.epy/configuration.json
• Windows: %USERPROFILE%\.epy\configuration.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, external TTS engine is necessary.

List of supported engines:

• mimic
• pico2wave

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