Metadata-Version: 2.1
Name: comicbox
Version: 0.1.2
Summary: An API for reading comic archives
Home-page: https://github.com/ajslater/comicbox
License: GPL-2.0-only
Keywords: comic,cbz,cbr
Author: AJ Slater
Author-email: aj@slater.net
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: parse (>=1.15,<2.0)
Requires-Dist: pycountry (>=20.7.3,<21.0.0)
Requires-Dist: rarfile (>=4.0,<5.0)
Requires-Dist: simplejson (>=3.17,<4.0)
Project-URL: Documentation, https://github.com/ajslater/comicbox
Description-Content-Type: text/markdown

# Comicbox

Comicbox is a comic book archive metadata reader and writer. It reads CBR and CBZ archives and writes CBZ archives. It reads and writes the [ComicRack comicinfo.xml format](https://wiki.mobileread.com/wiki/ComicRack#Metadata), the [ComicBookInfo format](https://code.google.com/archive/p/comicbookinfo/) and [CoMet format](https://github.com/wdhongtw/comet-utils).

## API

Comicbox's primary purpose is as a library for other programs with [comicbox.comic_archive](https://github.com/ajslater/comicbox/blob/master/comicbox/comic_archive.py) as the primary interface.

## Console

```sh
comicbox -h
```

to use the CLI.

## Development

run

```sh
./setup.sh
```

to get started.

To run the code you've checked out

```sh
./run.sh -h
```

will run the comicbox cli.

I'll only merge branches to develop that pass

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

And I might require tests for significant new code.

You may automatically fix most simple linting errors with

```sh
./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](https://github.com/ajslater/codex/).

## Alternatives

[Comictagger](https://github.com/comictagger/comictagger) is a better alternative for most purposes at this time. It does everything Comicbox does but also automatically tags comics with the ComicVine API and has a pretty nice desktop UI.

## Future Plans

I may implement ComicVine API tagging, but this library will remain primarily an API for other programs with a console interface.

