metron-tagger


Namemetron-tagger JSON
Version 4.4.0 PyPI version JSON
download
home_pageNone
SummaryA program to write metadata from metron.cloud to a comic archive
upload_time2025-10-10 16:17:33
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords cb7 cbr cbt cbz comic comicinfo metadata metroninfo tagger tagging
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =============
Metron-Tagger
=============

.. image:: https://img.shields.io/pypi/v/metron-tagger.svg
    :target: https://pypi.org/project/metron-tagger/

.. image:: https://img.shields.io/pypi/pyversions/metron-tagger.svg
    :target: https://pypi.org/project/metron-tagger/

.. image:: https://img.shields.io/github/license/bpepple/metron-tagger
    :target: https://opensource.org/licenses/GPL-3.0

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Ruff

Quick Description
-----------------

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

.. _metron.cloud: https://metron.cloud

Installation
------------

PyPi
~~~~

Or install it yourself:

.. code:: bash

  $ 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.

FAQ
---

**What comics formats are supported?**

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


**How to enable RAR support?**

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

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 <https://github.com/Metron-Project/metron-tagger/issues>`_ to submit bugs or request features.

License
-------

This project is licensed under the `GPLv3 License <LICENSE>`_.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "metron-tagger",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "Brian Pepple <bpepple@metron.cloud>",
    "keywords": "cb7, cbr, cbt, cbz, comic, comicinfo, metadata, metroninfo, tagger, tagging",
    "author": null,
    "author_email": "Brian Pepple <bpepple@metron.cloud>",
    "download_url": "https://files.pythonhosted.org/packages/da/4d/3f982936cbedb8f8496428bc1a9d249f40eecde54148a2edad2aa54f3a08/metron_tagger-4.4.0.tar.gz",
    "platform": null,
    "description": "=============\nMetron-Tagger\n=============\n\n.. image:: https://img.shields.io/pypi/v/metron-tagger.svg\n    :target: https://pypi.org/project/metron-tagger/\n\n.. image:: https://img.shields.io/pypi/pyversions/metron-tagger.svg\n    :target: https://pypi.org/project/metron-tagger/\n\n.. image:: https://img.shields.io/github/license/bpepple/metron-tagger\n    :target: https://opensource.org/licenses/GPL-3.0\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n    :target: https://github.com/astral-sh/ruff\n    :alt: Ruff\n\nQuick Description\n-----------------\n\nA command-line tool to tag comic archives with metadata from metron.cloud_.\n\n.. _metron.cloud: https://metron.cloud\n\nInstallation\n------------\n\nPyPi\n~~~~\n\nOr install it yourself:\n\n.. code:: bash\n\n  $ pipx install metron-tagger\n\nThere are optional dependencies which can be installed by specifying one or more of them in braces e.g. metron-tagger[7zip]\n\nThe optional dependencies are:\n\n* 7zip: Provides support for reading/writing to CB7 files.\n\nFAQ\n---\n\n**What comics formats are supported?**\n\n- Metron-Tagger supports CBZ, CBR, CBT, and CB7 (optional) comics.\n\n\n**How to enable RAR support?**\n\n- It depends on the unrar command-line utility, and expects it to be in your $PATH.\n\nHelp\n----\n\n::\n\n  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]\n                     path [path ...]\n\n  Read in a file or set of files, and return the result.\n\n  positional arguments:\n    path                 Path of a file or a folder of files.\n\n  options:\n    -h, --help           show this help message and exit\n    -r, --rename         Rename comic archive from the files metadata. (default: False)\n    -o, --online         Search online and attempt to identify comic archive. (default: False)\n    -m, --metroninfo     Write, delete, or validate MetronInfo.xml. (default: False)\n    -c, --comicinfo      Write, delete, or validate ComicInfo.xml. (default: False)\n    --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)\n    -d, --delete         Delete the metadata tags from the file. (default: False)\n    --ignore-existing    Ignore files that have existing metadata tag. (default: False)\n    --accept-only        Automatically accept the match when exactly one valid match is found. (default: False)\n    --skip-multiple      Skip files that have multiple matches instead of prompting for selection. (default: False)\n    --missing            List files without metadata. (default: False)\n    -s, --sort           Sort files that contain metadata tags. (default: False)\n    -z, --export-to-cbz  Export a CBR (rar) archive to a CBZ (zip) archive. (default: False)\n    --validate           Verify that comic archive has a valid metadata xml. (default: False)\n    --remove-non-valid   Remove metadata xml from comic if not valid. Used with --validate option (default: False)\n    --delete-original    Delete the original archive after successful export to another format. (default: False)\n    --duplicates         Identify and give the option to delete duplicate pages in a directory of comics. (Experimental) (default: False)\n    --migrate            Migrate information from a ComicInfo.xml into a *new* MetronInfo.xml (default: False)\n    --version            Show the version number and exit\n\nExamples\n--------\n\nTo tag all comics in a directory with MetronInfo.xml that don't already have one:\n::\n\n  metron-tagger -om --ignore-existing /path/to/comics\n\nTo remove any ComicInfo.xml from a directory of comics:\n::\n\n  metron-tagger -dc /path/to/comics\n\nTo validate any metadata, ComicInfo.xml and MetronInfo.xml, would be done by running the following:\n::\n\n  metron-tagger -cm --validate /path/to/comics\n\nTo write MetronInfo.xml metadata from comics with ComicInfo.xml data, and migrate data for comics that don't exist at the Metron Comic Database:\n::\n\n  metron-tagger -om --migrate /path/to/comics\n\nTo 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:\n::\n\n  metron-tagger --duplicates /path/to/weekly/comics\n\n\n\nBugs/Requests\n-------------\n\nPlease use the `GitHub issue tracker <https://github.com/Metron-Project/metron-tagger/issues>`_ to submit bugs or request features.\n\nLicense\n-------\n\nThis project is licensed under the `GPLv3 License <LICENSE>`_.\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A program to write metadata from metron.cloud to a comic archive",
    "version": "4.4.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/Metron-Project/metron-tagger/issues",
        "Homepage": "https://github.com/Metron-Project/metron-tagger"
    },
    "split_keywords": [
        "cb7",
        " cbr",
        " cbt",
        " cbz",
        " comic",
        " comicinfo",
        " metadata",
        " metroninfo",
        " tagger",
        " tagging"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2e0198d65af355a92161a36c423e80e44aa981c9f7d8d29cfd5e9ec48f8e3967",
                "md5": "b5bb47f9ffd36a9c417cb12ca38326c8",
                "sha256": "04d7e394a803a11b44815cb3367213db11ac6a717c44efad1dc62f5ef368fedd"
            },
            "downloads": -1,
            "filename": "metron_tagger-4.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b5bb47f9ffd36a9c417cb12ca38326c8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 48937,
            "upload_time": "2025-10-10T16:17:32",
            "upload_time_iso_8601": "2025-10-10T16:17:32.873532Z",
            "url": "https://files.pythonhosted.org/packages/2e/01/98d65af355a92161a36c423e80e44aa981c9f7d8d29cfd5e9ec48f8e3967/metron_tagger-4.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "da4d3f982936cbedb8f8496428bc1a9d249f40eecde54148a2edad2aa54f3a08",
                "md5": "ecb546edb7c8a8d79c9dbe9cbe455c56",
                "sha256": "42c412ed211a01d418d48d627ee941f41df4e70b192031362b567236a75a7bae"
            },
            "downloads": -1,
            "filename": "metron_tagger-4.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ecb546edb7c8a8d79c9dbe9cbe455c56",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 63817,
            "upload_time": "2025-10-10T16:17:33",
            "upload_time_iso_8601": "2025-10-10T16:17:33.925542Z",
            "url": "https://files.pythonhosted.org/packages/da/4d/3f982936cbedb8f8496428bc1a9d249f40eecde54148a2edad2aa54f3a08/metron_tagger-4.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-10 16:17:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Metron-Project",
    "github_project": "metron-tagger",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "metron-tagger"
}
        
Elapsed time: 2.17805s