shortbox 0.4.0__tar.gz

shortbox-0.4.0/.gitattributes

@@ -0,0 +1,119 @@
+# Common settings that generally should always be used with your language specific settings
+
+# Auto detect text files and perform LF normalization
+*          text=auto
+
+#
+# The above will handle all files NOT found below
+#
+
+# Documents
+*.bibtex   text diff=bibtex
+*.doc      diff=astextplain
+*.DOC      diff=astextplain
+*.docx     diff=astextplain
+*.DOCX     diff=astextplain
+*.dot      diff=astextplain
+*.DOT      diff=astextplain
+*.pdf      diff=astextplain
+*.PDF      diff=astextplain
+*.rtf      diff=astextplain
+*.RTF      diff=astextplain
+*.md       text diff=markdown
+*.mdx      text diff=markdown
+*.tex      text diff=tex
+*.adoc     text
+*.textile  text
+*.mustache text
+*.csv      text eol=crlf
+*.tab      text
+*.tsv      text
+*.txt      text
+*.sql      text
+*.epub     diff=astextplain
+
+# Graphics
+*.png      binary
+*.jpg      binary
+*.jpeg     binary
+*.gif      binary
+*.tif      binary
+*.tiff     binary
+*.ico      binary
+# SVG treated as text by default.
+*.svg      text
+# If you want to treat it as binary,
+# use the following line instead.
+# *.svg    binary
+*.eps      binary
+
+# Scripts
+*.bash     text eol=lf
+*.fish     text eol=lf
+*.sh       text eol=lf
+*.zsh      text eol=lf
+# These are explicitly windows files and should use crlf
+*.bat      text eol=crlf
+*.cmd      text eol=crlf
+*.ps1      text eol=crlf
+
+# Serialisation
+*.json     text
+*.toml     text
+*.xml      text
+*.yaml     text
+*.yml      text
+
+# Archives
+*.7z       binary
+*.cb7      binary
+*.gz       binary
+*.tar      binary
+*.cbt      binary
+*.tgz      binary
+*.zip      binary
+*.cbz      binary
+
+# Text files where line endings should be preserved
+*.patch    -text
+
+#
+# Exclude files from exporting
+#
+
+.gitattributes export-ignore
+.gitignore     export-ignore
+.gitkeep       export-ignore
+# Apply override to all files in the directory
+*.md linguist-detectable
+# Basic .gitattributes for a python repo.
+
+# Source files
+# ============
+*.pxd    text diff=python
+*.py     text diff=python
+*.py3    text diff=python
+*.pyw    text diff=python
+*.pyx    text diff=python
+*.pyz    text diff=python
+*.pyi    text diff=python
+
+# Binary files
+# ============
+*.db     binary
+*.p      binary
+*.pkl    binary
+*.pickle binary
+*.pyc    binary export-ignore
+*.pyo    binary export-ignore
+*.pyd    binary
+
+# Jupyter notebook
+*.ipynb  text eol=lf
+
+# Note: .db, .p, and .pkl files are associated
+# with the python modules ``pickle``, ``dbm.*``,
+# ``shelve``, ``marshal``, ``anydbm``, & ``bsddb``
+# (among others).
+# Fix syntax highlighting on GitHub to allow comments
+.vscode/*.json linguist-language=JSON-with-Comments

shortbox-0.4.0/.gitignore

@@ -0,0 +1,21 @@
+# =====Folders=====
+__pycache__/
+__pypackages__/
+.idea/
+.pytest_cache/
+.ruff_cache/
+.tox/
+.venv/
+build/
+dist/
+logs/
+site/
+
+# =====Files=====
+*.iml
+*.log
+*.txt
+.coverage
+.envrc
+.pdm-python
+.python-version

shortbox-0.4.0/.pre-commit-config.yaml

@@ -0,0 +1,94 @@
+repos:
+  - repo: local
+    hooks:
+      - id: toml-sort
+        args:
+          - "--in-place"
+        entry: toml-sort
+        exclude: "uv.lock|pylock.toml"
+        language: system
+        name: toml sort
+        types:
+          - toml
+      - id: mdformat
+        args:
+          - "--number"
+          - "--wrap=keep"
+        entry: mdformat
+        language: system
+        name: mdformat
+        types:
+          - markdown
+      - id: ruff-check
+        entry: ruff check .
+        language: system
+        name: ruff check
+        pass_filenames: false
+        types:
+          - python
+      - id: ruff-format
+        entry: ruff format .
+        language: system
+        name: ruff format
+        pass_filenames: false
+        types:
+          - python
+      - id: ty
+        entry: ty check .
+        language: system
+        name: ruff check
+        pass_filenames: false
+        types:
+          - python
+  - repo: "https://github.com/pre-commit/pre-commit-hooks"
+    rev: v6.0.0
+    hooks:
+      - id: check-ast
+      - id: check-builtin-literals
+      - id: check-docstring-first
+      - id: debug-statements
+      - id: forbid-submodules
+  - repo: builtin
+    hooks:
+      - id: check-added-large-files
+        args:
+          - "--enforce-all"
+      - id: check-case-conflict
+      # - id: check-executables-have-shebangs
+      # - id: check-illegal-windows-names
+      # - id: check-json
+      # - id: check-json5
+      - id: check-merge-conflict
+        args:
+          - "--assume-in-merge"
+      - id: check-shebang-scripts-are-executable
+      # - id: check-symlinks
+      - id: check-toml
+      - id: check-vcs-permalinks
+      - id: check-xml
+      - id: check-yaml
+        args:
+          - "--allow-multiple-documents"
+      - id: destroyed-symlinks
+      - id: detect-private-key
+      - id: end-of-file-fixer
+        exclude_types:
+          - json
+          - svg
+          - xml
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+        args:
+          - "--fix=auto"
+      # - id: pretty-format-json
+      #   args:
+      #     - "--autofix"
+      #     - "--indent=2"
+      #     - "--no-ensure-ascii"
+      - id: trailing-whitespace
+        args:
+          - "--markdown-linebreak-ext=md"
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes

shortbox-0.4.0/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.5
+Name: shortbox
+Version: 0.4.0
+Summary: An extensible library to manage comic archives and their embedded files and metadata.
+Project-URL: Homepage, https://pypi.org/project/shortbox
+Project-URL: Issues, https://codeberg.org/buriedincode/shortbox/issues
+Project-URL: Source, https://codeberg.org/buriedincode/shortbox
+Author-email: BuriedInCode <buriedincode@duckpond.nz>
+Maintainer-email: BuriedInCode <buriedincode@duckpond.nz>
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: msgspec-extras>=0.2.0
+Requires-Dist: msgspec-xml>=0.3.0
+Requires-Dist: natsort>=8.4.0
+Requires-Dist: xmlschema>=4.3.0
+Requires-Dist: zipremove>=0.10.0
+Provides-Extra: cb7
+Requires-Dist: py7zr>=1.1.0; extra == 'cb7'
+Provides-Extra: cbr
+Requires-Dist: rarfile>=4.5; extra == 'cbr'
+Provides-Extra: pdf
+Requires-Dist: comicbox-pdffile>=0.6.0; extra == 'pdf'
+Description-Content-Type: text/markdown
+
+# Shortbox
+
+[![PyPI - Python](https://img.shields.io/pypi/pyversions/shortbox.svg?logo=Python&label=Python&style=flat-square)](https://pypi.org/p/shortbox/)
+[![PyPI - Status](https://img.shields.io/pypi/status/shortbox.svg?logo=Python&label=Status&style=flat-square)](https://pypi.org/p/shortbox/)
+[![PyPI - Version](https://img.shields.io/pypi/v/shortbox.svg?logo=Python&label=Version&style=flat-square)](https://pypi.org/p/shortbox/)
+[![PyPI - License](https://img.shields.io/pypi/l/shortbox.svg?logo=Python&label=License&style=flat-square)](https://opensource.org/licenses/MIT)
+
+[![prek](https://img.shields.io/badge/prek-enabled-informational?logo=prek&style=flat-square)](https://github.com/j178/prek)
+[![Ruff](https://img.shields.io/badge/Ruff-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ruff)
+[![ty](https://img.shields.io/badge/ty-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ty)
+
+[![status-badge](https://ci.codeberg.org/api/badges/17625/status.svg)](https://ci.codeberg.org/repos/17625)
+
+An extensible library to manage comic archives and their embedded files and metadata.
+
+## Supported Formats
+
+More can be added by extending the respective base class and adding to the registry.
+
+### Archives
+
+| Archive    | Extra Required |
+| ---------- | -------------- |
+| .cbz, .zip | _builtin_      |
+| .cbt, .tar | _builtin_      |
+| .cbr, .rar | cbr            |
+| .cb7, .7z  | cb7            |
+| .pdf       | pdf            |
+
+**Compability Table**
+
+| Format | Read | Update | Create |
+| ------ | :--: | :----: | :----: |
+| cbz    |  ✅  |   ✅   |   ✅   |
+| cbt    |  ❌  |   ❌   |   ✅   |
+| cbr    |  ✅  |   ❌   |   ❌   |
+| cb7    |  ✅  |   ❌   |   ✅   |
+| pdf    |  ✅  |   ✅   |   ❌   |
+
+If something is marked as in-compatible the library will try extracting and making the change via the local system and re-archive (if it has the create capability).
+
+### Metadata
+
+- [ComicInfo.xml v2.0](schemas/v2.0/ComicInfo.xsd)
+- [MetronInfo.xml v1.1](https://raw.githubusercontent.com/Metron-Project/metroninfo/master/schema/v1.1/MetronInfo.xsd)
+
+## Installation
+
+```sh
+pdm add shortbox
+```
+
+Optional extras can be added as needed:
+
+```sh
+pdm add shortbox[cbr,cb7,pdf]
+```
+
+## Usage
+
+```python
+from pathlib import Path
+
+from shortbox import Comic
+from shortbox.metadata import MetronInfo
+
+my_comic = Path("MyComic.cbz")
+with Comic.open(my_comic) as comic:
+    print(comic.list_filenames())
+    print(comic.read_file(filename="page-1.jpg").decode("UTF-8"))
+    print(comic.metadata)  # Dict of registered metadata in archive
+
+    metron_info = comic.get_metadata(metadata_type=MetronInfo)
+    print(metron_info.series)
+```
+
+Writing files and metadata (support depends on the archive format, see table above):
+
+```python
+with Comic.open(my_comic) as comic:
+    comic.write_file(filename="page-99.jpg", data=b"...", override=True)
+    comic.remove_file(filename="page-01.jpg")
+
+    metron_info = comic.get_metadata(metadata_type=MetronInfo)
+    metron_info.series.name = "Updated Title"
+    comic.set_metadata(metron_info)
+```
+
+You can also convert between different archives (as long as the destination archive has `create` capability)
+
+```python
+from shortbox.archives import ZipArchive
+
+rar_comic = Path("MyComic.cbr")
+with Comic.open(rar_comic) as comic:
+    print(comic.file)  # MyComic.cbr
+    comic.convert(
+        ZipArchive, delete_original=True
+    )  # All future comic interactions will be on the new archive
+    print(comic.file)  # MyComic.cbz
+```
+
+## Socials
+
+[![Social - Matrix](https://img.shields.io/matrix/The-Dev-Environment:matrix.org?label=The-Dev-Environment&logo=matrix&style=for-the-badge)](https://matrix.to/#/#The-Dev-Environment:matrix.org)

shortbox-0.4.0/README.md

@@ -0,0 +1,105 @@
+# Shortbox
+
+[![PyPI - Python](https://img.shields.io/pypi/pyversions/shortbox.svg?logo=Python&label=Python&style=flat-square)](https://pypi.org/p/shortbox/)
+[![PyPI - Status](https://img.shields.io/pypi/status/shortbox.svg?logo=Python&label=Status&style=flat-square)](https://pypi.org/p/shortbox/)
+[![PyPI - Version](https://img.shields.io/pypi/v/shortbox.svg?logo=Python&label=Version&style=flat-square)](https://pypi.org/p/shortbox/)
+[![PyPI - License](https://img.shields.io/pypi/l/shortbox.svg?logo=Python&label=License&style=flat-square)](https://opensource.org/licenses/MIT)
+
+[![prek](https://img.shields.io/badge/prek-enabled-informational?logo=prek&style=flat-square)](https://github.com/j178/prek)
+[![Ruff](https://img.shields.io/badge/Ruff-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ruff)
+[![ty](https://img.shields.io/badge/ty-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ty)
+
+[![status-badge](https://ci.codeberg.org/api/badges/17625/status.svg)](https://ci.codeberg.org/repos/17625)
+
+An extensible library to manage comic archives and their embedded files and metadata.
+
+## Supported Formats
+
+More can be added by extending the respective base class and adding to the registry.
+
+### Archives
+
+| Archive    | Extra Required |
+| ---------- | -------------- |
+| .cbz, .zip | _builtin_      |
+| .cbt, .tar | _builtin_      |
+| .cbr, .rar | cbr            |
+| .cb7, .7z  | cb7            |
+| .pdf       | pdf            |
+
+**Compability Table**
+
+| Format | Read | Update | Create |
+| ------ | :--: | :----: | :----: |
+| cbz    |  ✅  |   ✅   |   ✅   |
+| cbt    |  ❌  |   ❌   |   ✅   |
+| cbr    |  ✅  |   ❌   |   ❌   |
+| cb7    |  ✅  |   ❌   |   ✅   |
+| pdf    |  ✅  |   ✅   |   ❌   |
+
+If something is marked as in-compatible the library will try extracting and making the change via the local system and re-archive (if it has the create capability).
+
+### Metadata
+
+- [ComicInfo.xml v2.0](schemas/v2.0/ComicInfo.xsd)
+- [MetronInfo.xml v1.1](https://raw.githubusercontent.com/Metron-Project/metroninfo/master/schema/v1.1/MetronInfo.xsd)
+
+## Installation
+
+```sh
+pdm add shortbox
+```
+
+Optional extras can be added as needed:
+
+```sh
+pdm add shortbox[cbr,cb7,pdf]
+```
+
+## Usage
+
+```python
+from pathlib import Path
+
+from shortbox import Comic
+from shortbox.metadata import MetronInfo
+
+my_comic = Path("MyComic.cbz")
+with Comic.open(my_comic) as comic:
+    print(comic.list_filenames())
+    print(comic.read_file(filename="page-1.jpg").decode("UTF-8"))
+    print(comic.metadata)  # Dict of registered metadata in archive
+
+    metron_info = comic.get_metadata(metadata_type=MetronInfo)
+    print(metron_info.series)
+```
+
+Writing files and metadata (support depends on the archive format, see table above):
+
+```python
+with Comic.open(my_comic) as comic:
+    comic.write_file(filename="page-99.jpg", data=b"...", override=True)
+    comic.remove_file(filename="page-01.jpg")
+
+    metron_info = comic.get_metadata(metadata_type=MetronInfo)
+    metron_info.series.name = "Updated Title"
+    comic.set_metadata(metron_info)
+```
+
+You can also convert between different archives (as long as the destination archive has `create` capability)
+
+```python
+from shortbox.archives import ZipArchive
+
+rar_comic = Path("MyComic.cbr")
+with Comic.open(rar_comic) as comic:
+    print(comic.file)  # MyComic.cbr
+    comic.convert(
+        ZipArchive, delete_original=True
+    )  # All future comic interactions will be on the new archive
+    print(comic.file)  # MyComic.cbz
+```
+
+## Socials
+
+[![Social - Matrix](https://img.shields.io/matrix/The-Dev-Environment:matrix.org?label=The-Dev-Environment&logo=matrix&style=for-the-badge)](https://matrix.to/#/#The-Dev-Environment:matrix.org)

shortbox-0.4.0/pdm.toml

@@ -0,0 +1,2 @@
+[lock]
+format = "pylock"