chore: Update dependencies and add coding conventions document

Author: titusz

CONVENTIONS.md

@@ -0,0 +1,25 @@
+# Coding Convetions
+
+- Write pragmatic, easily testable, and performant code!
+- Prefer short and pure functions where possible!
+- Keep the number of function arguments as low as possible!
+- Don´t use nested functions!
+- Write concise and to-the-point docstrings for all functions!
+- Use type comments style (PEP 484) instead of function annotations!
+- Always add a correct PEP 484 style type comment as the first line after the function definition!
+- Use built-in collection types as generic types for annotations (PEP 585)!
+- Use the | (pipe) operator for writing union types (PEP 604)!
+
+Example function with type annotations and docstring:
+
+```python
+def tokenize_chunks(chunks, max_len=None):
+    # type: (list[str], int|None) -> dict
+    """
+    Tokenize text chunks into model-compatible formats.
+
+    :param chunks: Text chunks to tokenize.
+    :param max_len: Truncates chunks above max_len characters
+    :return: Dictionary of tokenized data including input IDs, attention masks, and type IDs.
+    """
+```

accfix/ace_fix.py

@@ -62,7 +62,10 @@ def add_acc_meta_fxl(opf_tree):
     # type: (ElementTree) -> Generator[str, None, None]
     """Update or add default Fixed Layout metadata required by ACE"""
     root = opf_tree.getroot()
-    namespaces = {"opf": "http://www.idpf.org/2007/opf"}
+    namespaces = {
+        "opf": "http://www.idpf.org/2007/opf",
+        "tdm": "http://www.w3.org/ns/tdmrep#",
+    }
     metadata_element = root.find(".//opf:metadata", namespaces=namespaces)
 
     meta_elements = [
@@ -76,6 +79,7 @@ def add_acc_meta_fxl(opf_tree):
             "schema:accessibilitySummary",
             "Fixed Layout with html text placed over background images.",
         ),
+        ("tdm:reservation", "1"),
     ]
 
     for property_value, text_value in meta_elements:
@@ -146,6 +150,7 @@ def fix_hotspot_links_kf8(html_tree):
 
 if __name__ == "__main__":
     fp = r"../scratch/test1.epub"
-    epb = Epub(fp, clone=True)
-    for message in add_acc_meta_fxl(epb.opf_tree()):
+    cp = "../scratch/test1_clone.epub"
+    epb = Epub(fp, clone=True, clone_path="../scratch/test1_clone.epub")
+    for message in ace_fix_mec(epb):
         print(message)

accfix/epub.py

@@ -12,22 +12,26 @@
 
 
 class Epub:
-    def __init__(self, path, clone=True):
-        # type: (str|Path, bool) -> None
+    def __init__(self, path, clone=True, clone_path=None):
+        # type: (str|Path, bool, str|Path|None) -> None
         """EPUB file object for reading and writing members.
 
         :param path: Path to the EPUB file.
-        :param clone: Create a temporary copy of the EPUB file and open that one.
+        :param clone: Create a (temporary) copy of the EPUB file and open that one.
+        :param clone_path: Custom file path for the cloned EPUB file.
         """
         self._path = Path(path)
         self.name = self._path.name
         log.debug("Opening EPUB file: {name}".format(name=self._path.name))
         self._clone = None
         if clone:
-            temp_dir = tempfile.mkdtemp()
-            self._clone = Path(temp_dir) / self._path.name
+            if clone_path:
+                self._clone = Path(clone_path)
+            else:
+                temp_dir = tempfile.mkdtemp()
+                self._clone = Path(temp_dir) / self._path.name
             shutil.copy2(self._path, self._clone)
-            log.debug(f"Cloning EPUB file to: {self._clone.parent}")
+            log.debug(f"Cloning EPUB file to: {self._clone}")
         self._zf = ZipFileR(self.path, mode="a")
 
     def __del__(self):