img-masker

A simple and lightweight Python tool for masking specific colors in images. Supports both local files and remote image URLs. Built on top of Pillow for image processing.

Sample Output

Original Image	Masking Sample 1	Masking Sample 2

Sample Image: Meoscarada image credit to PokeAPI.

Features

• Mask (replace) pixels of a specific color or transparency in an image.
• Supports both local image files and remote image URLs.
• Customizable mask and background colors.

Installation

You can install img-masker using pip:

pip install img-masker

Requirements

• Pillow
• requests

Usage

Basic Example

from img_masker import mask

# Mask all transparent pixels in an image with black, set background to white
masked_img = mask("https://example.com/image.png",)
masked_img.show()

Parameters

• image_url (str): Path to a local image file or a remote image URL.
• mask_color (str): Color to use for masked pixels (default: "black"). Accepts any Pillow-compatible color string, e.g., "red", "#FF0000", "transparent".
• bg_color (str): Color for non-masked pixels (default: "white").
• filter_color (str): Target color to mask (default: "transparent"). Pixels matching this color will be replaced by mask_color.

Masking a Specific Color

# Mask all pure red pixels with blue, set background to white
masked_img = mask(
    "input.jpg",
    mask_color="blue",
    bg_color="white",
    filter_color="red"
)
masked_img.show()

Masking Transparent Pixels

# Mask all transparent pixels with black, keep others white
masked_img = mask(
    "input.png",
    mask_color="black",
    bg_color="white",
    filter_color="transparent"
)
masked_img.save("masked.png")

License

This project is licensed under the MIT License. See LICENSE for details.