imgif 0.2.1

🎬 A playful Python library for converting image sequences into animated GIFs

✨ A playful Python library for converting image sequences into animated GIFs with ease!

Turn your image sequences into delightful animated GIFs with just a few lines of code. Whether you're creating animations from screenshots, visualizing data, or just having fun, imgif makes it simple and enjoyable! 🚀

🌟 Features

• 🎨 Simple API - Convert images to GIF in just 3 lines of code
• ⚡ Fast & Efficient - Built on Pillow for optimal performance
• 🎛️ Highly Configurable - Control duration, quality, size, and more
• 💻 CLI Interface - Use directly from the command line
• 📝 Fully Typed - Complete type annotations for great IDE support
• 🧪 100% Test Coverage - Reliable and well-tested
• 🎭 Rich Output - Beautiful progress indicators and error messages

📦 Installation

# Using pip
pip install imgif

# Using uv (recommended for development)
uv pip install imgif

🚀 Quick Start

Python API

from img2gif import ImageToGifConverter

# Create converter
converter = ImageToGifConverter()

# Convert images to GIF
converter.convert(
    input_dir="./my_images",
    output_path="./output.gif",
    duration=0.5,  # seconds per frame
)

print("🎉 GIF created successfully!")

Command Line

# Basic usage
imgif ./my_images output.gif

# With options
imgif ./my_images output.gif --duration 0.5 --loop 0

# See all options
imgif --help

📖 Documentation

Full documentation is available at imgif.readthedocs.io (coming soon!)

🛠️ Development

Setup

# Clone the repository
git clone https://github.com/atick-faisal/img2gif.git
cd img2gif

# Install dependencies using uv
uv sync

# Install pre-commit hooks
pre-commit install

Running Tests

# Run tests on default Python version
hatch run test:all

# Run tests on all supported Python versions
hatch run test:all

# Run with coverage
hatch run test:cov

Linting & Formatting

# Check code
ruff check .

# Format code
ruff format .

🤝 Contributing

Contributions are welcome! Please check out our Contributing Guide for details.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Built with Pillow 📸
• CLI powered by click 🖱️
• Beautiful output by rich 💎

---

Made with ❤️ and Python 🐍