LayeredImage
Use this module to read, and write to a number of layered image formats
- Compatibility
- Example Usage
- Install With PIP
- Language information
- Install Python on Windows
- Install Python on Linux
- How to run
- How to update, build and publish
- Download
- Community Files
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
- Open the .py file in vscode
- Ensure a python 3.8 interpreter is selected (Ctrl+Shift+P > Python:Select Interpreter > Python 3.8)
- 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
- 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
- Use poetry for the heavy lifting and dephell to generate requirements
poetry update dephell deps convert
- Build/ Publish
poetry build poetry publish
orpoetry publish --build
Download
Clone
Using The Command Line
- Press the Clone or download button in the top right
- Copy the URL (link)
- Open the command line and change directory to where you wish to clone to
- 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
- Press the Clone or download button in the top right
- Click open in desktop
- 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
- Download this GitHub repository
- Extract the zip archive
- 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.
1 maintainer
Metadata
1 maintainer
Release files for layeredimage 2020
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| layeredimage-2020.tar.gz | 10.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| layeredimage-2020-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 20.4 kB
Release files / layeredimage-2020.tar.gz
| Download URL | layeredimage-2020.tar.gz |
|---|---|
| Size | 10.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f34f0e69f8319b4a014650218c446e10e52cff6b2907f630a8a8fba648f3bc8c
|
|
BLAKE2b-256 checksum How to use checksums |
d541e123de50e7aeaae6663eb761c4542aa3a7eb09ae186784a64b97f4d1077f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.5 CPython/3.8.2 Windows/10
|
Release files / layeredimage-2020-py3-none-any.whl
| Download URL | layeredimage-2020-py3-none-any.whl |
|---|---|
| Size | 10.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
77df81f60bffe5189e60be0d81ee8aad748d3db1e52013f5290d4958627183fb
|
|
BLAKE2b-256 checksum How to use checksums |
8140a89bb5232ee26eec09191a5e94d4d2c72d00adb7e4c723764346512c0ae5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.5 CPython/3.8.2 Windows/10
|
