Skip to main content

Use this module to apply a number of blending modes to a background and foreground image

Project description

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

BlendModes

Project Icon

Use this module to apply a number of blending modes to a background and foreground image

Docs

See the Docs for more information.

Generate with pydoc-markdown 3

pydoc-markdown > DOCS.md

Alternatively use make.py to run a load of commands

Examples

Be sure to include the following for the functions below

from blendmodes.blend import blendLayers, BlendType

background = Image.open(THISDIR + "/background.png")
foreground = Image.open(THISDIR + "/foreground.png")

Normal

blendLayers(background, foreground, BlendType.NORMAL)

Normal

Multiply

blendLayers(background, foreground, BlendType.MULTIPLY)

Multiply

Additive

blendLayers(background, foreground, BlendType.ADDITIVE)

Additive

ColourBurn

blendLayers(background, foreground, BlendType.COLOURBURN)

ColourBurn

ColourDodge

blendLayers(background, foreground, BlendType.COLOURDODGE)

ColourDodge

Reflect

blendLayers(background, foreground, BlendType.REFLECT)

Reflect

Glow

blendLayers(background, foreground, BlendType.GLOW)

Glow

Overlay

blendLayers(background, foreground, BlendType.OVERLAY)

Overlay

Difference

blendLayers(background, foreground, BlendType.DIFFERENCE)

Difference

Negation

blendLayers(background, foreground, BlendType.NEGATION)

Negation

Lighten

blendLayers(background, foreground, BlendType.LIGHTEN)

Lighten

Darken

blendLayers(background, foreground, BlendType.DARKEN)

Darken

Screen

blendLayers(background, foreground, BlendType.SCREEN)

Screen

XOR

blendLayers(background, foreground, BlendType.XOR)

XOR

SoftLight

blendLayers(background, foreground, BlendType.SOFTLIGHT)

SoftLight

HardLight

blendLayers(background, foreground, BlendType.HARDLIGHT)

HardLight

GrainExtract

blendLayers(background, foreground, BlendType.GRAINEXTRACT)

GrainExtract

GrainMerge

blendLayers(background, foreground, BlendType.GRAINMERGE)

GrainMerge

Divide

blendLayers(background, foreground, BlendType.DIVIDE)

Divide

Hue

blendLayers(background, foreground, BlendType.HUE)

Hue

Saturation

blendLayers(background, foreground, BlendType.SATURATION)

Saturation

Colour

blendLayers(background, foreground, BlendType.COLOUR)

Colour

Luminosity

blendLayers(background, foreground, BlendType.LUMINOSITY)

Luminosity

Install With PIP

pip install blendmodes

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

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

How to update, build and publish

  1. Ensure you have installed the following dependencies Linux
    wget dephell.org/install | python3.8
    wget https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3.8
    
    Windows
    (wget dephell.org/install -UseBasicParsing).Content | python
    (wget https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python
    
  2. Use poetry for the heavy lifting and dephell to generate requirements
    poetry update
    dephell deps convert
    
  3. Build/ Publish
    poetry build
    poetry publish
    
    or
    poetry publish --build
    

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/FHPythonUtils/BlendModes

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.

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

blendmodes-2020.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

blendmodes-2020-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file blendmodes-2020.tar.gz.

File metadata

  • Download URL: blendmodes-2020.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.8.2 Windows/10

File hashes

Hashes for blendmodes-2020.tar.gz
Algorithm Hash digest
SHA256 4c3d3792a654669e589adf3d180779604e557d76ed2ee090ae4309a4262b1d7e
MD5 7a3de1487bae177f5fe5a6001a79583a
BLAKE2b-256 7a3e1684e27311165c20799f18f87729443d7af0c413c12d41100945562626b0

See more details on using hashes here.

File details

Details for the file blendmodes-2020-py3-none-any.whl.

File metadata

  • Download URL: blendmodes-2020-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.8.2 Windows/10

File hashes

Hashes for blendmodes-2020-py3-none-any.whl
Algorithm Hash digest
SHA256 363e1f2f87361c0b11b19549ffd82de5b7382896dabaa667d4d4d622357d49c5
MD5 9139e2bf481855a5e446917ea650aac9
BLAKE2b-256 88b93b6450b53edbda826687ddda19d9376eeac5d7b32c278dc4efaacbc90a90

See more details on using hashes here.

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