comicbox 0.5.5

An API for reading comic archives

Comicbox

A comic book archive metadata reader and writer. It reads CBZ, CBR, and CBT archives and writes CBZ archives. It reads and writes the ComicRack comicinfo.xml format, the ComicBookInfo format and CoMet format.

⌨️ Usage

API

Comicbox's primary purpose is as a library for other programs with comicbox.comic_archive as the primary interface.

Console

comicbox -h

to use the CLI.

Config

comicbox accepts command line arguments but also an optional config file and environment variables.

The variables have defaults specified in a default yaml

The environment variables are the variable name prefixed with COMICBOX_. (e.g. COMICBOX_COMICINFOXML=0)

Log Level

change logging level:

LOGLEVEL=ERROR comicbox -p <path>

🛠 Development

run

./setup.sh

to get started.

To run the code you've checked out

./run.sh -h

will run the comicbox cli.

I'll only merge branches to develop that pass

./lint.sh
./test.sh
./build.sh

And I might require tests for significant new code.

You may automatically fix most simple linting errors with

./fix-linting.sh

🤔 Motivation

I didn't like Comictagger's API, so I built this for myself as an educational exercise and to use as a library for Codex comic reader.

👍🏻 Alternatives

Comictagger is a better alternative for most purposes. It does everything Comicbox does but also automatically tags comics with the ComicVine API and has a pretty nice desktop UI.