#pdf #cli-parser #terminal #parser

bin+lib cli-epub-to-text

A CLI epub to plain text converter

12 releases

Uses new Rust 2024

0.1.13 Feb 20, 2025
0.1.12 Feb 16, 2025
0.1.11 Nov 26, 2024
0.1.6 Oct 19, 2024
0.1.2 Jul 21, 2024

#2836 in Parser implementations

Download history 14/week @ 2024-12-01 18/week @ 2024-12-08 16/week @ 2024-12-15 96/week @ 2024-12-22 13/week @ 2024-12-29 20/week @ 2025-01-05 10/week @ 2025-01-12 4/week @ 2025-02-02 18/week @ 2025-02-09 254/week @ 2025-02-16 31/week @ 2025-02-23 29/week @ 2025-03-02 2/week @ 2025-03-09 5/week @ 2025-03-16

84 downloads per month
Used in 3 crates

AGPL-3.0

8KB

hygg

Simplifying the way you read

Overview

The goal of this project is to build an ebook and document reader that has a minimal set of features, that make reading enjoyable on a desktop computer.

A large emphasis is on making a minimalistic and distraction free environment for you to easily focus on what is important, the content.

Furthermore we are working on building a seamless experience for reading ebooks but also more generally documents, both on a desktop computer and a tablet or e-reader with a browser.

Features

  • CLI client
    • Converts regular or scanned PDF or EPUB to plain text
    • Justifies the plain text to specified column width
    • Horizontally centers the text
    • Minimalistic less like interactive reader with vim like bindings (still work in progress)
    • Saves progress
    • Cross platform
    • Each component in the CLI client is exposed as a UNIX style utility for easy code reuse in your own open source project

Quick start guide

Install the CLI client

cargo install --locked hygg
hygg doc.pdf

for scanned document support

sudo apt install ocrmypdf tesseract-ocr-eng

then use the --ocr=true flag

hygg --ocr=true doc.pdf

For further install instructions read the Getting started page

Documentation

Visit the Documentation

Roadmap

  • Plain text format support
  • PDF format support
  • EPUB format support
  • Convert scanned documents and images to plain text with ocrmypdf
  • Auto saving progress
  • Integrated command line with vim like commands
  • Server to sync progress and books
  • Text highlighting with server sync
  • Start screen to show overview of books and progress
  • Full test suite
  • CI / CD pipelines
  • Minimal build feature flag, for only basic converters, no server integration and no ai
  • Image to ascii art converter
  • Natural sounding ai voice model for text to speech narration
  • Run all inference directly in rust
  • Offline PWA web client
  • Support more ebook and document formats

Dependencies

~9–15MB
~180K SLoC