Minor package updates, cleaned up README and pyproject files related to installation. Updated example_config.env

README.md

@@ -112,7 +112,7 @@ source venv/bin/activate
 This project uses `pyproject.toml` to manage dependencies. You can install everything with a single pip command. This process will also download the required Spacy models and other packages directly from their URLs.
 
 ```bash
-pip install .[paddle,vlm]
+pip install .
 ```
 
 Alternatively, you can install from the `requirements_lightweight.txt` file:

example_config.env

@@ -1,12 +1,27 @@
-TESSERACT_FOLDER=tesseract/
-POPPLER_FOLDER=poppler/poppler-24.02.0/Library/bin/
+# Rename this file to app_config.env and place it in the folder config/ (i.e. it will be located at app_base_folder/config/app_config.env). The app will then automatically load in these variables at startup. See tools/config.py for all the possible config variables you can set, or src/app_settings.qmd for descriptions. Below are some suggested config variables to start
+
+TESSERACT_FOLDER=tesseract/ # If in a custom folder, not needed if in PATH
+POPPLER_FOLDER=poppler/poppler-24.02.0/Library/bin/ # If in a custom folder, Not needed if in PATH
 SHOW_LANGUAGE_SELECTION=True
+SHOW_PADDLE_MODEL_OPTIONS=False
+SHOW_VLM_MODEL_OPTIONS=False
+SHOW_LOCAL_OCR_MODEL_OPTIONS=True
 CHOSEN_LOCAL_OCR_MODEL=tesseract
 
-SESSION_OUTPUT_FOLDER=False
+SAVE_EXAMPLE_HYBRID_IMAGES=True
+SAVE_PAGE_OCR_VISUALISATIONS=True
+OVERWRITE_EXISTING_OCR_RESULTS=False
+CONVERT_LINE_TO_WORD_LEVEL=False
+LOAD_PADDLE_AT_STARTUP=False
+SAVE_VLM_INPUT_IMAGES=True
+SAVE_WORD_SEGMENTER_OUTPUT_IMAGES=True
+PREPROCESS_LOCAL_OCR_IMAGES=False
+SAVE_PREPROCESS_IMAGES=True
+
+SESSION_OUTPUT_FOLDER=False # Save outputs into user session folders
 DISPLAY_FILE_NAMES_IN_LOGS=False
 
-RUN_AWS_FUNCTIONS=True # Set to False if you don't want to run AWS functions
+RUN_AWS_FUNCTIONS=True # Set to False if you don't want to run AWS functions. You can remove all the environment variables in the following section if you don't want to use them
 SAVE_LOGS_TO_DYNAMODB=True
 S3_COST_CODES_PATH=cost_codes.csv
 SHOW_AWS_TEXT_EXTRACTION_OPTIONS=True
@@ -24,3 +39,8 @@ GET_COST_CODES=True
 COST_CODES_PATH=config/cost_codes.csv
 ENFORCE_COST_CODES=True
 DEFAULT_COST_CODE=example_cost_code
+
+CUSTOM_BOX_COLOUR=(128, 128, 128)
+USE_GUI_BOX_COLOURS_FOR_OUTPUTS=False
+
+

pyproject.toml

@@ -2,15 +2,40 @@
 requires = ["setuptools>=61.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
-[project.urls]
-Homepage = "https://seanpedrick-case.github.io/doc_redaction/"
-Repository = "https://github.com/seanpedrick-case/doc_redaction"
-
 [project]
 name = "doc_redaction"
 version = "1.5.3"
 description = "Redact PDF/image-based documents, Word, or CSV/XLSX files using a Gradio-based GUI interface"
 readme = "README.md"
+authors = [
+    { name = "Sean Pedrick-Case", email = "[email protected]" },
+]
+maintainers = [
+    { name = "Sean Pedrick-Case", email = "[email protected]" },
+]
+license = { text = "AGPL-3.0-only" } # This licence type required to use PyMuPDF
+keywords = [
+    "redaction",
+    "pdf",
+    "nlp",
+    "documents",
+    "document-processing",
+    "gradio",
+    "pii",
+    "pii-detection"
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Legal Industry",
+    "Topic :: Text Processing :: General",
+    "Topic :: Security :: Cryptography",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
 requires-python = ">=3.10"
 dependencies = [
     "pdfminer.six==20251107",
@@ -24,10 +49,10 @@ dependencies = [
     "pikepdf==9.11.0",
     "pandas==2.3.3",
     "scikit-learn==1.7.2",
-    "spacy==3.8.7",
+    "spacy==3.8.8",
     "en_core_web_lg @ https://github.com/explosion/spacy-models/releases/download/en_core_web_lg-3.8.0/en_core_web_lg-3.8.0.tar.gz",
     "gradio==5.49.1",
-    "boto3==1.40.69",
+    "boto3==1.40.72",
     "pyarrow==21.0.0",
     "openpyxl==3.1.5",
     "Faker==37.8.0",
@@ -38,9 +63,10 @@ dependencies = [
     "python-dotenv==1.0.1",
     "awslambdaric==3.1.1",
     "python-docx==1.2.0",
-    "polars==1.33.1",
+    "polars==1.35.2",
     "defusedxml==0.7.1",
     "numpy==2.2.6",
+    "spaces==0.42.1",
 ]
 
 [project.optional-dependencies]
@@ -67,6 +93,13 @@ vlm = [
     "accelerate==1.11.0",
 ]
 
+[project.urls]
+Homepage = "https://seanpedrick-case.github.io/doc_redaction/"
+Repository = "https://github.com/seanpedrick-case/doc_redaction"
+
+[project.scripts]
+cli_redact = "cli_redact:main"
+
 # Configuration for Ruff linter:
 [tool.ruff]
 line-length = 88

requirements.txt

@@ -1,11 +1,11 @@
 # --- Core and data packages ---
 numpy==2.2.6
 pandas==2.3.3
-bleach=6.3.0
-polars==1.33.1
+bleach==6.3.0
+polars==1.35.2
 pyarrow==21.0.0
 openpyxl==3.1.5
-boto3==1.40.69
+boto3==1.40.72
 python-dotenv==1.0.1
 defusedxml==0.7.1
 Faker==37.8.0
@@ -35,7 +35,7 @@ awslambdaric==3.1.1
 
 # --- Machine learning / NLP ---
 scikit-learn==1.7.2
-spacy==3.8.7
+spacy==3.8.8
 spaczz==0.6.1
 en_core_web_lg @ https://github.com/explosion/spacy-models/releases/download/en_core_web_lg-3.8.0/en_core_web_lg-3.8.0.tar.gz
 transformers==4.57.1

requirements_lightweight.txt

@@ -1,11 +1,11 @@
 # --- Core and data packages ---
 numpy==2.2.6
 pandas==2.3.3
-polars==1.33.1
+polars==1.35.2
 bleach==6.3.0
 pyarrow==21.0.0
 openpyxl==3.1.5
-boto3==1.40.69
+boto3==1.40.72
 python-dotenv==1.0.1
 defusedxml==0.7.1
 Faker==37.8.0
@@ -14,7 +14,7 @@ rapidfuzz==3.14.1
 
 # --- Machine learning / NLP ---
 scikit-learn==1.7.2
-spacy==3.8.7
+spacy==3.8.8
 spaczz==0.6.1
 en_core_web_lg @ https://github.com/explosion/spacy-models/releases/download/en_core_web_lg-3.8.0/en_core_web_lg-3.8.0.tar.gz