Metadata-Version: 2.4
Name: comicfn2dict
Version: 0.2.5
Summary: Parse common comic filenames and return a dict of metadata attributes. Includes a cli.
Project-URL: News, https://github.com/ajslater/comicfn2dict/NEWS.md
Project-URL: Report Issues, https://github.com/ajslater/comicfn2dict/issues
Project-URL: homepage, https://github.com/ajslater/comicfn2dict
Project-URL: repository, https://github.com/ajslater/comicfn2dict
Project-URL: documentation, https://github.com/ajslater/comicfn2dict
Author-email: AJ Slater <aj@slater.net>
License: GPL-3.0-only
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: <4.0,>=3.9
Description-Content-Type: text/markdown

# comicfn2dict

An API and CLI for extracting structured comic metadata from filenames.

## Install

<!-- eslint-skip -->

```sh
pip install comicfn2dict
```

## API

<!-- eslint-skip -->

```python
from comicfn2dict import comicfn2dict, dict2comicfn

path = "Comic Series #001 Title (2024).cbz"

metadata: dict[str, str| tuple[str,...]] = comicfn2dict(path, verbose=0)

filename: str = dict2comicfn(metadata, bool=True, verbose=0)
```

## CLI

<!-- eslint-skip -->

```sh
comicfn2dict "Series Name #01 - Title (2023).cbz"
{'ext': 'cbz',
'issue': '001',
'series': 'Series Name',
'title': 'Title',
'year': '2023'}
```
