https://github.com/khuei/lire
TUI EPUB Reader
https://github.com/khuei/lire
command-line command-line-tool epub epub-reader python tui
Last synced: 2 months ago
JSON representation
TUI EPUB Reader
- Host: GitHub
- URL: https://github.com/khuei/lire
- Owner: khuei
- License: mit
- Created: 2024-11-03T22:21:58.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-11-09T00:01:44.000Z (11 months ago)
- Last Synced: 2025-06-05T12:08:11.516Z (4 months ago)
- Topics: command-line, command-line-tool, epub, epub-reader, python, tui
- Language: Python
- Homepage:
- Size: 860 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lire
> Lire /ˈlaɪ(ə)r/: to read
## Features
- **EPUB Parsing:** Reads and extracts text from EPUB files.
- **Navigation:** Scroll through the text with arrow keys or `j/k` keys, jump by pages, and navigate between chapters.
- **Text Redaction:** Manually blank out words you already read to keep track of progress.
## Key Bindings
- `UP` / `k`: Scroll up one line.
- `DOWN` / `j`: Scroll down one line.
- `LEFT` / `h`: Go to the previous chapter.
- `RIGHT` / `l`: Go to the next chapter.
- `f`: Scroll forward one page.
- `b`: Scroll backward one page.
- `n`: Move the redaction boundary forward (hiding one word).
- `p`: Move the redaction boundary backward (Revealing last redacted word).
- `SPACE`: Toggle redaction on/off.
- `P`: Reset the redaction boundary.
- `q`: Quit the reader.
## Requirements
- Python 3.6+
- Required Python packages:
- `ebooklib`
- `beautifulsoup4`
- `argparse` (built-in module in most Python3 distributions)
- `curses` (built-in module in most Python distributions)
## Usage
Run the program with the following command:
``` sh
./lire
```