Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/metron-project/metron-tagger
Command line tool to tag comic archives with metadata from Metron Comic Book Database.
https://github.com/metron-project/metron-tagger
comicbook comics command-line-tool metadata tagger
Last synced: about 1 month ago
JSON representation
Command line tool to tag comic archives with metadata from Metron Comic Book Database.
- Host: GitHub
- URL: https://github.com/metron-project/metron-tagger
- Owner: Metron-Project
- License: gpl-3.0
- Created: 2019-01-11T21:43:47.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-12-10T16:56:07.000Z (about 2 months ago)
- Last Synced: 2024-12-14T07:15:22.521Z (about 1 month ago)
- Topics: comicbook, comics, command-line-tool, metadata, tagger
- Language: Python
- Homepage: https://metron.cloud/
- Size: 1.72 MB
- Stars: 23
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
=============
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 `_ to submit bugs or request features.
License
-------
This project is licensed under the `GPLv3 License `_.