comicbox 5.2.2__tar.gz → 5.3.0__tar.gz

{comicbox-5.2.2 → comicbox-5.3.0}/.dockerignore

@@ -1,25 +1,22 @@
-__pycache__
-.*cache
 .claude
 .coverage*
-.DS_Store
 .env*
 .git
-.mypy_cache
 .picopt_timestamp
-.pytest_cache
 .ropeproject
-.ruff_cache
 .venv*
-*.egg-info
-*.py[co]
-*~
+**/__pycache__
+**/.*cache
+**/.DS_Store
+**/*.egg-info
+**/*.py[co]
+**/*~
+**/node_modules
+**/test-results
 *Dockerfile
 docker-compose*
 MANIFEST
 monkeytype.sqlite3
 NEWS
-node_modules
-test-results
 TODO.md
 version.sh

{comicbox-5.2.2 → comicbox-5.3.0}/.gitignore

@@ -1,7 +1,5 @@
 __pycache__
-__pycache__/
 __pypackages__
-__pypackages__/
 __snapshots__
 .*cache
 .claude
@@ -10,42 +8,28 @@ __snapshots__
 .docker-token
 .DS_Store
 .eggs
-.eggs/
 .env
 .env-*
-.eslintcache
 .hypothesis
-.hypothesis/
 .installed.cfg
 .ipynb_checkpoints
-.mypy_cache
-.mypy_cache/
 .nox
-.nox/
 .npm
 .pypi-token
 .pypirc
 .pyre
-.pyre/
-.pytest_cache
-.pytest_cache/
 .Python
 .python-version
 .ropeproject
-.ruff_cache
-.ruff_cache/
 .scrapy
 .spyderproject
 .spyproject
 .tox
-.tox/
 .uv-publish-env
 .venv*
-.webassets-cache
 *.cover
 *.egg
 *.egg-info
-*.egg-info/
 *.log
 *.manifest
 *.mo
