pinnaculum / gemgemgem

Gemalaya (gemini browser written in QML), Ebooks (gempub and epub) viewer, toolkit to work with gempub archives

gemgemgem

gemgemgem (can be heard as "J'aime j'aime j'aime", meaning "I love i love i love" in French) is a collection of Gemini apps and tools written in Python. It includes:

• gemalaya: a keyboard-driven Gemini browser written in QML (Download AppImage)
• gemv: a small Gempub viewer
• gempubify: a program to convert epub ebooks to gempub archives

Gemalaya

Download Gemalaya's latest AppImage (x86_64) Be sure to have all the xcb libraries installed before running the AppImage (run with QT_DEBUG_PLUGINS=1 if you get an error the xcb plugin failing to load)

Gemalaya is a keyboard-driven Gemini browser written in QML (PySide6). Links can be navigated from the keyboard using simple key sequences. Each link in a gemini page is assigned a number. To follow a link, just type in the number of the link on the keyboard.

Gemalaya supports the automatic proxying of web (http/https) and dweb content by running an instance of levior. When levior is running, web URLs referenced in gemtext documents are served through the web-to-gemini proxy. It also supports Text-to-speech.

Please visit gemalaya's website for more!

Install

Download the AppImage or install it with:

pip install '.[gemalaya,gemalaya-http-proxy]'
python setup.py build_gemalaya install

Start the browser by running the gemalaya command.

Convert an epub to gempub

To convert an ebook in the epub format to a gempub archive, use the gempubify command:

gempubify book.epub

gempubify -o gembook.gpub book.epub

You can also create gempub archives by passing the path of a project file, formatted in YAML.

gempubify -o manual.gpub docs/gemv/manual/manual.yaml

See the manual's project file for an example.

If you have access to an IPFS (kubo) daemon and want to import the gempub file to IPFS, use --ipfs-import. The CID of the directory containing the gempub will be printed on the console.

gempubify --ipfs-import book.epub

Gemv

Download GemV's latest AppImage (x86_64)

gemv is a basic gempub viewer written with the Kivy UI library. It can also open ebooks in the epub format by converting them on-the-fly to the gempub format.

To install and run the gempub viewer (GemV), use the following commands:

pip install '.[gemv]'

gemv