Installation Guide

Quick Install

Basic Installation

pip install vayuapi

With All Features

pip install vayuapi[all]

System Requirements

  • Python 3.12 or higher
  • pip package manager
  • 2GB RAM minimum (4GB recommended)
  • Internet connection for pip installation

Platform-Specific Instructions

Windows

Prerequisites

  1. Download and install Python from python.org
  2. Make sure to check "Add Python to PATH" during installation
  3. Install Visual C++ Build Tools (for some dependencies)

Installation

python -m pip install --upgrade pip
pip install vayuapi[all]

Linux (Ubuntu/Debian)

sudo apt update
sudo apt install python3.12 python3.12-venv python3-pip
python3.12 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install vayuapi[all]

macOS

brew install python@3.12
python3.12 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install vayuapi[all]

Installation Options

Django ORM Support

pip install vayuapi[django]

Async ORM (Tortoise)

pip install vayuapi[orm]

AI/ML Features

pip install vayuapi[ai,rag]

Security Features

pip install vayuapi[security]

Task Scheduling

pip install vayuapi[scheduler]

Vector Databases

pip install vayuapi[vector]

Using Virtual Environments

venv (Recommended)

# Create virtual environment
python -m venv venv

# Activate on Linux/macOS
source venv/bin/activate

# Activate on Windows
venv\Scripts\activate

# Install VayuAPI
pip install vayuapi[all]

conda

conda create -n vayuapi python=3.12
conda activate vayuapi
pip install vayuapi[all]

pipenv

pipenv --python 3.12
pipenv install vayuapi[all]
pipenv shell

Docker Installation

docker run -it python:3.12
pip install vayuapi[all]

Verification

Verify your installation by creating a test file:

from vayuapi import VayuAPI

app = VayuAPI()

@app.get("/")
async def home():
    return {"status": "VayuAPI installed successfully!"}

if __name__ == "__main__":
    app.run()

Run the test:

python test.py

Visit http://localhost:8000 to see the response.

Troubleshooting

pip not found

python -m pip install vayuapi

Permission Denied

pip install --user vayuapi
# or use virtual environment (recommended)

Dependency Conflicts

pip install --upgrade vayuapi
# Check dependencies
pip show vayuapi

Python Version Mismatch

python --version
python3.12 -m pip install vayuapi

SSL/Certificate Errors

pip install --trusted-host pypi.org --trusted-host files.pythonhosted.org vayuapi

Memory Issues During Installation

pip install --no-cache-dir vayuapi

Network Issues

pip install -i https://mirrors.aliyun.com/pypi/simple/ vayuapi

Post-Installation Verification

# Check installed version
pip show vayuapi

# Import test
python -c "from vayuapi import VayuAPI; print('✓ Import successful')"

# Feature test
python -c "from vayuapi.security import JWTHandler; print('✓ Security features available')"

Next Steps