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.0.tar.gz (18.7 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.0-py3-none-any.whl (24.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: metadata_cleaner-3.7.0.tar.gz
  • Upload date:
  • Size: 18.7 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.0.tar.gz
Algorithm Hash digest
SHA256 41699dd843e4c252379dca2b5d325de99f1a3fdef7987c03d584f2202b1ded10
MD5 7a956631bfe72d08e50bae230fe26cf7
BLAKE2b-256 614ff6b48b9c14b8adb386686958af94ed48ac2765995a77baec4995cc746bd9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: metadata_cleaner-3.7.0-py3-none-any.whl
  • Upload date:
  • Size: 24.4 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 85a35dbba5b221e45423ae2cf96bd1aa219a775490f74ffaf08fd3900f88e782
MD5 c57d959e7c14d78010093fc345913060
BLAKE2b-256 7b69693b459a164e747468e7876cdb6ef61832c81b46fcb7d90da7bb289c0842

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