Skip to content

Building 70 Projects ranging from beginner to advanced so anyone can β€” learn from, build upon, use as a reference, or even copy directly. Owned by my cybersecurity company πŸ‘‡

updated readme and project version

HERITAGE-XIONd00d9d45989e
diff --git a/README.md b/README.md
index bba2e38b..58a0f55d 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,11 @@
-# πŸ”’ Metadata Scrubber Tool
+# πŸ”’ Metadata Scrubber
A privacy-focused CLI tool that removes sensitive metadata (EXIF, GPS, author info) from image files. Perfect for protecting your privacy before sharing photos online.
+[![Tests](https://github.com/Heritage-XioN/metadata-scrubber-tool/actions/workflows/test.yml/badge.svg)](https://github.com/Heritage-XioN/metadata-scrubber-tool/actions)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://python.org)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
## ✨ Features
- **Multi-format support** - JPEG, PNG (with PDF/Office planned)
@@ -11,106 +15,107 @@ A privacy-focused CLI tool that removes sensitive metadata (EXIF, GPS, author in
- **Beautiful CLI** - Rich progress bars and formatted output
- **Privacy-first** - Removes GPS coordinates, camera info, timestamps, author data
-## πŸ“š Educational Value
+## πŸš€ Quick Start
-This project demonstrates:
-- **Factory pattern** for extensible file type handling
-- **Abstract base classes** for consistent handler interfaces
-- **Concurrent processing** with thread-safe operations
-- **CLI development** with Typer and Rich
-- **Image metadata handling** with Pillow and piexif
+### Installation
-## πŸ“‹ Prerequisites
+```bash
+# Using uv (recommended)
+uv pip install metadata-scrubber
-- Python 3.10+
-- [uv](https://github.com/astral-sh/uv) (recommended) or pip
+# Or clone and install locally
+git clone https://github.com/Heritage-XioN/metadata-scrubber-tool.git
+cd metadata-scrubber-tool
+uv sync
+```
-## πŸš€ Installation
+### Basic Usage
```bash
-# Clone the repository
-git clone https://github.com/Heritage-XioN/metadata-scrubber-tool.git
-cd metadata-scrubber-tool
+# Read metadata from a file
+mst read photo.jpg
-# Create virtual environment and install dependencies
-uv venv
-.venv\Scripts\activate # Windows
-# source .venv/bin/activate # Linux/Mac
+# Scrub metadata and save to output folder
+mst scrub photo.jpg --output ./cleaned
-uv pip install -r requirements.txt
+# Batch process entire folder
+mst scrub ./photos -r -ext jpg --output ./cleaned
```
-## πŸ“– Usage
+## πŸ“– Commands
-### Read Metadata
+### `mst read` - View Metadata
```bash
-# Single file
-python -m src.main read photo.jpg
+mst read photo.jpg # Single file
+mst read ./photos -r -ext jpg # Directory (recursive)
+```
+
+### `mst scrub` - Remove Metadata
-# Recursive directory scan
-python -m src.main read ./photos/ -r -ext jpg
+```bash
+mst scrub photo.jpg --output ./out # Single file
+mst scrub ./photos -r -ext jpg -o ./out # Directory
+mst scrub ./photos -r -ext jpg --dry-run # Preview only
+mst scrub ./photos -r -ext jpg -w 8 # 8 concurrent workers
```
-### Scrub Metadata
+### CLI Options
+
+| Option | Description |
+|--------|-------------|
+| `-r`, `--recursive` | Process directories recursively |
+| `-ext`, `--extension` | Filter by file extension (jpg, png) |
+| `-o`, `--output` | Output directory for cleaned files |
+| `-d`, `--dry-run` | Preview without making changes |
+| `-w`, `--workers` | Number of concurrent workers |
+| `-V`, `--verbose` | Show detailed debug logs |
+| `-v`, `--version` | Show version |
+
+## πŸ› οΈ Development
+
+### Setup
```bash
-# Single file
-python -m src.main scrub photo.jpg --output ./cleaned
+git clone https://github.com/Heritage-XioN/metadata-scrubber-tool.git
+cd metadata-scrubber-tool
-# Batch process with 8 workers
-python -m src.main scrub ./photos/ -r -ext jpg --output ./cleaned --workers 8
+# Install with dev dependencies
+uv sync --all-extras
-# Preview without changes
-python -m src.main scrub ./photos/ -r -ext jpg --dry-run
-```
+# Run tests
+pytest
-### CLI Options
+# Run linting
+ruff check .
-| Command | Options |
-|---------|---------|
-| `read` | `-r` / `--recursive`, `-ext` / `--extension` |
-| `scrub` | `-r`, `-ext`, `-o` / `--output`, `-d` / `--dry-run`, `-w` / `--workers` |
-| Global | `-V` / `--verbose`, `-v` / `--version` |
+# Run type checking
+mypy src
+```
-## πŸ—οΈ Architecture
+### Project Structure
```
src/
β”œβ”€β”€ main.py # CLI entry point (Typer app)
β”œβ”€β”€ commands/
-β”‚ β”œβ”€β”€ read.py # Read metadata command
-β”‚ └── scrub.py # Scrub metadata command (batch processing)
+β”‚ β”œβ”€β”€ read.py # Read metadata command
+β”‚ └── scrub.py # Scrub metadata command
β”œβ”€β”€ services/
β”‚ β”œβ”€β”€ metadata_factory.py # Factory for creating handlers
-β”‚ β”œβ”€β”€ metadata_handler.py # Abstract base class
β”‚ β”œβ”€β”€ image_handler.py # JPEG/PNG handler
β”‚ └── batch_processor.py # Concurrent batch processing
-β”œβ”€β”€ core/
-β”‚ β”œβ”€β”€ jpeg_metadata.py # JPEG EXIF processor (piexif)
-β”‚ └── png_metadata.py # PNG metadata processor (PIL)
-└── utils/
- β”œβ”€β”€ display.py # Rich output formatting
- β”œβ”€β”€ formatter.py # Value formatting helpers
- β”œβ”€β”€ exceptions.py # Custom exceptions
- └── logger.py # Logging configuration
-```
-
-**Data Flow:**
-```
-CLI Command → MetadataFactory → Handler (read→wipe→save) → Output
- ↓
- Format Detection
- ↓
- JpegProcessor / PngProcessor
+└── core/
+ β”œβ”€β”€ jpeg_metadata.py # JPEG EXIF processor
+ └── png_metadata.py # PNG metadata processor
```
## ⚠️ Security Considerations
-- **Always backup files** before scrubbing in production
+- **Original files are never modified** - processed copies are created
- **Use `--dry-run`** to preview changes before committing
- **GPS coordinates** are completely stripped for privacy
-- **Original files are not modified** - processed copies are created
+- **Always backup files** before scrubbing in production
## πŸ“„ License
diff --git a/pyproject.toml b/pyproject.toml
index 90f525dc..962c1979 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
[project]
name = "metadata-scrubber"
-version = "0.1.0"
+version = "0.1.1"
description = "A privacy-focused CLI tool that removes sensitive metadata from image files"
readme = "README.md"
requires-python = ">=3.10"
diff --git a/src/main.py b/src/main.py
index 2c5543c8..99d4d0fc 100644
--- a/src/main.py
+++ b/src/main.py
@@ -22,7 +22,7 @@ app = typer.Typer(no_args_is_help=True, pretty_exceptions_show_locals=False)
log = logging.getLogger("metadata-scrubber")
-__version__ = "0.1.0"
+__version__ = "0.1.1"
# ---------------------------------------------------------