@@ -60,67 +44,42 @@ __snapshots__
 /*.cbr
 /*.cbz
 build
-build/
 celerybeat-schedule
 celerybeat.pid
 coverage.xml
 develop-eggs
-develop-eggs/
 dist
-dist/
 dmypy.json
 docs/_build
-docs/_build/
 downloads
-downloads/
 eggs
-eggs/
 env
 ENV
 env.bak
-env.bak/
-env/
-ENV/
 generate-schema/generated.schema.json
 htmlcov
-htmlcov/
 instance
-instance/
 ipython_config.py
 jspm_packages
-jspm_packages/
 lib
-lib/
 lib64
-lib64/
 local_settings.py
 MANIFEST
 monkeytype.sqlite3
 node_modules
-node_modules/
 nosetests.xml
 parts
-parts/
 pip-delete-this-directory.txt
 pip-log.txt
 pip-wheel-metadata
-pip-wheel-metadata/
 profile_default
-profile_default/
 sdist
-sdist/
 share/python-wheels
-share/python-wheels/
 target
-target/
 tasks/
 test-results
 TODO.md
 var
-var/
 venv
 venv.bak
-venv.bak/
-venv/
 wheels
-wheels/

{comicbox-5.2.2 → comicbox-5.3.0}/.prettierignore

@@ -1,15 +1,12 @@
 __pycache__
 .*cache
-.*cache/
 .claude
 .git
-.venv
 *.sh
 *Dockerfile
 bun.lock
 comicbox/schemas/*Info*.xsd
 dist
-Dockerfile
 node_modules
 schemas/*Info*.xsd
 tasks

comicbox-5.3.0/.shellignore

@@ -0,0 +1,2 @@
+.*
+node_modules

{comicbox-5.2.2 → comicbox-5.3.0}/NEWS.md

@@ -1,5 +1,32 @@
 # 📰 News
 
+## v5.3.0
+
+- Breaking Changes
+    - Requires Python 3.11 or later.
+- Features
+    - `comicbox doctor` checks archive tools, the PDF extra, image codecs,
+      config, credentials and package versions, with a fix for each problem.
+      `--online all` also tests each credential with one API request.
+- Fixes
+    - CBR support is detected by test-extracting a file; a missing or broken RAR
+      tool is reported instead of crashing reads.
+    - A broken PDF install disables PDFs with a warning instead of breaking
+      comicbox, and `is_pdf_supported()` agrees.
+    - A malformed user config is skipped with a warning, and config errors print
+      one line instead of a traceback.
+    - Per-source online tuning values are validated; unknown sources warn.
+    - A broken 7z or RAR library no longer aborts batch reads.
+    - Short-form PDF dates, like those without a timezone, are no longer
+      dropped.
+    - Filenames with long digit runs no longer stall parsing.
+    - Config mappings accept enum members like `MatchMode.EAGER` as well as
+      their string values.
+    - Error messages keep bracketed text like `[digital]`.
+- Dependencies
+    - Requires comicfn2dict 1.0, comicbox-pdffile 1.0, simyan 4.2, mokkari 4.9
+      and packaging. No longer requires imagehash, numpy, scipy or PyWavelets.
+
 ## v5.2.2
 
 - Fixes

{comicbox-5.2.2 → comicbox-5.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: comicbox
-Version: 5.2.2
+Version: 5.3.0
 Summary: Comic book archive multi format metadata read/write/transform tool and image extractor.
 Keywords: cb7,cbr,cbt,cbz,comet,comic,comicbookinfo,comicinfo,metroninfo,pdf
 Author: AJ Slater
@@ -13,18 +13,18 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Dist: bidict~=0.23
 Requires-Dist: case-converter~=1.2
-Requires-Dist: comicfn2dict>=0.3.2,<1.0.0
-Requires-Dist: confuse~=2.3.0
+Requires-Dist: comicfn2dict~=1.0
+Requires-Dist: confuse~=2.3
 Requires-Dist: glom~=25.12
 Requires-Dist: httpx~=0.28
-Requires-Dist: imagehash>=4.3.2
 Requires-Dist: jsonschema[format]~=4.20
 Requires-Dist: keyring~=25.6
 Requires-Dist: loguru~=0.7
 Requires-Dist: marshmallow-union>=0.1.15.post1
 Requires-Dist: marshmallow~=4.3
-Requires-Dist: mokkari>=4.8.0,<5
+Requires-Dist: mokkari~=4.9.0
 Requires-Dist: nh3>=0.3.5
+Requires-Dist: packaging>=24.0
 Requires-Dist: pillow>=12.2.0
 Requires-Dist: platformdirs>=4.9.6
 Requires-Dist: py7zr~=1.1.0
@@ -37,13 +37,13 @@ Requires-Dist: rich-argparse~=1.7
 Requires-Dist: rich~=15.0
 Requires-Dist: ruamel-yaml~=0.18
 Requires-Dist: simplejson~=4.0
-Requires-Dist: simyan>=4.1.0,<5
+Requires-Dist: simyan~=4.2
 Requires-Dist: typing-extensions~=4.13
 Requires-Dist: xmlschema~=4.0
 Requires-Dist: xmltodict~=1.0
 Requires-Dist: zipremove~=0.1
-Requires-Dist: comicbox-pdffile>=0.6.3,<0.7 ; extra == 'pdf'
-Requires-Python: >=3.10
+Requires-Dist: comicbox-pdffile~=1.0 ; extra == 'pdf'
+Requires-Python: >=3.11
 Project-URL: News, https://comicbox.readthedocs.io/NEWS/
 Project-URL: Documentation, https://comicbox.readthedocs.io
 Project-URL: Source, https://github.com/ajslater/comicbox
@@ -93,8 +93,8 @@ as a standalone command line tool for organizing a comic library.
 | CB7 (7z)  |  ✅  | converts to CBZ      |
 | PDF       |  ✅  | ✅ embedded metadata |
 
-CBR extraction and conversion require the `unrar` binary on your `PATH`. PDF
-support is an [optional extra](#-installation).
+CBR extraction and conversion require RARLAB's `unrar` binary on your `PATH`.
+PDF support is an [optional extra](#-installation).
 
 ### 🏷️ Metadata Formats
 
@@ -201,7 +201,11 @@ pip install comicbox[pdf]
 ### Dependencies
 
 Comicbox needs no binary dependencies for CBZ, CBT, and CB7. Reading or
-converting **CBR** archives requires the `unrar` binary on your `PATH`.
+converting **CBR** archives requires RARLAB's `unrar` binary on your `PATH`
+(`brew install rar` on macOS, `unrar` from Debian's non-free). rarfile falls
+back to bsdtar and 7-Zip, but through rarfile 4.5 bsdtar can't extract RAR at
+all, and 7-Zip builds without the RAR codec can't either. `comicbox doctor` says
+whether this host can read CBRs.
 
 The optional PDF extra pulls in
 [pymupdf](https://pymupdf.readthedocs.io/en/latest/installation.html), which
@@ -364,6 +368,34 @@ optional config file, in that order of precedence.
 LOGLEVEL=ERROR comicbox -p "comic.cbz"
 ```
 
+## 🩺 Troubleshooting
+
+`comicbox doctor` checks everything comicbox depends on outside its own code:
+the RAR tool, the PDF extra, the image codecs online cover matching needs, your
+config files and environment variables, your online credentials, and the Python
+packages comicbox pins. Each row says OK, WARN, OFF (optional and not set up),
+MISSING, WRONG VERSION, MISCONFIGURED or ERROR, with a one-line fix for anything
+that isn't OK.
+
+```sh
+comicbox doctor
+
+# The config a run with -c would load.
+comicbox doctor -c tagging.yaml
+
+# Problems only. Exits non-zero if something comicbox needs is broken, so it
+# works as a Docker or CI health check.
+comicbox doctor -q
+
+# Also verify each configured online source's credentials, with one API
+# request per source.
+comicbox doctor --online all
+```
+
+Credentials are reported by where they came from (`--auth`, an env var, a config
+file, or the keyring), never by value, so the report is safe to paste into a bug
+report.
+
 ## 📦 Related Packages
 
 Installing comicbox also installs two small sibling libraries, each usable on

{comicbox-5.2.2 → comicbox-5.3.0}/README.md

@@ -41,8 +41,8 @@ as a standalone command line tool for organizing a comic library.
 | CB7 (7z)  |  ✅  | converts to CBZ      |
 | PDF       |  ✅  | ✅ embedded metadata |
 
-CBR extraction and conversion require the `unrar` binary on your `PATH`. PDF
-support is an [optional extra](#-installation).
+CBR extraction and conversion require RARLAB's `unrar` binary on your `PATH`.
+PDF support is an [optional extra](#-installation).
 
 ### 🏷️ Metadata Formats
 
@@ -149,7 +149,11 @@ pip install comicbox[pdf]
 ### Dependencies
 
 Comicbox needs no binary dependencies for CBZ, CBT, and CB7. Reading or
-converting **CBR** archives requires the `unrar` binary on your `PATH`.
+converting **CBR** archives requires RARLAB's `unrar` binary on your `PATH`
+(`brew install rar` on macOS, `unrar` from Debian's non-free). rarfile falls
+back to bsdtar and 7-Zip, but through rarfile 4.5 bsdtar can't extract RAR at
+all, and 7-Zip builds without the RAR codec can't either. `comicbox doctor` says
+whether this host can read CBRs.
 
 The optional PDF extra pulls in
 [pymupdf](https://pymupdf.readthedocs.io/en/latest/installation.html), which
@@ -312,6 +316,34 @@ optional config file, in that order of precedence.
 LOGLEVEL=ERROR comicbox -p "comic.cbz"
 ```
 
+## 🩺 Troubleshooting
+
+`comicbox doctor` checks everything comicbox depends on outside its own code:
+the RAR tool, the PDF extra, the image codecs online cover matching needs, your
+config files and environment variables, your online credentials, and the Python
+packages comicbox pins. Each row says OK, WARN, OFF (optional and not set up),
+MISSING, WRONG VERSION, MISCONFIGURED or ERROR, with a one-line fix for anything
+that isn't OK.
+
+```sh
+comicbox doctor
+
+# The config a run with -c would load.
+comicbox doctor -c tagging.yaml
+
+# Problems only. Exits non-zero if something comicbox needs is broken, so it
+# works as a Docker or CI health check.
+comicbox doctor -q
+
+# Also verify each configured online source's credentials, with one API
+# request per source.
+comicbox doctor --online all
+```
+
+Credentials are reported by where they came from (`--auth`, an env var, a config
+file, or the keyring), never by value, so the report is safe to paste into a bug
+report.
+
 ## 📦 Related Packages
 
 Installing comicbox also installs two small sibling libraries, each usable on

comicbox-5.3.0/bin/find-sh.sh

@@ -0,0 +1,79 @@
+#!/usr/bin/env bash
+# List shell scripts to fix and lint, honoring .shellignore, NUL-delimited
+#
+# Prints every regular *.sh file under the current directory as `find` prints
+# it (./path/to/file.sh), sorted bytewise, each followed by a NUL. Skips what
+# the optional ./.shellignore excludes. A missing file excludes nothing.
+#
+# .shellignore holds one pattern per line:
+#   - Blank lines and lines starting with # are ignored.
+#   - A leading ! re-includes what an earlier pattern excluded.
+#   - A leading ./ or / and a trailing / are stripped.
+#   - A pattern with a / is anchored to this directory: a/b matches ./a/b but
+#     not ./x/a/b.
+#   - A pattern without a / matches a file or directory name at any depth.
+#   - * ? and [...] are glob characters. As in find -path, * also matches /.
+#
+# Excluded directories are pruned, never descended. Like gitignore, a file
+# under an excluded directory cannot be re-included, so ! only helps when it
+# names the pruned directory itself: `.*` then `!.github` keeps ./.github
+# and everything in it.
+#
+# Portable to BSD and GNU find: only -mindepth -name -path -prune -type
+# -print0 -o ! and parentheses.
+set -euo pipefail
+
+ignore_file=.shellignore
+ignore_tests=()
+keep_tests=()
+
+if [[ -f $ignore_file ]]; then
+  while read -r line || [[ -n $line ]]; do
+    line=${line//$'\r'/}
+    case $line in
+    '' | '#'*) continue ;;
+    esac
+
+    negated=false
+    if [[ $line == '!'* ]]; then
+      negated=true
+      line=${line#!}
+    fi
+    line=${line#./}
+    line=${line#/}
+    line=${line%/}
+    if [[ -z $line ]]; then
+      continue
+    fi
+
+    if [[ $line == */* ]]; then
+      match=(-path "./$line")
+    else
+      match=(-name "$line")
+    fi
+
+    if [[ $negated == true ]]; then
+      if ((${#keep_tests[@]})); then
+        keep_tests+=(-o)
+      fi
+      keep_tests+=("${match[@]}")
+    else
+      if ((${#ignore_tests[@]})); then
+        ignore_tests+=(-o)
+      fi
+      ignore_tests+=("${match[@]}")
+    fi
+  done <"$ignore_file"
+fi
+
+find_args=(. -mindepth 1)
+if ((${#ignore_tests[@]})); then
+  prune=(\( "${ignore_tests[@]}" \))
+  if ((${#keep_tests[@]})); then
+    prune+=(! \( "${keep_tests[@]}" \))
+  fi
+  find_args+=(\( "${prune[@]}" \) -prune -o)
+fi
+find_args+=(-type f -name '*.sh' -print0)
+
+find "${find_args[@]}" | LC_ALL=C sort -z

comicbox-5.3.0/bin/fix-sh.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+# Fix shell script formatting
+set -euxo pipefail
+
+mapfile -d '' files < <("$(dirname "${BASH_SOURCE[0]}")/find-sh.sh")
+# A failing finder must fail this script, not look like zero files.
+wait "$!"
+if ((${#files[@]} == 0)); then
+  exit 0
+fi
+
+shellharden --replace "${files[@]}"
+shfmt --simplify --indent 2 --write "${files[@]}"

comicbox-5.3.0/bin/lint-sh.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+# Lint shell scripts
+set -euxo pipefail
+
+mapfile -d '' files < <("$(dirname "${BASH_SOURCE[0]}")/find-sh.sh")
+# A failing finder must fail this script, not look like zero files.
+wait "$!"
+if ((${#files[@]} == 0)); then
+  exit 0
+fi
+
+shellcheck --external-sources "${files[@]}"
+shellharden --check "${files[@]}"
+shfmt --simplify --indent 2 --diff "${files[@]}"

comicbox-5.3.0/bin/sort-ignore.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+# Sort all ignore files in place and remove duplicates
+# Negations (lines starting with !) go after every other line: git, docker and
+# prettier let the last matching line win, so a negation only works after the
+# patterns it overrides.
+set -euo pipefail
+# Set locale to make output deterministic across shells
+export LC_ALL=en_US.UTF-8
+sorted=$(mktemp)
+trap 'rm -f "$sorted"' EXIT
+for f in .*ignore; do
+  if [ -f "$f" ] && [ ! -L "$f" ]; then
+    {
+      sed '/^!/d' "$f" | sort --unique
+      sed -n '/^!/p' "$f" | sort --unique
+    } >"$sorted"
+    # Write through the file, not over it, to keep its mode.
+    cat "$sorted" >"$f"
+    echo "$f" sorted
+  fi
+done