Skip to main content

Use this module to read, and write to a number of layered image formats

Project description

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

LayeredImage

Project Icon

Use this module to read, and write to a number of layered image formats

Compatibility

Bear in mind that the tables below may not be completely accurate. If that is the case, please open an issue and I will fix the tables.

Overview

Format .ora .pdn .xcf .psd
Read
Layers
Groups N/A
Write

Group

Format .ora .pdn .xcf .psd
Name
Dimensions
Offsets N/A
Opacity
Visibility

Layer

Format .ora .pdn .xcf .psd
Name
Dimensions
Offsets N/A
Opacity
Visibility

Example Usage

Here's some basic example usage below.

"""Example module """
from pathlib import Path
THISDIR = str(Path(__file__).resolve().parent)
import layeredimage.io

# Do stuff
ora = layeredimage.io.openLayerImage(THISDIR + "/image.ora")

imageDimensions = ora.dimensions
# There are a load of handy functions for getting layers, and adding new
# layers, but here we will act directly on the object
layer = ora.layersAndGroups[0] # For the sake of the e.g. this is a layer

# Lets overwrite the layer with a transparent image (bit boring I know...)
layer.image = Image.new("RGBA", imageDimensions)

# And let's save
layeredimage.io.saveLayerImage(THISDIR + "/image(modified).ora", ora)

# Let's save a flattened version too
ora.getFlattenLayers().save(THISDIR + "/image(modified).png")

# Doing stuff with a group
group = ora.getLayerOrGroup(1) # For the sake of the e.g. this is a group
group.layers[0].image.show() # Open the image of the first layer of the group

# Deleting a layer/ group
ora.removeLayerOrGroup(2)

Images are PIL.Image (s) and so you can use the power of Pillow to apply filters, and other modifications to the images.

And for those who would rather not read the test file, here are the tests. Not going to get 100% coverage anytime soon but hopefully this will help a little.

"""Test module """

import sys
import os
from pathlib import Path
THISDIR = str(Path(__file__).resolve().parent)
sys.path.insert(0, os.path.dirname(THISDIR))
import layeredimage.io

# Read various formats and output ora
ora = layeredimage.io.openLayerImage(THISDIR + "/base24.ora")
psd = layeredimage.io.openLayerImage(THISDIR + "/base24.psd")
pdn = layeredimage.io.openLayerImage(THISDIR + "/base24.pdn")
xcf = layeredimage.io.openLayerImage(THISDIR + "/base24.xcf")

layeredimage.io.saveLayerImage(THISDIR + "/base24(ora).ora", ora)
layeredimage.io.saveLayerImage(THISDIR + "/base24(psd).ora", psd)
layeredimage.io.saveLayerImage(THISDIR + "/base24(pdn).ora", pdn)
layeredimage.io.saveLayerImage(THISDIR + "/base24(xcf).ora", xcf)

# Output flattened images
ora.getFlattenLayers().save(THISDIR + "/base24(ora).png")
psd.getFlattenLayers().save(THISDIR + "/base24(psd).png")
pdn.getFlattenLayers().save(THISDIR + "/base24(pdn).png")
xcf.getFlattenLayers().save(THISDIR + "/base24(xcf).png")

Install With PIP

pip install layeredimage

Head to https://pypi.org/project/layeredimage/ 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/LayeredImage

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

layeredimage-2020.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

layeredimage-2020-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for layeredimage-2020.tar.gz
Algorithm Hash digest
SHA256 f34f0e69f8319b4a014650218c446e10e52cff6b2907f630a8a8fba648f3bc8c
MD5 fbab13949f9d1efcbcb9450b7a965c14
BLAKE2b-256 d541e123de50e7aeaae6663eb761c4542aa3a7eb09ae186784a64b97f4d1077f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: layeredimage-2020-py3-none-any.whl
  • Upload date:
  • Size: 10.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 layeredimage-2020-py3-none-any.whl
Algorithm Hash digest
SHA256 77df81f60bffe5189e60be0d81ee8aad748d3db1e52013f5290d4958627183fb
MD5 aa04d28d65dcb2bf0ee26e30edc33a95
BLAKE2b-256 8140a89bb5232ee26eec09191a5e94d4d2c72d00adb7e4c723764346512c0ae5

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