Skip to content

canepan/Oilele

Repository files navigation

GitHub tag (latest by date)

image

tests

Code style: Black

Oilele comic viewer

The project aims to build a Python comic viewer (PDF, CBZ, CBR supported) with multiple output options.

PDF reading is available through pdf2image (which depends on poppler)

As of today, the output can be sent to:

Install

The command pip install Oilele should work, with the following options:

[inky]

to enable Raspberry GPIO Inky output

[rar]

to be able to open cbr archives (requires librar on the O.S.)

To install with all dependencies:

pip install Oilele[rar,inky]

Dependencies can usually installed by your favorite package manager:

Debian based

apt install poppler chafa

Mac

brew install poppler chafa

Usage

Run with (can replace oilala with faccela_vedé or faccela_toccá):

oilala <filename>
(opens <filename> via pygame)
oilala -A <filename> -v
(opens <filename> with Chafa, verbose output)
oilala -I <filename> -p 32
(opens <filename> at page 32 on Inky impressions)

Notes and dependencies

The -A option (--ascii) is only available if you have Chafa installed (minimum 1.2 which has the -f option). Alternatives to pdf2image (which depends on poppler) being considered:

  • PyMuPDF, it includes support for CBZ and some epub formats. Depends on the MuPDF library
  • pikepdf, depends on the QPDF CLI

Please report any problem via the GitHub issues feature, with possible solutions, or even pull requests if appropriate.