Perdoo

Perdoo helps organise comic collections using metadata stored within comic archives.

It standardises digital comics into a consistent format and can add or update metadata using supported services.

Unlike fully automated tagging tools, Perdoo takes a manual approach when metadata is unavailable. When necessary, it prompts for Publisher, Series, and Issue details that can be used to search supported metadata services.

Installation

Pipx

1. Ensure Pipx is installed:

   pipx --version
   

2. Install Perdoo:

   pipx install perdoo
   

Usage

Supported Formats

Metadata Files

Metadata file support is provided by shortbox, which currently supports:

• ComicInfo v2.0 (with field ordering ignored)
• MetronInfo v1.1

Services

• Comicvine using the Simyan library.
• Metron using the Mokkari library.

File Renaming and Organization

Perdoo uses a pattern-based approach for naming and organizing files.

Metadata is taken from MetronInfo when available, with ComicInfo used as a fallback.

The default pattern is:

{publisher-name}/{series-name}-v{volume}/{format}/{series-name}-v{volume}_#{number:3}

Pattern Options

Padding

Integer and integer-like fields, such as {number}, support optional zero-padding by specifying a length.

For example: {number:3} produces 012 from 12

Sanitization

Metadata values are sanitized to remove characters outside:

0-9a-zA-Z&!-

Custom characters can still be added directly to patterns.

Pattern Keys

Settings

Perdoo's settings are stored in:

~/.config/perdoo/settings.toml

The file is created automatically on first run.

Example

[output]
folder = "~/.local/share/perdoo"
format = "cbz"
image-extensions = [".png", ".jpg", ".jpeg", ".webp", ".jxl"]

[output.comic-info]
create = true
handle-pages = true

[output.metron-info]
create = true

[output.naming]
seperator = "-"
pattern = "{publisher-name}/{series-name}-v{volume}/{format}/{series-name}-v{volume}_#{number:3}"

[services]
order = ["Metron", "Comicvine"]

[services.comicvine]
api-key = "<Comicvine API Key>"

[services.metron]
token = "<Metron Token>"

[sync]
days = 28
cover-hash-distance = 10

Output

output.folder

The folder where output files are stored.

Defaults to:

~/.local/share/perdoo/comics

output.format

The output format used for comic archives.

Defaults to cbz.

See Supported Formats for available formats.

output.image-extensions

The file extensions Perdoo considers to be images during the clean-up step.

Defaults to:

[".png", ".jpg", ".jpeg", ".webp", ".jxl"]

ComicInfo

output.comic-info.create

Whether to create a ComicInfo.xml file in the output archive.

Defaults to true.

output.comic-info.handle-pages

Whether to process page data in ComicInfo.xml.

Defaults to true.

MetronInfo

output.metron-info.create

Whether to create a MetronInfo.xml file in the output archive.

Defaults to true.

Naming

output.naming.seperator

The separator used in generated file names.

Defaults to -.

Supported values are:

• -
• _
• .
• (space)

output.naming.pattern

The pattern used to generate output file names and directories.

See File Renaming and Organization for available pattern fields.

Services

services.order

The order in which services are queried for metadata.

Perdoo uses the first service that returns a result. Services can be omitted from this list to disable them.

Defaults to:

["Metron", "Comicvine"]

Supported services:

• Metron
• Comicvine

Sync

sync.days

The number of days before an archive with existing MetronInfo is synchronised again.

Defaults to 28.

sync.cover-hash-distance

The maximum Hamming distance accepted when matching an archive cover.

Defaults to 10. Supported values range from 0 to 64.

Socials