https://github.com/buried-in-code/perdoo

Perdoo's goal is to help sort and organize your comic collection by using the information stored in metadata files inside the comic archives.
https://github.com/buried-in-code/perdoo

comic-info comics comicvine-api command-line marvel-api metadata metron-api metron-info python-3 tagger xml

Last synced: 4 months ago
JSON representation

Perdoo's goal is to help sort and organize your comic collection by using the information stored in metadata files inside the comic archives.

Host: GitHub
URL: https://github.com/buried-in-code/perdoo
Owner: Buried-In-Code
License: mit
Created: 2024-03-14T20:14:43.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-10-10T08:47:23.000Z (7 months ago)
Last Synced: 2024-10-16T22:45:42.767Z (7 months ago)
Topics: comic-info, comics, comicvine-api, command-line, marvel-api, metadata, metron-api, metron-info, python-3, tagger, xml
Language: Python
Homepage:
Size: 210 KB
Stars: 2
Watchers: 1
Forks: 1
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Perdoo

[![PyPI - Python](https://img.shields.io/pypi/pyversions/Perdoo.svg?logo=PyPI&label=Python&style=flat-square)](https://pypi.python.org/pypi/Perdoo/)

[![PyPI - Status](https://img.shields.io/pypi/status/Perdoo.svg?logo=PyPI&label=Status&style=flat-square)](https://pypi.python.org/pypi/Perdoo/)

[![PyPI - Version](https://img.shields.io/pypi/v/Perdoo.svg?logo=PyPI&label=Version&style=flat-square)](https://pypi.python.org/pypi/Perdoo/)

[![PyPI - License](https://img.shields.io/pypi/l/Perdoo.svg?logo=PyPI&label=License&style=flat-square)](https://opensource.org/licenses/MIT)

[![Pre-Commit](https://img.shields.io/badge/pre--commit-enabled-informational?logo=pre-commit&style=flat-square)](https://github.com/pre-commit/pre-commit)

[![Ruff](https://img.shields.io/badge/ruff-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ruff)

[![Github - Contributors](https://img.shields.io/github/contributors/Buried-In-Code/Perdoo.svg?logo=Github&label=Contributors&style=flat-square)](https://github.com/Buried-In-Code/Perdoo/graphs/contributors)

Perdoo is designed to assist in sorting and organizing your comic collection by utilizing metadata files stored within comic archives.\

Perdoo standardizes all your digital comics into a unified format (cb7, cbt, or cbz).\

It adds and/or updates metadata files using supported services.\

Unlike other tagging tools, Perdoo employs a manual approach when metadata files are absent, prompting users to enter the necessary Publisher/Series/Issue details for search purposes.

## Installation

### Pipx

1. Ensure you have [Pipx](https://pipx.pypa.io/stable/) installed: `pipx --version`

2. Install the project: `pipx install perdoo`

## Usage

Perdoo Commands

  

  ![`uv run Perdoo --help`](docs/img/perdoo-commands.svg)

Perdoo import

  

  ![`uv run Perdoo import --help`](docs/img/perdoo-import.svg)

### Perdoo archive Commands

Perdoo archive view

  

  ![`uv run Perdoo archive view --help`](docs/img/perdoo-archive-view.svg)

### Perdoo settings Commands

Perdoo settings view

  

  ![`uv run Perdoo settings view --help`](docs/img/perdoo-settings-view.svg)

Perdoo settings locate

  

  ![`uv run Perdoo settings locate --help`](docs/img/perdoo-settings-locate.svg)

Perdoo settings update

  

  ![`uv run Perdoo settings update --help`](docs/img/perdoo-settings-update.svg)

## Supported Formats

### Input Extensions

- .cbr

- .cbt

- .cbz

- .cb7 _(Requires installing `cb7` dependencies: `pipx install perdoo[cb7]`)_

### Output Extensions

- .cbt

- .cbz _(Default)_

- .cb7 _(Requires installing `cb7` dependencies: `pipx install perdoo[cb7]`)_

### Metadata Files

- [MetronInfo.xml](https://github.com/Metron-Project/metroninfo)

- Perdoo supports a slightly modified [ComicInfo.xml](https://github.com/anansi-project/comicinfo) to ignore field ordering.

## Services

- [Comicvine](https://comicvine.gamespot.com) using the [Simyan](https://github.com/Metron-Project/Simyan) library.

- [Marvel](https://www.marvel.com/comics) using the [Esak](https://github.com/Metron-Project/Esak) library.

- [Metron](https://metron.cloud) using the [Mokkari](https://github.com/Metron-Project/Mokkari) library.

## File Organization

### Series Naming

Series with a volume greater than 1 will display its volume in the title.

### Comic Naming

The files are named based on the format of the comic:

- **_Default_**: `{Series Title}_#{Issue Number}.cbz`

- Annual: `{Series Title}_Annual_#{Issue Number}.cbz`

- Digital Chapter: `{Series Title}_Chapter_#{Issue Number}.cbz`

- Graphic Novel: `{Series Title}_#{Issue Number}_GN.cbz`

- Hardcover: `{Series Title}_#{Issue Number}_HC.cbz`

- Omnibus: `{Series Title}_#{Issue Number}.cbz`

- Trade Paperback: `{Series Title}_#{Issue Number}_TPB.cbz`

### Folder Structure

```

Collection Root

+-- Publisher

|  +-- Series

|  |  +-- Series_#001.cbz

|  |  +-- Series_Annual_#01.cbz

|  |  +-- Series_Chapter_#01.cbz

|  |  +-- Series_#01_GN.cbz

|  |  +-- Series_#01_HC.cbz

|  |  +-- Series_#01_TPB.cbz

|  +-- Series-v2

|  |  +-- Series-v2_#001.cbz

|  |  +-- Series-v2_Annual_#01.cbz

|  |  +-- Series-v2_Chapter_#01.cbz

|  |  +-- Series-v2_#01_GN.cbz

|  |  +-- Series-v2_#01_HC.cbz

|  |  +-- Series-v2_#01_TPB.cbz

```

## Socials

[![Social - Fosstodon](https://img.shields.io/badge/%40BuriedInCode-teal?label=Fosstodon&logo=mastodon&style=for-the-badge)](https://fosstodon.org/@BuriedInCode)\

[![Social - Matrix](https://img.shields.io/matrix/The-Dev-Environment:matrix.org?label=The-Dev-Environment&logo=matrix&style=for-the-badge)](https://matrix.to/#/#The-Dev-Environment:matrix.org)

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/buried-in-code/perdoo

Awesome Lists containing this project

README