Skip to main content

Create various icon masks and shading effects with the imageedit library

Project description

GitHub top language Repository size Issues License Commit activity Last commit PyPI Downloads PyPI Total Downloads PyPI Version


Project Icon

Now available on!

Create various icon masks and shading effects with the imageedit library. Six example files under main:,,,, and

Leverages the following libraries to do the heavy lifting:


Have a look under test/test_read_write_layered for an example of converting an xcf to ora and png. Unfortunately, visibility of xcf is currently ignored :(

See the documentation for each library for more information on things you can use it for.

Example Files


Comparison to similar solutions

Similar solutions include but are not limited to:



Advantages of this solution

  • Lightweight: few dependencies required (python, pillow, blendmodes, layeredimage, and svgtrace)
  • Quick: when given a regular or mask image it can produce many variants in a relatively short amount of time
  • Customizable: write your own scripts to leverage imageEdit (python knowledge required)
  • Produce a PWA mask icon out of the box
  • SVG tracing lib doesn't require potrace/ pypotrace which can be challenging to set up on Windows
  • SVG tracing using (

Disadvantages of this solution

  • Specific image dimensions needed out of the box: whilst this is something that could be changed, maskable icons are 640x640 and regular icons are 512x512

How to use out of the box

  1. Put regular 512x512 image or mask 640x640 image under main/input in this example I am using lightfox.png

  2. Run and navigate to main/output/lightfox.png/pwa

    LightFox LightFox LightFox LightFox LightFox

  1. Put regular 512x512 image or mask 640x640 image under main/input. In this example I am using BlendModes.png

  2. Run and navigate to main/output/blendmodes.png/retro Personal Computers

    BlendModes BlendModes BlendModes BlendModes

    Mobile Operating Systems


    BlendModes BlendModes


    BlendModes BlendModes BlendModes BlendModes


A high-level overview of how the documentation is organized organized will help you know where to look for certain things:

  • The Technical Reference documents APIs and other aspects of the machinery. This documentation describes how to use the classes and functions at a lower level and assume that you have a good high-level understanding of the software.

Install With PIP

pip install imageedit

Head to for more info

Language information

Built for

This program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and 3.11

Install Python on Windows


choco install python

Windows -

To install Python, go to and download the latest version.

Install Python on Linux


sudo apt install python3.x


sudo dnf install python3.x

Install Python on MacOS


brew install python@3.x

MacOS -

To install Python, go to and download the latest version.

How to run


  • Module py -3.x -m [module] or [module] (if module installs a script)

  • File py -3.x [file] or ./[file]

Linux/ MacOS

  • Module python3.x -m [module] or [module] (if module installs a script)

  • File python3.x [file] or ./[file]


This project uses to automate most of the building. This command generates the documentation, updates the requirements.txt and builds the library artefacts

Note the functionality provided by fhmake can be approximated by the following

handsdown  --cleanup -o documentation/reference
poetry export -f requirements.txt --output requirements.txt
poetry export -f requirements.txt --with dev --output requirements_optional.txt
poetry build

fhmake audit can be run to perform additional checks


For testing with the version of python used by poetry use

poetry run pytest

Alternatively use tox to run tests over python 3.8 - 3.11


Download Project


Using The Command Line

  1. Press the Clone or download button in the top right
  2. Copy the URL (link)
  3. Open the command line and change directory to where you wish to clone to
  4. Type 'git clone' followed by URL in step 2
    git clone

More information can be found at

Using GitHub Desktop

  1. Press the Clone or download button in the top right
  2. Click open in desktop
  3. Choose the path for where you want and click Clone

More information can be found at

Download Zip File

  1. Download this GitHub repository
  2. Extract the zip archive
  3. Copy/ move to the desired location

Community Files


MIT License Copyright (c) FredHappyface (See the LICENSE for more information.)


See the Changelog for more information.

Code of Conduct

Online communities include people from many backgrounds. The Project contributors are committed to providing a friendly, safe and welcoming environment for all. Please see the Code of Conduct for more information.


Contributions are welcome, please see the Contributing Guidelines for more information.


Thank you for improving the security of the project, please see the Security Policy for more information.


Thank you for using this project, I hope it is of use to you. Please be aware that those involved with the project often do so for fun along with other commitments (such as work, family, etc). Please see the Support Policy for more information.


The rationale acts as a guide to various processes regarding projects such as the versioning scheme and the programming styles used. Please see the Rationale for more information.

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

imageedit-2023.tar.gz (152.1 kB view hashes)

Uploaded Source

Built Distribution

imageedit-2023-py3-none-any.whl (150.6 kB view hashes)

Uploaded Python 3

Supported by

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