Installation¶

This guide will walk you through the process of installing Neonize on your system.

System Requirements¶

Python Version¶

Neonize requires Python 3.10 or higher. You can check your Python version by running:

Bash
1	`python --version`

If you need to upgrade Python, visit python.org.

Installation Methods¶

Using pip (Recommended)¶

The simplest way to install Neonize is using pip:

Bash
1	`pip install neonize`

Using uv¶

If you're using the modern uv package manager:

Bash
1	`uv add neonize`

Using Poetry¶

For projects managed with Poetry:

Bash
1	`poetry add neonize`

Development Installation¶

To install Neonize with development dependencies:

Bash
# Clone the repository
git clone https://github.com/krypton-byte/neonize.git
cd neonize

# Install with development dependencies
pip install -e ".[dev]"

Verifying Installation¶

After installation, verify that Neonize is correctly installed:

Python
import neonize
print(neonize.__version__)

This should print the installed version of Neonize without any errors.

Optional Dependencies¶

FFmpeg (For Media Processing)¶

Neonize uses FFmpeg for video and audio processing. Install it based on your operating system:

Ubuntu/DebianmacOSWindows

Bash
sudo apt update
sudo apt install ffmpeg

Bash
1	`brew install ffmpeg`

Download from ffmpeg.org and add to PATH

Database Drivers¶

PostgreSQL Support¶

If you plan to use PostgreSQL as your database:

Bash
1	`pip install psycopg2-binary`

Or for production environments:

Bash
1	`pip install psycopg2`

Platform-Specific Notes¶

Linux¶

On Linux systems, you may need to install additional system libraries:

Bash
# Ubuntu/Debian
sudo apt install libmagic1

# Fedora/RHEL
sudo dnf install file-libs

Windows¶

On Windows, Neonize automatically installs python-magic-bin which includes the necessary libraries.

macOS¶

On macOS, you may need to install libmagic:

Bash
1	`brew install libmagic`

Troubleshooting¶

Common Installation Issues¶

Issue: `ModuleNotFoundError: No module named 'neonize'`¶

Solution: Ensure you've activated the correct Python environment and that the installation completed successfully.

Bash
pip list | grep neonize

Issue: FFmpeg not found¶

Solution: Make sure FFmpeg is installed and available in your system PATH.

Bash
1	`ffmpeg -version`

Issue: Permission denied during installation¶

Solution: Use a virtual environment or install with the --user flag:

Bash
pip install --user neonize

Getting Help¶

If you encounter issues not covered here:

Check the FAQ section
Search GitHub Issues
Open a new issue with detailed information about your problem

Next Steps¶

Now that you have Neonize installed, proceed to:

Quick Start Guide - Create your first bot
Authentication - Learn about WhatsApp authentication
User Guide - Explore Neonize features

Installation Complete

You're now ready to build amazing WhatsApp bots with Neonize! 🎉