Skip to main content

Create various icon masks and shading effects with the imageedit library

Project description

Github top language Codacy grade Codacy coverage Repository size Issues License Commit activity Last commit PyPI Downloads PyPI Version

ImageEdit

Project Icon

Now available on pypi.org!

Create various icon masks and shading effects with the imageedit library. Six example files under main: round.py, makeProjIcons.py, makePWAImages.py, makeRetro.py, getPWAScreenshots.py and readWriteLayered.py.

Leverages the following libraries to do the heavy lifting:

pillow
layeredimage
svgtrace
blendmodes

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

Documentation

See the DOCS for more information.

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

Example Files

  • getPWAScreenshots.py
  • makeProjIcons.py
  • makePWAImages.py
  • makeRetro.py
  • readWriteLayered.py
  • round.py

Comparison to similar solutions

Similar solutions include but are not limited to:

GUI

https://www.getpaint.net/

Web

https://realfavicongenerator.net/

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 imageTracerJs.py (https://github.com/jankovicsandras/imagetracerjs) is pretty good (requires pyppeteer: https://github.com/miyakogi/pyppeteer)

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

makePWAImages

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

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

    LightFox LightFox LightFox LightFox LightFox

makeRetro

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

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

    BlendModes BlendModes BlendModes BlendModes

    Mobile Operating Systems

    iOS

    BlendModes BlendModes

    Android

    BlendModes BlendModes BlendModes BlendModes

Install With PIP

pip install imageedit

Head to https://pypi.org/project/imageedit/ for more info

See python files under main for example usage

Language information

Built for

This program has been written for Python 3 and has been tested with Python version 3.8.0 https://www.python.org/downloads/release/python-380/.

Install Python on Windows

Chocolatey

choco install python

Download

To install Python, go to https://www.python.org/ and download the latest version.

Install Python on Linux

Apt

sudo apt install python3.8

How to run

With VSCode

  1. Open the .py file in vscode
  2. Ensure a python 3.8 interpreter is selected (Ctrl+Shift+P > Python:Select Interpreter > Python 3.8)
  3. Run by pressing Ctrl+F5 (if you are prompted to install any modules, accept)

From the Terminal

./[file].py

Download

Clone

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 https://github.com/[user-name]/[repository]

More information can be found at https://help.github.com/en/articles/cloning-a-repository

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 https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

Download Zip File

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

Community Files

Licence

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

Changelog

See the Changelog for more information.

Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone. Please see the Code of Conduct for more information.

Contributing

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

Security

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

Screenshots

Desktop

Screenshot 1 Screenshot 2 Screenshot 3

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-2020.5.tar.gz (151.3 kB view hashes)

Uploaded Source

Built Distribution

imageedit-2020.5-py3-none-any.whl (149.9 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