transimage is a Python package and CLI tool for converting images between different formats and creating GIFs from image sequences, directories, or video files. It uses Pillow for image operations and OpenCV for video frame extraction.
send your PR based god🙏🏻
- Convert images between JPG, PNG, BMP, and WebP formats
- Batch conversion of multiple images or entire directories
- Create GIFs from a list of images, a directory of images, or a video file
- Configurable GIF parameters: FPS, size, crop, loop, and video trim
- Preserves aspect ratio on resize and handles transparency
- Simple command-line interface with subcommands
- Skips conversion if the input and output formats are the same
- Pillow >= 11.0.0
- Poetry
Optional dependency for creating GIFs:
- opencv-python-headless
- Clone the repository
- Install Poetry:
pip install poetryorpipx install poetry - Install all dependencies:
poetry install - (Optional) For video support:
poetry install --extras opencv
All commands are run from the project root using Poetry’s virtual environment. Replace poetry run python -m transimage with transimage if you installed the package globally.
Convert a single image or all images in a directory:
poetry run python -m transimage convert <input_path> <output_path> <output_format>
<input_path>: Path to a single image file or a directory of images<output_path>: Directory where converted images will be saved (do not include file name)<output_format>: Target format (jpg, png, bmp, webp)
poetry run python -m transimage convert ./photo.jpg ./output png
poetry run python -m transimage convert ./images/ ./converted webp
Create a GIF from images or video:
poetry run python -m transimage gif <input> -o <output.gif> [options]
<input>: A directory path, a video file path, or a list of image file paths (list them after the command)-o, --output: Output GIF file path (required)
| Option | Type | Default | Description |
|---|---|---|---|
--fps |
float | 24 | Frames per second |
--size |
int int | - | Max width and height (aspect ratio preserved) |
--crop |
int int int int | - | Crop box: left top right bottom |
--loop |
int | 0 | Loop count (0 = infinite) |
--start-time |
float | - | Start time in seconds (video only) |
--end-time |
float | - | End time in seconds (video only) |
--skip-frames |
int | 1 | Only use every Nth frame (video only) |
From a directory of images (sorted by name):
poetry run python -m transimage gif ./frames -o movie.gif --fps 12 --size 640 480
From a list of explicit image files:
poetry run python -m transimage gif a.jpg b.jpg c.jpg -o combined.gif --fps 2 --loop 0
From a video file (requires the opencv extra):
poetry run python -m transimage gif video.mp4 -o clip.gif --fps 15 --start-time 2.5 --end-time 5 --size 320 240
To preserve real-time speed from a video, adjust --skip-frames so that fps / skip_frames roughly equals the original video’s frame rate. For a 30 fps video, --fps 18 --skip-frames 2 gives a natural-looking GIF.
Inside a script or interactive session, you can use the package directly after installing it in your environment.
Import the needed functions:
from transimage import ImageConverter, convert_image, collect_images, GIFCreator, create_gif
converter = ImageConverter('input.jpg', 'output.png', 'png')
converter.convert()
Batch conversion:
import os
from transimage import collect_images, convert_image
input_dir = 'images/'
output_dir = 'converted/'
fmt = 'png'
for img_path in collect_images(input_dir):
name = os.path.splitext(os.path.basename(img_path))[0]
out_path = os.path.join(output_dir, f"{name}.{fmt}")
convert_image(img_path, out_path, fmt)
Using the convenience function:
create_gif(
input=['a.jpg', 'b.jpg', 'c.jpg'], # or a directory path, or a video file path
output='animation.gif',
fps=10,
size=(320, 240),
loop=0
)
Or with the class for more control:
creator = GIFCreator(
sources='video.mp4',
output_path='clip.gif',
fps=15,
size=(480, 360),
start_time=2.0,
end_time=5.0,
skip_frames=2
)
creator.create()
This project is licensed under the MIT License. See the LICENSE file for details.
Please submit issues regarding any oversight you see. Pull requests for improvements are welcome.
- Install the developer dependencies: poetry install (dev deps are included by default)
- Add your changes
- Test your code: poetry run pytest tests/
- Format and lint:
- Format: poetry run black src/transimage tests
- Lint: poetry run flake8 src/transimage tests
- Run all together: poetry run black src/transimage tests && poetry run flake8 src/transimage tests && poetry run pytest tests
- Rise and repeat until finished.
2.0.0