grimmoire

A small terminal spellbook for Library Genesis: search, stream a book to a temp cache, open it in zathura for a quick read, then either keep it in a persistent collection folder or discard it.

  • Type-to-filter TUI for picking from search results.
  • Books stream to a temp cache first; only kept on explicit confirmation.
  • Two-tier storage: ephemeral cache + persistent collection (XDG-compliant).
  • Top-level menu: search / browse / delete.

Requirements

  • Python 3.10+
  • zathura installed at the system level (via your package manager)

Installation

pipx keeps grimmoire in an isolated venv but exposes the grimmoire command on your PATH:

pipx install grimmoire

Or with pip:

pip install --user grimmoire

To install from a working copy of this repo (e.g. for development), see DEVELOPING.md.

Usage

grimmoire

Then choose what to do from the menu:

  1. Search Library — search, pick a book (preferring EPUB), download, open in zathura. After reading, choose Keep (default) or Discard.
  2. Browse my collection — pick a saved book, open in zathura. After reading, choose Delete (default: keep).
  3. Delete from collection — pick a saved book, confirm, delete. (No zathura; for batch pruning without re-reading each one.)

Ctrl+C cancels any prompt.

Storage

Storage follows the XDG Base Directory Specification:

  • Cache (in-flight downloads): $XDG_CACHE_HOME/grimmoire/tmp/ (default ~/.cache/grimmoire/tmp/)
  • Collection (kept books): $XDG_DATA_HOME/grimmoire/library/ (default ~/.local/share/grimmoire/library/)

The collection folder is created automatically on first use.

License

GPLv3

Project links

Data verified by PyPI on
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for f2e6 from gravatar.com f2e6

Credits

Author: grimmoire contributors

GitHub Statistics

Data verified by PyPI on 
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

GNU General Public License v3 or later (GPLv3+) (GPL-3.0-or-later)

Requires

Python >=3.10

Provides Extra

test

Tags

libgen tui zathura ebook cli

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

grimmoire-0.1.0.tar.gz (21.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

grimmoire-0.1.0-py3-none-any.whl (20.7 kB view details)

Uploaded Python 3

File details

Details for the file grimmoire-0.1.0.tar.gz.

File metadata

  • Download URL: grimmoire-0.1.0.tar.gz
  • Upload date:
  • Size: 21.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for grimmoire-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a5343b80ca9f4cd8cd7205005770d2f53565efa1f4e584e48bd60f343e925419
MD5 0054af10dd47e3a7caa57c0ed8abeffb
BLAKE2b-256 41bd92a47d458a2318de067d0912c88a9f06436db6de5dad09b8fe9123d77f82

See more details on using hashes here.

Provenance

The following attestation bundles were made for grimmoire-0.1.0.tar.gz:

Publisher: publish.yml on f2e6/grimmoire

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file grimmoire-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: grimmoire-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 20.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for grimmoire-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4711bea0870f5dd37d4774d52c84dc44b2377ac9bd8b3256bffd12a63a24fab3
MD5 9fc5bf10d84bbf9c7804fe2ddb10dd0b
BLAKE2b-256 dff149c20237e7ae39e20150bb005f8c7635f13b7f46205b84c55fea192150c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for grimmoire-0.1.0-py3-none-any.whl:

Publisher: publish.yml on f2e6/grimmoire

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page