An API for reading comic archives
Project description
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
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
