Skip to content

User Guide

Welcome to the comprehensive Neonize user guide. This section covers all the features and capabilities of Neonize in detail.

What You'll Learn

This guide is organized into the following sections:

Core Functionality

Media and Content

WhatsApp Features

Quick Navigation

Prerequisites

Before diving into this guide, make sure you have:

Code Examples

Throughout this guide, you'll find practical code examples. All examples assume you have a basic client setup:

Python
1
2
3
4
5
6
from neonize.client import NewClient
from neonize.events import event

client = NewClient("my_bot")
client.connect()
event.wait()

For async examples:

Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
import asyncio
from neonize.aioze.client import NewAClient

client = NewAClient("async_bot")

# register event handlers on client.event here...

async def main():
    await client.connect()  # captures the running event loop
    await client.idle()     # keeps the bot alive

asyncio.run(main())  # ✅ standard entry point

Best Practices

Throughout this guide, we'll highlight best practices with special callouts:

Performance Tip

Use async clients for high-throughput applications

Important

Be aware of WhatsApp rate limits to avoid temporary bans

Information

Additional context and helpful information

Example

Practical code examples demonstrating concepts

Getting Help

If you need help while following this guide:

  • 📚 Check the API Reference for detailed method documentation
  • 💡 Browse Examples for complete working code
  • ❓ Visit the FAQ for common questions
  • 🐛 Report issues on GitHub

Next Steps

Ready to dive in? Start with:

  1. Client Configuration - Set up your client properly
  2. Event System - Understand event handling
  3. Sending Messages - Start sending messages

Let's get started! 🚀