metron-tagger


Namemetron-tagger JSON
Version 3.2.0 PyPI version JSON
download
home_pageNone
SummaryA program to write metadata from metron.cloud to a comic archive
upload_time2024-12-19 15:21:24
maintainerBrian Pepple
docs_urlNone
authorBrian Pepple
requires_python<4.0,>=3.10
licenseGPL-3.0-or-later
keywords comics comic metadata tagging tagger
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

FAQ
---

**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] [-i] [--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. (default: None)
    -d, --delete         Delete the metadata tags from the file. (default: False)
    --ignore-existing    Ignore files that have existing metadata tag. (default: False)
    -i, --interactive    Interactively query the user when there are matches for an online search. (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


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": "Brian Pepple",
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": "bpepple@metron.cloud",
    "keywords": "comics, comic, metadata, tagging, tagger",
    "author": "Brian Pepple",
    "author_email": "bpepple@metron.cloud",
    "download_url": "https://files.pythonhosted.org/packages/6c/a8/2acda26b37ebced60e8a85c342ed3a5ae21fda6327409c69ab39edded418/metron_tagger-3.2.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\nFAQ\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] [-i] [--missing] [-s] [-z] [--validate] [--remove-non-valid] [--delete-original]\n                     [--duplicates] [--migrate] [--version]\n                     path [path ...]\n\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. (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    -i, --interactive    Interactively query the user when there are matches for an online search. (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\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": "GPL-3.0-or-later",
    "summary": "A program to write metadata from metron.cloud to a comic archive",
    "version": "3.2.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/Metron-Project/metron-tagger/issues",
        "Homepage": "https://github.com/Metron-Project/metron-tagger"
    },
    "split_keywords": [
        "comics",
        " comic",
        " metadata",
        " tagging",
        " tagger"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "18113821f924bc76753d8f2e220ccf0676efa0d56e2134463738917b259b81c7",
                "md5": "82ef61e4116bde2fa44054943aded9bd",
                "sha256": "7129a082ebd3d6780b83f4e4cbecfebe37a06fdf97716a34e224e772b1146746"
            },
            "downloads": -1,
            "filename": "metron_tagger-3.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "82ef61e4116bde2fa44054943aded9bd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 46838,
            "upload_time": "2024-12-19T15:21:21",
            "upload_time_iso_8601": "2024-12-19T15:21:21.992693Z",
            "url": "https://files.pythonhosted.org/packages/18/11/3821f924bc76753d8f2e220ccf0676efa0d56e2134463738917b259b81c7/metron_tagger-3.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6ca82acda26b37ebced60e8a85c342ed3a5ae21fda6327409c69ab39edded418",
                "md5": "fe64f9085e9635332e83fca63a942156",
                "sha256": "c869943e0214e5b25fd1f6a844e96377d2bd51f24b8966e1184e5e8f0941b296"
            },
            "downloads": -1,
            "filename": "metron_tagger-3.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "fe64f9085e9635332e83fca63a942156",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 53995,
            "upload_time": "2024-12-19T15:21:24",
            "upload_time_iso_8601": "2024-12-19T15:21:24.547427Z",
            "url": "https://files.pythonhosted.org/packages/6c/a8/2acda26b37ebced60e8a85c342ed3a5ae21fda6327409c69ab39edded418/metron_tagger-3.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-19 15:21:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Metron-Project",
    "github_project": "metron-tagger",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "metron-tagger"
}
        
Elapsed time: 0.42801s