censor-this

censor-this is a Python command line tool that allows you to censor words in an image.

Installation

Install Tesseract https://github.com/tesseract-ocr/tessdoc/blob/main/Installation.md#introduction

pip install censor-this

Commands

add

censor-this add [word]

Adds a "censor word".

Args

• word - The "censor word" that will be added.
  [required]

remove

censor-this remove [word]

Removes a censor word.

Args

• word - The censor word that will be removed.
  [required]

clear

censor-this clear

Removes all censor words.

censor-words

censor-this censor-words

Prints all censor words.

image

censor-this image [path]

Censors all censor words from an image or directory of images with blur, then outputs the results to ./censor-this-output.

Args

• path - The path to the image/directory.
  [example: this/is/the/path/to/the/image.png] [required]
  
• --censor-all | --all | -a - Censor all words in an image.
  [example: --censor-all]
  
• --min-conf | --conf | -m - The minimum confidence that will be required for a word to be censored.
  [example: --min-conf=40.0] [default: 90.0] FLOAT
  
• --bar-color | --color | -c - The color the censor bar will be. When not present censor bar will default to blur. Must be in hex format.
  [example: --bar-color=#FFA200 ] [default: None] TEXT

Example

1. Add words that you want to censor.

censor-this add best # adding best to censor words
censor-this add worst # adding worst to censor words
censor-this add age # adding age to censor words
censor-this add foolishness # adding foolishness to censor words

2. Censor the words in the image.

censor-this image ./imgs/example.png --bar-color=#FFA200

3. Retrieve output from ./censor-this-output.