comicbox 0.9.0

An API for reading comic archives

Comicbox

A comic book archive metadata reader and writer.

📚Comic Formats

Comicbox reads CBZ, CBR, and CBT archives and writes CBZ archives.

🏷️ Metadata Formats

Comicbox reads and writes:

• ComicRack Comicinfo.xml v2.1 (draft),
  • Also, an unofficial, undocumented Mylar extension to ComicInfo.xml that encodes multiple Story Arcs and Story Arc Numbers as CSV values.
• ComicBookInfo format
• CoMet format.
• A variety of filename schemes that encode metadata.

⌨️ 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

You may access most development tasks from the makefile. Run make to see documentation.

Dependencies

Comicbox generally works without any binary dependencies but requires unrar be on the path to convert CBR into CBZ.

🤔 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.