A small Python library to merge images easily
Project description
image-merger
A small Python library to merge images easily
Installation
pip install image-merger
Usage
Simple use case
from ImageMerger import Merger, ImageToMerge, MERGE_GRID
# Initialize list of images
list_images = [
ImageToMerge(path='images/samples/1.png'),
ImageToMerge(path='images/samples/2.png'),
ImageToMerge(path='images/samples/3.png'),
ImageToMerge(path='images/samples/4.png')
]
# Load merger with different settings
m = Merger(list_images=list_images)
# Save merged image
m.save_image(filename="images/results/output_4_grid.png")
Parameters
limit_horizontal: int
: Optional int to define the maximum number of images to append horizontallylimit_vertical: int
: Optional int to define the maximum number of images to append verticallysuffle: bool
: Optional boolean to decide iflist_images
must be shuffled prior to process. DefaultFalse
merge_strategy: int
: Optional int to set the merging strategy. EitherMERGE_HORIZONTALLY
, -MERGE_VERTICALLY
orMERGE_GRID
(default)preserve_aspect_ratio: bool
: Optional boolean that defines if proportion of each image should be kept or if image can be squeezed/extended to fit. DefaultFalse
- Setting it to
True
can lead to images being distored to fit layout but there will be no gaps. - Setting it to
False
will kept each image aspect ratio but can lead to black gaps in output image.
- Setting it to
Configuration examples
ImageToMerge.path
can either be a path(local or relative) or HTTP(S) URLlimit_horizontal
andlimit_vertical
are optional and can also be used at the same time- If
limit_horizontal
andlimit_vertical
are not set, andmerge_strategy
is set toMERGE_GRID
The process will try to fit as best as possible all images in a square grid. - List of images can be shuffled randomly using
shuffle=True
parameter
More examples
from ImageMerger import Merger, ImageToMerge
# Initialize list of images
list_images = [
ImageToMerge(path='images/samples/1.png'),
ImageToMerge(path='images/samples/2.png'),
ImageToMerge(path='https://raw.githubusercontent.com/ggouzi/image-merger/main/images/samples/3.png'),
ImageToMerge(path='https://raw.githubusercontent.com/ggouzi/image-merger/main/images/samples/4.png'),
ImageToMerge(path='https://raw.githubusercontent.com/ggouzi/image-merger/main/images/samples/5.png')
]
# Load merger with different settings
m = Merger(
list_images=list_images,
preserve_aspect_ratio=True,
limit_vertical=2
)
# Save merged image
m.save_image(filename="images/results/output_5_grid_keep_aspect_ratio.png")
from ImageMerger import Merger, ImageToMerge
# Initialize list of images
list_images = [ImageToMerge(path=f"images/samples/{i}.png") for i in range(1, 11)]
# Load merger with different settings
m = Merger(
list_images=list_images,
limit_horizontal=2
)
# Save merged image
m.save_image(filename="images/results/output_10_2rows.png")
from ImageMerger import Merger, ImageToMerge
# Initialize list of images
list_images = [ImageToMerge(path=f"images/samples/{i}.png") for i in range(1, 11)]
# Load merger with different settings
m = Merger(
list_images=list_images,
shuffle=True
)
# Save merged image
m.save_image(filename="images/results/output_10_grid_shuffled.png")
References
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
image-merger-0.2.tar.gz
(7.3 kB
view details)
Built Distribution
File details
Details for the file image-merger-0.2.tar.gz
.
File metadata
- Download URL: image-merger-0.2.tar.gz
- Upload date:
- Size: 7.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04b2f6dc2ed139356ae609bc5f9258a512c4aaa3e9fff00709b06f4b67162032 |
|
MD5 | ac6957eb62cc5b17f99fec89c1a8d61e |
|
BLAKE2b-256 | a588bb36288d5d0eebad39a608ecbcea8f7b99a993ac89144dca08867a5051db |
File details
Details for the file image_merger-0.2-py3-none-any.whl
.
File metadata
- Download URL: image_merger-0.2-py3-none-any.whl
- Upload date:
- Size: 10.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25d7b7b5fdd140c62c328ed0ce0008c187d75eb8ed81443557c454711c4d4819 |
|
MD5 | 9c1a63eda9f9dfd1b812c8d1e9a7d1ab |
|
BLAKE2b-256 | 489f12d25e894aeed4afbdf04761361d3f85dd8f9f9be8fca16d3fadb9d9c408 |