Skip to main content

A CLI tool to remove, edit, or selectively filter metadata from images, documents, audio, and video files.

Project description

Metadata Cleaner

CI Release PyPI version License: MIT

Metadata Cleaner is a privacy-focused CLI for viewing and removing metadata from local files. It writes cleaned copies by default and avoids modifying originals in-place.

Supported Files

  • Images: JPG, JPEG, PNG, TIFF, WEBP, AVIF
  • Documents: PDF, DOCX, TXT
  • Audio: MP3, WAV, FLAC, OGG, AAC, M4A, WMA
  • Video: MP4, MKV, MOV, AVI, WEBM, FLV

Video support requires ffmpeg and ffprobe. AVIF and broader metadata coverage benefit from exiftool.

Installation

Requires Python 3.11 or newer.

pip install metadata-cleaner
metadata-cleaner --help

For development:

git clone https://github.com/sandy-sp/metadata-cleaner.git
cd metadata-cleaner
poetry install --with dev
poetry run metadata-cleaner --help

CLI Usage

View metadata:

metadata-cleaner view sample.jpg

Print metadata for automation:

metadata-cleaner view sample.jpg --json

Remove metadata from one file:

metadata-cleaner delete sample.jpg

Write to a specific file:

metadata-cleaner delete sample.jpg --output cleaned/sample.jpg

Process a folder recursively:

metadata-cleaner delete ./photos --output ./cleaned-photos

Preview a run without writing files:

metadata-cleaner delete ./photos --dry-run

Write a JSON summary report:

metadata-cleaner delete ./photos --summary-file reports/summary.json

Summary reports include per-file status and output paths for audit trails.

Edit metadata where supported:

metadata-cleaner edit song.mp3 --changes '{"artist": "Unknown"}'

Development Checks

python3 manage.py test
python3 manage.py lint
python3 manage.py check

CI runs tests, lint, and pip-audit on pull requests and pushes to main.

Docker

docker build -t metadata-cleaner .
docker run --rm -v "$(pwd)/photos:/data" metadata-cleaner delete /data

Logging

By default, logs go to stderr only. To write a log file, opt in explicitly:

METADATA_CLEANER_LOG_FILE=./metadata-cleaner.log metadata-cleaner delete sample.jpg

Use debug logging when needed:

METADATA_CLEANER_LOG_LEVEL=DEBUG metadata-cleaner view sample.jpg

Resources

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

metadata_cleaner-3.7.1.tar.gz (18.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

metadata_cleaner-3.7.1-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

Details for the file metadata_cleaner-3.7.1.tar.gz.

File metadata

  • Download URL: metadata_cleaner-3.7.1.tar.gz
  • Upload date:
  • Size: 18.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.12.3 Linux/6.17.0-1010-azure

File hashes

Hashes for metadata_cleaner-3.7.1.tar.gz
Algorithm Hash digest
SHA256 a40122dfc8e01918faf29943f9faf97690259b7e278ef396339d567d00ea7bdf
MD5 f7c5030e84f822e9b49e234c926fe3f7
BLAKE2b-256 665827a8551e94db59ea128ee5b3bc559894b07b14a9c58676410b07b184ea58

See more details on using hashes here.

File details

Details for the file metadata_cleaner-3.7.1-py3-none-any.whl.

File metadata

  • Download URL: metadata_cleaner-3.7.1-py3-none-any.whl
  • Upload date:
  • Size: 24.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.12.3 Linux/6.17.0-1010-azure

File hashes

Hashes for metadata_cleaner-3.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 12e76fb61a92b6107153d34b539299c79e581301fb49b0c9c36275eca7a6538b
MD5 deb09d9eeb8f0e936a8f43afbffad57c
BLAKE2b-256 b60176211242e5e7f193bba6cbd3d380a110586b3fc78c47b92249b8a30472e5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page