buried-in-code/dex-starr

Dex-Starr helps sort and organize your comic collection by using the information stored in ComicInfo files

⚠️ Deprecation Notice ⚠️

This project is now deprecated and no longer actively maintained.
This project has been transitioned to a new and improved version called Perdoo.

Dex-Starr

With test and code of crimson red,
Ripped from a program so freshly dead,
Together with our comics collate,
We'll sort you all, that is your Fate!

Dex-Starr's goal is to help sort and organize your comic collection by using the information stored in Info files.
It also formats all your digital comics into a single format (cbz or cb7), adds and/or updates the supported list of Info files.

Supported Formats

Input Extensions

• .cbz
• .cbr
• .cb7 (Requires installing cb7 dependencies: pip install dex_starr[cb7])
• .cbt

Output Extensions

• .cbz
• .cb7 (Requires installing cb7 dependencies: pip install dex_starr[cb7])

Info Files

• Metadata.json
• MetronInfo.xml
• ComicInfo.xml

Installation

PyPI (Currently not released on PyPI)

1. Make sure you have Python installed: python --version
2. Install the project from PyPI: pip install dex_starr

Github

1. Make sure you have Python installed: python --version
2. Clone the repo: git clone https://github.com/Buried-In-Code/Dex-Starr
3. Install the project: pip install .

Execution

• Dex-Starr <arguments>

Arguments

Argument	Type	Description
--manual-edit	bool	Pause the Script before bundling the files to allow manual removal of Ads, etc...
--version	bool	Display the version of Dex-Starr running
--debug	bool	Display extra/debug messages while running

Services

• Comicvine using the Simyan library.
• League of Comic Geeks using the Himon library.
• Marvel using the Esak library.
• Metron using the Mokkari library.

File Renaming

Series Naming

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

Comic Naming

The files are named based on the format of Comic:

• Default/Comic: {Series Title}-#{Issue Number}.cbz
• Annual: {Series Title}-Annual-#{Issue Number}.cbz
• Digital Chapter: {Series Title}-Chapter-#{Issue Number}.cbz
• Hardcover ends with: -HC.cbz
• Trade Paperback ends with: -TP.cbz
• Graphic Novel ends with: -GN.cbz

Collection Folder Structure

Import
+-- New Comic #10.cbr
+-- New Comic #11.cbz

Collection
+-- Publisher
|  +-- Series
|  |  +-- Series-#1.cbz
|  |  +-- Series-Annual-#1.cbz
|  |  +-- Series-Chapter-#1.cbz
|  |  +-- Series-HC.cbz
|  |  +-- Series-#1-TP.cbz
|  |  +-- Series-GN.cbz
|  +-- Series-v2
|  |  +-- Series-v2-#1.cbz
|  |  +-- Series-v2-Annual-#1.cbz
|  |  +-- Series-v2-Chapter-#1.cbz
|  |  +-- Series-v2-#1-HC.cbz
|  |  +-- Series-v2-TP.cbz
|  |  +-- Series-v2-GN.cbz

Socials

dex-starr's Issues

Create and use Default values for Config instead of throwing errors

After taking a closer look at how I implemented the tests rather than loading a test config, they try and load it how Comic-Organizer would for any user.

Really, I'd say this is actually a bug that was exposed.

By hard-coding a config file location without any type of error handling you're making this section of the code fairly brittle. A better solution would be to gracefully exit if the file isn't found, or to create an empty file and then error out if any info is missing when needed. Really all those variables (COMICVINE_API_KEY, LEAGUE_API_KEY, etc) should be using default values (None, "", etc) if for some reason their keys are not in config file.

There are a lot of different ways to implement this depending on your needs, for most of my simple projects I tend to use something like this:

https://github.com/bpepple/metron-tagger/blob/master/metrontagger/taggerlib/settings.py

Anyway, something to think about.

Originally posted by @bpepple in #16 (comment)

Set test cache not to expire

Currently automated tests fail as the responses in the test cache are removed due to expiry set on cache

Unable to load Config Files during Github Action testing

Currently to test the script a config.ini file is required.
Need to investigate how to load one for Github Actions to be able to load