Skip to main content

A Python CLI-Tool and package to pixelate or blur faces in images and videos.

Project description

Welcome to PixelateMe 👋
Your python package to anonymize faces in images and videos

License: MIT

With this CLI tool you can pixelate, blur or remove faces from videos and images. GPU acceleration supported.

⚡️ Quickstart

📥 Install

pip install pixelateme

▶️ Run

After installation, pip registers a shortcut binary which can be called (on windows for example) like this:

pixelateme --mode blur FOLDER_OR_FILES

This will create a new pixelated folder, where all the pixelated files are stored.

🎯 Features

  • Different anonymization modes: pixelate, blur and color
  • GPU acceleration
  • Preview of current processed files
  • Face Recognition to only blur specific faces or to blur all faces except specific ones
  • ONNXRT and OpenCV runtime backend

💻 CLI Arguments

  • --suffix: Filename suffix of processed files. Default:
  • --output (-o): Output directory for processed files. Default: ./pixelated
  • --mode (-m): Mode of anonymization. Default: pixelate
  • --threshold (-t): Threshold for detected faces (higher means more confidence). Default: 0.5
  • --backend: Desired backend (e.g. opencv or onnxrt). Auto prefers onnxrt and falls back to opencv. Default: auto
  • --only-blur-this-faces: Folder containing images of faces (one face per image), which should be considered for anonymization. All other faces won't be anonymized. Default: None
  • --blur-except-this-faces: Folder containing images of faces (one face per image), which should be ignored for anonymization. Default: None
  • --ellipse: Uses ellipses as form for anonymization. Default is rectangle
  • --blur-strength: Defines how "blurry" a face will be. Only working with --mode "blur". Default: 3
  • --pixelate-size: Size of pixelation effect. The higher the value, the harder it is to recognize the face. Default: 16
  • --deepface-similarity: Maximum similarity between two faces. Higher value means, that more faces are considered as equal. Only working in combination with --blur-except-this-faces or --only-blur-this-faces. Default: 0.4
  • --preview: Enable preview of the currently processed image. No preview is default
  • --face-recognition-size: Image size to use for face recognition. Format: WxH (e.g. 720x480). Default: None
  • --maximum-face-recognition-size: Maximum number of pixels of the longest side for face recognition. Images larger than this will be downscaled for face recognition. This doesn't affect output resolution. Default: 640

👥 Author

👤 Marius Butz

⭐️ Show your support

  • Give a ⭐️ star if this project helped you!
  • Create a 🍴 fork and contribute by fixing bugs or adding features

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

PixelateMe-0.2.0.tar.gz (7.0 MB view details)

Uploaded Source

Built Distribution

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

PixelateMe-0.2.0-py3-none-any.whl (7.0 MB view details)

Uploaded Python 3

File details

Details for the file PixelateMe-0.2.0.tar.gz.

File metadata

  • Download URL: PixelateMe-0.2.0.tar.gz
  • Upload date:
  • Size: 7.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for PixelateMe-0.2.0.tar.gz
Algorithm Hash digest
SHA256 68074aa98818ad5b4634e5985b4f647869e7fbc628a88276642f7701a648c69c
MD5 de2b1b44879779ccd443a65caa8eba07
BLAKE2b-256 cf7d732feda2b8ed5f6b9c783c4b0f3a0c137388ee0c93a9b76dc8667fcb065a

See more details on using hashes here.

File details

Details for the file PixelateMe-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: PixelateMe-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for PixelateMe-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f0e2015ff4427e2bb98d15582647f1ef5909009dea33f41be4442d4bb59f20c8
MD5 b2ae62cf48f1120c04ec730f3bb70760
BLAKE2b-256 bcc5c003a01b0a51d218275521643b3f107cfacc59bad2c9570b9790c17a1b62

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