Neonize Documentation¶

🚀 Neonize

WhatsApp Automation Made Simple for Python

What is Neonize?¶

Neonize is a powerful Python library that transforms WhatsApp automation from complex to simple. Built on top of the robust Whatsmeow Go library, it delivers enterprise-grade performance with Python's ease of use and developer-friendly API.

✨ Key Features¶

Core Messaging¶

✅ Send and receive text messages
✅ Handle media files (images, videos, documents, audio)
✅ Group management and operations
✅ Real-time message events
✅ Message receipts and status tracking

Advanced Capabilities¶

🔐 End-to-end encryption support
🎯 Contact and user information retrieval
📞 Call event handling
🔔 Presence and typing indicators
📊 Polls and interactive messages
🚫 Blocklist management
📢 Newsletter/Channel support

Developer Experience¶

🔄 Event-driven architecture
📊 Built-in logging and debugging
🗄️ SQLite and PostgreSQL database support
⚡ Both synchronous and asynchronous APIs
🧪 Comprehensive examples and documentation

Why Choose Neonize?¶

Feature	Description
🔥 High Performance	Built with Go backend for maximum speed and efficiency
🐍 Python Native	Seamless integration with your existing Python ecosystem
🛡️ Enterprise Ready	Production-tested with robust error handling and reliability
⚡ Real-time	Handle messages, media, and events in real-time with async support
🔧 Easy Integration	Simple, intuitive API design for rapid development
📚 Well Documented	Comprehensive documentation with practical examples

Quick Example¶

Python
from neonize.client import NewClient
from neonize.events import MessageEv, ConnectedEv, event

# Initialize client
client = NewClient("my_bot")

@client.event(ConnectedEv)
def on_connected(client: NewClient, event: ConnectedEv):
    print("🎉 Bot connected successfully!")

@client.event(MessageEv)
def on_message(client: NewClient, event: MessageEv):
    if event.message.conversation == "hi":
        client.reply_message("Hello! 👋", event.message)

# Start the bot
client.connect()
event.wait()

What's Next?¶

Getting Started

Install Neonize and create your first WhatsApp bot in minutes

Quick Start
User Guide

Learn how to use Neonize features with detailed guides and examples

User Guide
API Reference

Explore the complete API documentation with all available methods

API Reference
Examples

Browse practical examples for common use cases

Examples

Community and Support¶

📧 Issues: GitHub Issues
💬 Discussions: GitHub Discussions
🌟 Star us on GitHub: Show your support by starring the repository

License¶

Neonize is licensed under the Apache License 2.0. See the LICENSE file for details.

Made with ❤️ for the Python community

If this project helps you, please consider giving it a ⭐ on GitHub!