updated documentation and taskfile

Author: isadoraPGoNitro

samples/python/.gitignore

@@ -13,6 +13,10 @@ __pycache__/
 .Python
 *.egg-info/
 
-# Virtual environment
+# uv
 .venv/
+uv.lock
+
+# Ruff cache
+.ruff_cache/
 

samples/python/.python-version

@@ -0,0 +1 @@
+3.14

samples/python/README.md

@@ -51,9 +51,59 @@ This project uses [uv](https://docs.astral.sh/uv/) for fast, reliable Python pac
 
 4. Run the quickstart example:
    ```bash
-   python quickstart.py
+   uv run python quickstart.py
    ```
 
+## Development
+
+### Running Scripts with uv
+
+All Python scripts should be run using `uv run` to ensure they use the correct dependencies:
+
+```bash
+uv run python script.py
+```
+
+### Code Quality Tools
+
+This project uses multiple linting and type checking tools configured in `pyproject.toml`:
+
+#### Ruff (Fast Python linter)
+```bash
+# Check for linting issues
+uvx ruff check
+
+# Auto-fix issues
+uvx ruff check --fix
+
+# Format code
+uvx ruff format
+```
+
+#### Pylint (Comprehensive linter)
+```bash
+# Check all Python files
+uv run pylint *.py api/*.py helper_functions/*.py
+
+# Check specific file
+uv run pylint convert_cli.py
+```
+
+#### Pyright (Type checker)
+```bash
+# Type check all files
+uv run pyright
+
+# Type check specific file
+uv run pyright convert_cli.py
+```
+
+#### Run All Quality Checks
+```bash
+# Run all three tools
+uvx ruff check && uv run pylint *.py api/*.py helper_functions/*.py && uv run pyright
+```
+
 ## Architecture
 
 ### API Client Structure
@@ -101,43 +151,43 @@ api/
 
 ### Authentication
 ```bash
-python quickstart.py
+uv run python quickstart.py
 ```
 
 ### Convert Documents
 ```bash
 # Convert DOCX to PDF
-python convert_cli.py input.docx output.pdf pdf
+uv run python convert_cli.py input.docx output.pdf pdf
 
 # Convert PDF to DOCX
-python convert_cli.py input.pdf output.docx docx
+uv run python convert_cli.py input.pdf output.docx docx
 ```
 
 ### Extract Data
 ```bash
 # Extract tables
-python extract_data.py tables input.pdf output.json
+uv run python extract_data.py tables input.pdf output.json
 
 # Extract forms
-python extract_data.py forms input.pdf output.json
+uv run python extract_data.py forms input.pdf output.json
 ```
 
 ### Redact Content
 ```bash
 # Auto-detect and redact PII
-python smart_redact_pii.py input.pdf output.pdf
+uv run python smart_redact_pii.py input_folder output_folder
 
 # Redact specific keywords
-python redact_by_keyword.py input.pdf output.pdf "confidential" "secret"
+uv run python redact_by_keyword.py input_folder output_folder "confidential" "secret"
 ```
 
 ### Batch Operations
 ```bash
 # Convert all DOCX files to PDF
-python batch_process.py ./input ./output pdf "*.docx"
+uv run python batch_process.py ./input ./output pdf "*.docx"
 
 # Password protect all PDFs
-python bulk_password_protect.py ./input ./output "MyPassword123"
+uv run python bulk_password_protect.py ./input ./output "MyPassword123"
 ```
 
 ## Using the API Client

samples/python/Taskfile.yml

@@ -4,49 +4,49 @@ tasks:
   smart-redact:
     desc: "Smart redact PII from documents in a folder (e.g., task smart-redact INPUT_DIR=./documents OUTPUT_DIR=./redacted)"
     cmds:
-      - python smart_redact_pii.py "{{.INPUT_DIR}}" "{{.OUTPUT_DIR}}"
+      - uv run python smart_redact_pii.py "{{.INPUT_DIR}}" "{{.OUTPUT_DIR}}"
     requires:
       vars: [INPUT_DIR, OUTPUT_DIR]
 
   convert:
     desc: "Convert document from CLI (e.g., task convert INPUT=doc.docx OUTPUT=doc.pdf FORMAT=pdf)"
     cmds:
-      - python convert_cli.py {{.INPUT}} {{.OUTPUT}} {{.FORMAT}}
+      - uv run python convert_cli.py {{.INPUT}} {{.OUTPUT}} {{.FORMAT}}
     requires:
       vars: [INPUT, OUTPUT, FORMAT]
 
   batch:
     desc: "Batch process documents (e.g., task batch INPUT_DIR=./docs OUTPUT_DIR=./output FORMAT=pdf PATTERN='*.docx')"
     cmds:
-      - python batch_process.py "{{.INPUT_DIR}}" "{{.OUTPUT_DIR}}" {{.FORMAT}} "{{.PATTERN | default "*"}}"
+      - uv run python batch_process.py "{{.INPUT_DIR}}" "{{.OUTPUT_DIR}}" {{.FORMAT}} "{{.PATTERN | default "*"}}"
     requires:
       vars: [INPUT_DIR, OUTPUT_DIR, FORMAT]
 
   extract:
     desc: "Extract forms or tables from PDF (e.g., task extract MODE=forms INPUT=form.pdf OUTPUT=data.json)"
     cmds:
-      - python extract_data.py {{.MODE}} "{{.INPUT}}" "{{.OUTPUT}}"
+      - uv run python extract_data.py {{.MODE}} "{{.INPUT}}" "{{.OUTPUT}}"
     requires:
       vars: [MODE, INPUT, OUTPUT]
 
   password-protect:
     desc: "Bulk password protect PDFs (e.g., task password-protect INPUT_DIR=./pdfs OUTPUT_DIR=./protected PASSWORD=secret123)"
     cmds:
-      - python bulk_password_protect.py "{{.INPUT_DIR}}" "{{.OUTPUT_DIR}}" "{{.PASSWORD}}"
+      - uv run python bulk_password_protect.py "{{.INPUT_DIR}}" "{{.OUTPUT_DIR}}" "{{.PASSWORD}}"
     requires:
       vars: [INPUT_DIR, OUTPUT_DIR, PASSWORD]
 
   redact-keyword:
     desc: "Redact specific keywords from a PDF (e.g., task redact-keyword INPUT=doc.pdf OUTPUT=redacted.pdf KEYWORDS='confidential secret')"
     cmds:
-      - python redact_by_keyword.py {{.INPUT}} {{.OUTPUT}} {{.KEYWORDS}}
+      - uv run python redact_by_keyword.py {{.INPUT}} {{.OUTPUT}} {{.KEYWORDS}}
     requires:
       vars: [INPUT, OUTPUT, KEYWORDS]
 
   install:
-    desc: "Install Python dependencies"
+    desc: "Install Python dependencies using uv"
     cmds:
-      - pip install -r requirements.txt
+      - uv sync
 
   setup:
     desc: "Setup environment (copy .env.example to .env)"
@@ -57,7 +57,7 @@ tasks:
   prepare-distribution:
     desc: "Prepare documents for external distribution (convert, compress, remove metadata) (e.g., task prepare-distribution INPUT_DIR=./brochures OUTPUT_DIR=./ready)"
     cmds:
-      - python prepare_pdf_for_distribution.py "{{.INPUT_DIR}}" "{{.OUTPUT_DIR}}"
+      - uv run python prepare_pdf_for_distribution.py "{{.INPUT_DIR}}" "{{.OUTPUT_DIR}}"
     requires:
       vars: [INPUT_DIR, OUTPUT_DIR]
 
@@ -66,6 +66,6 @@ tasks:
   onboard-employees:
     desc: "Send company policies to new employees for signature (e.g., task onboard-employees POLICIES_DIR=./policies CSV=new_hires.csv)"
     cmds:
-      - python employee_policy_onboarding.py "{{.POLICIES_DIR}}" "{{.CSV}}"
+      - uv run python employee_policy_onboarding.py "{{.POLICIES_DIR}}" "{{.CSV}}"
     requires:
       vars: [POLICIES_DIR, CSV]