An API for reading comic archives
Project description
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.
- optionally PDF Metadata.
- A variety of filename schemes that encode metadata.
Installation
pip install comicbox
Comicbox supports PDFs as an extra when installed like:
pip install comicbox[pdf]
Dependencies
Comicbox generally works without any binary dependencies but requires unrar
be on the path to convert CBR into CBZ or extract files from CBRs.
⌨️ Usage
API
Comicbox's primary purpose is as a library for other programs with comicbox.comic_archive as the primary interface.
Console
Type
comicbox -h
see the CLI help.
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.
🤔 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.
Project details
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.
Source Distribution
Built Distribution
Hashes for comicbox-0.10.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80a1360d8ced4729ca68c950af319b91ee76ea633c596a7c42d60eec35a85093 |
|
MD5 | 4a7f1ea9e82660dcb2e757bd2fbd5319 |
|
BLAKE2b-256 | 84f650096224a652deb119fb94bed7ef5e1413b2263621485fcadd6936f37716 |