imgrs

📖 imgrs Documentation

Welcome to imgrs - A blazing fast image processing library for Python, powered by Rust! 🚀

🎯 What is imgrs?

imgrs provides a Pillow-compatible API with Rust performance:

⚡ 10-100x faster than pure Python
🔒 Memory safe with Rust’s guarantees
🎨 Easy to use - familiar Pillow-like interface
🌍 Cross-platform - works on Linux, Windows, macOS, Android

📚 Documentation Structure

For Beginners

Quick Start - Get started in 5 minutes
Installation - How to install
Basic Usage - Common operations
Examples - Ready-to-use code examples

API Reference

Image Class - Core Image class
Constructors - Creating images
Filters - Image filters
Drawing - Drawing operations
Pixels - Pixel manipulation
Effects - Shadow and glow effects

Type Reference

Types & Enums - All types and enums
Color Types - Color specifications
Image Modes - Image mode details

Advanced Topics

Performance Guide - Optimization tips
Migration from Pillow - Switching guide
Contributing - How to contribute

🚀 Quick Example

from imgrs import Image

# Open and resize an image
img = Image.open("photo.jpg")
resized = img.resize((800, 600))
resized.save("resized.jpg")

# Apply filters
blurred = img.blur(5.0)
sharp = img.sharpen(2.0)

# Draw on image
img.draw_rectangle(10, 10, 100, 50, (255, 0, 0, 255))
img.save("output.png")

Choose your path:

🆕 New to imgrs? Start with Quick Start
🔍 Looking for something? Check API Reference
💡 Need examples? Browse Examples
🎓 Coming from Pillow? See Migration Guide

🆘 Getting Help

📝 Documentation: You’re here!
🐛 Bug Reports: GitHub Issues
💬 Discussions: GitHub Discussions
📧 Email: your-email@example.com

📄 License

This project is licensed under the IRADL License.

Happy image processing! 🎨✨

This site is open source. Improve this page.