Skip to main content

A program to write metadata from metron.cloud to a comic archive

Project description

Metron-Tagger

PyPI version Python versions License Ruff

Quick Description

A command-line tool to tag comic archives with metadata from metron.cloud.

Installation

PyPi

Or install it yourself:

$ pipx install metron-tagger

There are optional dependencies which can be installed by specifying one or more of them in braces e.g. metron-tagger[7zip]

The optional dependencies are:

  • 7zip: Provides support for reading/writing to CB7 files.
  • pdf: Provides support for reading/writing to PDF files.

FAQ

What comics formats are supported?

  • Metron-Tagger supports CBZ, CBR, CBT, CB7 (optional), and PDF (optional) comics.

How to enable RAR support?

  • It depends on the unrar command-line utility, and expects it to be in your $PATH.

    NOTE: unrar only supports reading archives, so you will need to convert the archive to a cbz to write to it. To do so you can use -z, --export-to-cbz and if you want you can remove the orginal .cbr archive with --delete-original after successful conversion.

Help

usage: metron-tagger [-h] [-r] [-o] [-m] [-c] [--id ID] [-d] [--ignore-existing] [--accept-only] [--missing] [-s] [-z] [--validate] [--remove-non-valid] [--delete-original] [--duplicates] [--migrate] [--version]
                   path [path ...]

Read in a file or set of files, and return the result.

positional arguments:
  path                 Path of a file or a folder of files.

options:
  -h, --help           show this help message and exit
  -r, --rename         Rename comic archive from the files metadata. (default: False)
  -o, --online         Search online and attempt to identify comic archive. (default: False)
  -m, --metroninfo     Write, delete, or validate MetronInfo.xml. (default: False)
  -c, --comicinfo      Write, delete, or validate ComicInfo.xml. (default: False)
  --id ID              Identify file for tagging with the Metron Issue Id, or restrict directory matches to issues from a specific Metron Series Id. (default: None)
  -d, --delete         Delete the metadata tags from the file. (default: False)
  --ignore-existing    Ignore files that have existing metadata tag. (default: False)
  --accept-only        Automatically accept the match when exactly one valid match is found. (default: False)
  --skip-multiple      Skip files that have multiple matches instead of prompting for selection. (default: False)
  --missing            List files without metadata. (default: False)
  -s, --sort           Sort files that contain metadata tags. (default: False)
  -z, --export-to-cbz  Export a CBR (rar) archive to a CBZ (zip) archive. (default: False)
  --validate           Verify that comic archive has a valid metadata xml. (default: False)
  --remove-non-valid   Remove metadata xml from comic if not valid. Used with --validate option (default: False)
  --delete-original    Delete the original archive after successful export to another format. (default: False)
  --duplicates         Identify and give the option to delete duplicate pages in a directory of comics. (Experimental) (default: False)
  --migrate            Migrate information from a ComicInfo.xml into a *new* MetronInfo.xml (default: False)
  --version            Show the version number and exit

Examples

To tag all comics in a directory with MetronInfo.xml that don't already have one:

metron-tagger -om --ignore-existing /path/to/comics

To remove any ComicInfo.xml from a directory of comics:

metron-tagger -dc /path/to/comics

To validate any metadata, ComicInfo.xml and MetronInfo.xml, would be done by running the following:

metron-tagger -cm --validate /path/to/comics

To write MetronInfo.xml metadata from comics with ComicInfo.xml data, and migrate data for comics that don't exist at the Metron Comic Database:

metron-tagger -om --migrate /path/to/comics

To remove duplicate pages from comics (which should be only ran on a directory of weekly release since we scan all the pages within a comic), would be done by running the following:

metron-tagger --duplicates /path/to/weekly/comics

Bugs/Requests

Please use the GitHub issue tracker to submit bugs or request features.

License

This project is licensed under the GPLv3 License.

Project details


Release history Release notifications | RSS feed

This version

4.9.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

metron_tagger-4.9.3.tar.gz (68.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

metron_tagger-4.9.3-py3-none-any.whl (51.5 kB view details)

Uploaded Python 3

File details

Details for the file metron_tagger-4.9.3.tar.gz.

File metadata

  • Download URL: metron_tagger-4.9.3.tar.gz
  • Upload date:
  • Size: 68.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for metron_tagger-4.9.3.tar.gz
Algorithm Hash digest
SHA256 3a2eb64b959bcc5a2371acb66e8cdf1c57a0874fc3afeb43f404d4a0ceba937e
MD5 b5cb39deb3b9edcdd9971ce0c4ed4bd4
BLAKE2b-256 18adfcf2f394780cb690ad260afeab6827fc17eb97914ec3512069ecd2fe7ab2

See more details on using hashes here.

File details

Details for the file metron_tagger-4.9.3-py3-none-any.whl.

File metadata

  • Download URL: metron_tagger-4.9.3-py3-none-any.whl
  • Upload date:
  • Size: 51.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for metron_tagger-4.9.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a32b772a61a9343757302fbe2be6cdd9d479af520653e8ccb88896d738d1954a
MD5 82102d5883b952509523c8adcfb9bd49
BLAKE2b-256 5e27a34ace43d1c9b6f4ea941ecbdd38bde85247b533b672f32b773b1e3311bc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page