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 π
Go aicertificationcloud-engineeringcybercybersecuritycybersecurity-analystcybersecurity-certificationcybersecurity-certificationscybersecurity-educationcybersecurity-jobscybersecurity-portfoliocybersecurity-projectscybersecurity-toolsgrchackinglearningpentestingproject-repositoryprojetcspython
updated readme and project version
HERITAGE-XIONd00d9d45989e
diff --git a/README.md b/README.mdindex bba2e38b..58a0f55d 100644--- a/README.md+++ b/README.md@@ -1,7 +1,11 @@-# π Metadata Scrubber Tool+# π Metadata ScrubberA privacy-focused CLI tool that removes sensitive metadata (EXIF, GPS, author info) from image files. Perfect for protecting your privacy before sharing photos online.+[](https://github.com/Heritage-XioN/metadata-scrubber-tool/actions)+[](https://python.org)+[](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## π Licensediff --git a/pyproject.toml b/pyproject.tomlindex 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.pyindex 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"# ---------------------------------------------------------