Metadata-Version: 2.3
Name: comicfn2dict
Version: 0.3.0
Summary: Parse common comic filenames and return a dict of metadata attributes. Includes a cli.
Keywords: cbr,cbz,comic,filename
Author: AJ Slater
Author-email: AJ Slater <aj@slater.net>
License: GPL-3.0-only
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Dist: typing-extensions~=4.13
Requires-Python: >=3.10
Project-URL: News, https://github.com/ajslater/comicfn2dict/NEWS.md
Project-URL: Documentation, https://comicfn2dict.readthedocs.io/
Project-URL: Issues, https://github.com/ajslater/comicfn2dict/issues
Project-URL: Source, https://github.com/ajslater/comicfn2dict
Description-Content-Type: text/markdown

# comicfn2dict

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

## 📜 News

comicfn2dict has a [NEWS file](NEWS.md) to summarize changes that affect users.

## 🕸️ HTML Docs

[HTML formatted docs are available here](https://comicfn2dict.readthedocs.io)

## 📦 Install

```sh
pip install comicfn2dict
```

## 🛠️ API

```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)
```

There is also some autogenerated api docs attached to this documentation, but
the codebase is small and probably easy to read.

## ⌨️ CLI

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

## 🛠 Development

comicfn2dict code is hosted at
[Github](https://github.com/ajslater/comicfn2dict)
