doc-redaction 2.2.1__tar.gz → 2.2.2__tar.gz

{doc_redaction-2.2.1/doc_redaction.egg-info → doc_redaction-2.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: doc_redaction
-Version: 2.2.1
+Version: 2.2.2
 Summary: Redact PDF/image-based documents, Word, or CSV/XLSX files using a Gradio-based GUI interface
 Author-email: Sean Pedrick-Case <spedrickcase@lambeth.gov.uk>
 Maintainer-email: Sean Pedrick-Case <spedrickcase@lambeth.gov.uk>
@@ -190,7 +190,13 @@ For programmatic use (CLI-first API matching Gradio `api_name` routes), see **[P
 python -m app
 ```
 
-In practice, the **smoothest UI experience** (examples, bundled assets, docs links, etc.) is still usually via a **repository checkout** or **Docker**, but PyPI install is sufficient to launch the UI as long as you run it from a suitable working folder and have the system dependencies available (or run `python -m doc_redaction.install_deps` first).
+**Important: your working directory matters.** When you run `python -m app`, the app treats your *current folder* as the “app folder”:
+
+- It will load configuration from `config/app_config.env` *relative to the folder you run it from* (and `python -m doc_redaction.install_deps` will also create/update that file there).
+- It may create new folders in that location (for example `config/`, `output/`, `input/`, `logs/`, `usage/`, `feedback/`, and temporary/cache folders depending on your settings).
+- The full set of bundled UI example files (`example_data/`) is part of the **Git repository checkout** rather than the PyPI wheel. If you run from a “random” directory after a PyPI install, you should expect the Examples section to be missing unless you provide your own `example_data/` folder.
+
+In practice, the **smoothest UI experience** (examples, bundled assets, docs links, predictable relative paths) is still usually via a **repository checkout** or **Docker**, but PyPI install is sufficient to launch the UI as long as you run it from a suitable working folder and have the system dependencies available (or run `python -m doc_redaction.install_deps` first).
 
 #### Install from source (repository checkout / development)
 

{doc_redaction-2.2.1 → doc_redaction-2.2.2}/README.md

@@ -127,7 +127,13 @@ For programmatic use (CLI-first API matching Gradio `api_name` routes), see **[P
 python -m app
 ```
 
-In practice, the **smoothest UI experience** (examples, bundled assets, docs links, etc.) is still usually via a **repository checkout** or **Docker**, but PyPI install is sufficient to launch the UI as long as you run it from a suitable working folder and have the system dependencies available (or run `python -m doc_redaction.install_deps` first).
+**Important: your working directory matters.** When you run `python -m app`, the app treats your *current folder* as the “app folder”:
+
+- It will look for configuration at `config/app_config.env` *relative to the folder you run it from* (and `python -m doc_redaction.install_deps` will also write `config/app_config.env` there).
+- It may create new folders in that location (for example `config/`, `output/`, `input/`, `logs/`, `usage/`, `feedback/`, and temporary/cache folders depending on your settings).
+- The full set of bundled UI example files (`example_data/`) is part of the **Git repository checkout** rather than the PyPI wheel. If you run from a “random” directory after a PyPI install, you should expect the Examples section to be missing unless you provide your own `example_data/` folder.
+
+In practice, the **smoothest UI experience** (examples, bundled assets, docs links, predictable relative paths) is still usually via a **repository checkout** or **Docker**, but PyPI install is sufficient to launch the UI as long as you run it from a suitable working folder and have the system dependencies available (or run `python -m doc_redaction.install_deps` first).
 
 #### Install from source (repository checkout / development)
 
@@ -243,6 +249,11 @@ These settings are useful for all users, regardless of whether you are using AWS
     *   Provide the path to the respective installation folders (for Poppler, point to the `bin` sub-directory).
     *   **Examples:** `POPPLER_FOLDER=C:/Program Files/poppler-24.02.0/bin/` `TESSERACT_FOLDER=tesseract/`
 
+*   `TESSERACT_DATA_FOLDER`
+    *   If Tesseract runs but you see an error like `Error opening data file ./eng.traineddata` or `Tesseract couldn't load any languages`, this is usually because it can't find the `tessdata/` language files.
+    *   Set this to the folder that contains `eng.traineddata` (typically a `tessdata` directory).
+    *   **Examples (Windows):** `TESSERACT_DATA_FOLDER=C:/Program Files/Tesseract-OCR/tessdata`
+
 *   `SHOW_LANGUAGE_SELECTION=True`
     *   Set to `True` to display a language selection dropdown in the UI for OCR processing.
 

{doc_redaction-2.2.1 → doc_redaction-2.2.2}/README_PYPI.md

@@ -116,7 +116,13 @@ For programmatic use (CLI-first API matching Gradio `api_name` routes), see **[P
 python -m app
 ```
 
-In practice, the **smoothest UI experience** (examples, bundled assets, docs links, etc.) is still usually via a **repository checkout** or **Docker**, but PyPI install is sufficient to launch the UI as long as you run it from a suitable working folder and have the system dependencies available (or run `python -m doc_redaction.install_deps` first).
+**Important: your working directory matters.** When you run `python -m app`, the app treats your *current folder* as the “app folder”:
+
+- It will load configuration from `config/app_config.env` *relative to the folder you run it from* (and `python -m doc_redaction.install_deps` will also create/update that file there).
+- It may create new folders in that location (for example `config/`, `output/`, `input/`, `logs/`, `usage/`, `feedback/`, and temporary/cache folders depending on your settings).
+- The full set of bundled UI example files (`example_data/`) is part of the **Git repository checkout** rather than the PyPI wheel. If you run from a “random” directory after a PyPI install, you should expect the Examples section to be missing unless you provide your own `example_data/` folder.
+
+In practice, the **smoothest UI experience** (examples, bundled assets, docs links, predictable relative paths) is still usually via a **repository checkout** or **Docker**, but PyPI install is sufficient to launch the UI as long as you run it from a suitable working folder and have the system dependencies available (or run `python -m doc_redaction.install_deps` first).
 
 #### Install from source (repository checkout / development)
 

{doc_redaction-2.2.1 → doc_redaction-2.2.2/doc_redaction.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: doc_redaction
-Version: 2.2.1
+Version: 2.2.2
 Summary: Redact PDF/image-based documents, Word, or CSV/XLSX files using a Gradio-based GUI interface
 Author-email: Sean Pedrick-Case <spedrickcase@lambeth.gov.uk>
 Maintainer-email: Sean Pedrick-Case <spedrickcase@lambeth.gov.uk>
@@ -190,7 +190,13 @@ For programmatic use (CLI-first API matching Gradio `api_name` routes), see **[P
 python -m app
 ```
 
-In practice, the **smoothest UI experience** (examples, bundled assets, docs links, etc.) is still usually via a **repository checkout** or **Docker**, but PyPI install is sufficient to launch the UI as long as you run it from a suitable working folder and have the system dependencies available (or run `python -m doc_redaction.install_deps` first).
+**Important: your working directory matters.** When you run `python -m app`, the app treats your *current folder* as the “app folder”:
+
+- It will load configuration from `config/app_config.env` *relative to the folder you run it from* (and `python -m doc_redaction.install_deps` will also create/update that file there).
+- It may create new folders in that location (for example `config/`, `output/`, `input/`, `logs/`, `usage/`, `feedback/`, and temporary/cache folders depending on your settings).
+- The full set of bundled UI example files (`example_data/`) is part of the **Git repository checkout** rather than the PyPI wheel. If you run from a “random” directory after a PyPI install, you should expect the Examples section to be missing unless you provide your own `example_data/` folder.
+
+In practice, the **smoothest UI experience** (examples, bundled assets, docs links, predictable relative paths) is still usually via a **repository checkout** or **Docker**, but PyPI install is sufficient to launch the UI as long as you run it from a suitable working folder and have the system dependencies available (or run `python -m doc_redaction.install_deps` first).
 
 #### Install from source (repository checkout / development)
 

{doc_redaction-2.2.1 → doc_redaction-2.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "doc_redaction"
-version = "2.2.1"
+version = "2.2.2"
 description = "Redact PDF/image-based documents, Word, or CSV/XLSX files using a Gradio-based GUI interface"
 readme = "README_PYPI.md"
 authors = [

{doc_redaction-2.2.1 → doc_redaction-2.2.2}/tools/config.py

@@ -1166,7 +1166,7 @@ SHOW_OCR_GUI_OPTIONS = convert_string_to_boolean(
 )
 
 SHOW_LOCAL_OCR_MODEL_OPTIONS = convert_string_to_boolean(
-    get_or_create_env_var("SHOW_LOCAL_OCR_MODEL_OPTIONS", "False")
+    get_or_create_env_var("SHOW_LOCAL_OCR_MODEL_OPTIONS", "True")
 )
 
 SHOW_PADDLE_MODEL_OPTIONS = convert_string_to_boolean(

{doc_redaction-2.2.1 → doc_redaction-2.2.2}/tools/custom_image_analyser_engine.py

@@ -6,6 +6,7 @@ import json
 import math
 import os
 import re
+import shutil
 import threading
 import time
 from concurrent.futures import ThreadPoolExecutor
@@ -111,6 +112,97 @@ from tools.secure_path_utils import validate_folder_containment
 from tools.secure_regex_utils import safe_sanitize_text
 from tools.word_segmenter import AdaptiveSegmenter
 
+# ---- Tesseract discovery helpers -------------------------------------------------
+
+
+def _is_probable_tessdata_dir(path: str) -> bool:
+    try:
+        if not path:
+            return False
+        p = os.path.abspath(os.path.expandvars(os.path.expanduser(path)))
+        if not os.path.isdir(p):
+            return False
+        # If eng.traineddata exists, it's definitely a tessdata dir. Otherwise allow
+        # the folder if it contains *any* traineddata (language packs vary).
+        if os.path.isfile(os.path.join(p, "eng.traineddata")):
+            return True
+        for name in os.listdir(p):
+            if name.lower().endswith(".traineddata"):
+                return True
+    except Exception:
+        return False
+    return False
+
+
+def _guess_tessdata_dir_from_tesseract_exe(tesseract_exe: str | None) -> str | None:
+    if not tesseract_exe:
+        return None
+    exe_dir = os.path.dirname(os.path.abspath(tesseract_exe))
+
+    # Common Windows installer layout:
+    #   C:\Program Files\Tesseract-OCR\tesseract.exe
+    #   C:\Program Files\Tesseract-OCR\tessdata\eng.traineddata
+    candidate = os.path.join(exe_dir, "tessdata")
+    if _is_probable_tessdata_dir(candidate):
+        return candidate
+
+    # Common conda-forge layout on Windows:
+    #   <prefix>\Library\bin\tesseract.exe
+    #   <prefix>\Library\share\tessdata\eng.traineddata
+    up1 = os.path.dirname(exe_dir)
+    up2 = os.path.dirname(up1)
+    conda_candidate = os.path.join(up2, "share", "tessdata")
+    if _is_probable_tessdata_dir(conda_candidate):
+        return conda_candidate
+
+    return None
+
+
+def _resolve_tessdata_dir() -> str | None:
+    """
+    Return an absolute tessdata directory if we can find one.
+    Priority:
+    1) Existing TESSDATA_PREFIX if it points to a valid tessdata dir
+    2) tools.config.TESSERACT_DATA_FOLDER if it points to a valid tessdata dir
+    3) Guess based on tesseract executable location (PATH / pytesseract config)
+    """
+    env_prefix = os.environ.get("TESSDATA_PREFIX", "")
+    if _is_probable_tessdata_dir(env_prefix):
+        return os.path.abspath(env_prefix)
+
+    try:
+        from tools.config import TESSERACT_DATA_FOLDER
+
+        if _is_probable_tessdata_dir(TESSERACT_DATA_FOLDER):
+            return os.path.abspath(TESSERACT_DATA_FOLDER)
+    except Exception:
+        # config import is optional for library use
+        pass
+
+    tesseract_exe = getattr(
+        pytesseract.pytesseract, "tesseract_cmd", None
+    ) or shutil.which("tesseract")
+    return _guess_tessdata_dir_from_tesseract_exe(tesseract_exe)
+
+
+def _ensure_tessdata_available_in_env(existing_config: str | None) -> str | None:
+    """
+    Ensure Tesseract can find language traineddata files by:
+    - setting TESSDATA_PREFIX if we can resolve tessdata dir
+    - adding --tessdata-dir to the tesseract config string when not already present
+    """
+    tessdata_dir = _resolve_tessdata_dir()
+    if not tessdata_dir:
+        return existing_config
+
+    os.environ.setdefault("TESSDATA_PREFIX", tessdata_dir)
+
+    cfg = (existing_config or "").strip()
+    if "--tessdata-dir" in cfg:
+        return cfg
+    return (cfg + f' --tessdata-dir "{tessdata_dir}"').strip()
+
+
 # AWS Comprehend billing: 1 unit = 100 characters (entity recognition, PII, etc.)
 COMPREHEND_CHARACTERS_PER_UNIT = 100
 
@@ -8516,10 +8608,11 @@ class CustomImageAnalyzerEngine:
 
         elif self.ocr_engine == "tesseract":
 
+            tesseract_cfg = _ensure_tessdata_available_in_env(self.tesseract_config)
             ocr_data = pytesseract.image_to_data(
                 image,
                 output_type=pytesseract.Output.DICT,
-                config=self.tesseract_config,
+                config=tesseract_cfg,
                 lang=self.tesseract_lang,  # Ensure the Tesseract language data (e.g., fra.traineddata) is installed on your system.
             )