CLI Ebook Reader.

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

• Supported formats:
  • Epub (.epub, .epub3)
  • FictionBook (.fb2)
  • Mobi (.mobi)
  • AZW3 (.azw, .azw3)
  • URL
• 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)

• Via PyPI

  $ pip3 install epy-reader

• Via Pip+Git

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

• Via AUR

  $ yay -S epy-git

• Windows Binary

  Standalone binary for Windows is available at release page.

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.

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

You can read online books like: short stories, fan fiction, etc. using epy with an url as cli argument. Pretty useful when you want to read with less distraction. epy will also remember your reading progress online.

eg. You can read Moby Dick from gutenberg directly with:

$ epy https://www.gutenberg.org/files/2701/2701-h/2701-h.htm

But note that epy will never be a web browser, it's simply a TUI program to read your favorite fiction stories in the comfort of a terminal. So please do not expect for web browser features to be implemented in epy.

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.

To get Text-to-Speech (TTS) support, external TTS engine is necessary.

List of supported engines:

• mimic
• pico2wave

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.

• v2021.10.23: Major refactoring which harness a lot of new stuff in python>=3.7 and epy won't be backward compatible with older python version and older configuration.

• v2022.1.8: Change in configuration and reading states schema that is not backward compatible. So if error is encountered, deleting the configuration and states file might fix the issue.

• v2022.1.15: Early implementation of URL support, table of contents isn't available for now.

• v2022.1.23: Library implementation: ability to switch ebook from reading history inside epy (default key: R).

• v2022.2.5: Fix process.join() issue for unstarted process.