gutenbit 0.1.12

Fast local search across public-domain literary works

A command line tool for fast local search across public-domain literary works.
Find, browse and search books from your terminal.

CLI Install

Try the latest stable release from PyPI without a persistent install:

uvx gutenbit --help

Or install it like this and then run gutenbit --help:

uv tool install gutenbit

gutenbit stores its database and catalog cache in ~/.gutenbit/.

CLI Example

Find a book in the Project Gutenberg catalog and download it locally. Sections are parsed automatically during import.

gutenbit catalog --author "Austen, Jane"
gutenbit add 1342

Inspect the table of contents, read the opening, or jump into a section. If a book is missing locally, gutenbit toc <id> adds it automatically first.

gutenbit toc 1342
gutenbit view 1342
gutenbit view 1342 --section 1 --forward 5

Search within the book and read exact matches or nearby context.

gutenbit search "truth universally acknowledged" --book 1342 --phrase
gutenbit search "bennet" --book 1342 --limit 3 --radius 1

All commands support --json for machine-readable output. CLI-managed state is stored under ~/.gutenbit/ by default, including the database at ~/.gutenbit/gutenbit.db and the catalog cache under ~/.gutenbit/cache/.

Python

gutenbit can also be used as a python module. Add it to your project with:

uv add gutenbit

from gutenbit import Catalog, Database

catalog = Catalog.fetch()
book = catalog.get(1342)

if book is not None:
    with Database("~/.gutenbit/gutenbit.db") as db:
        db.ingest([book])
        for hit in db.search("truth universally acknowledged", book_id=1342):
            print(hit.title, hit.div1, hit.content[:80])

Documentation

Full documentation: Getting Started | CLI | Python API | Concepts

Project Gutenberg Access

gutenbit is an open-source project not affiliated with Project Gutenberg. It is for individual downloads, not bulk downloading. It prefers official mirrors and uses the main site only as a zip fallback, with a default 2.0 second delay between downloads. gutenbit also sends an identifying default User-Agent on Gutenberg and PGLAF requests: gutenbit/<version> (+https://gutenbit.textualist.org). Review Project Gutenberg's Robot Access Policy and Terms of Use.

Development

uv run pytest                    # fast local suite (excludes live Gutenberg downloads)
uv run pytest -m network         # live parser regression corpus against Gutenberg
uv run ruff check .              # lint
uv run ruff format --check .     # format check
uv run ty check                  # type check

License

MIT