Installation

Requirements

Python ≥ 3.14
A supported async database driver (see below)

Installing OpenViper

Install from PyPI using pip:

pip install openviper

Database URL Format

OpenViper uses SQLAlchemy Core connection strings. Set DATABASE_URL in your settings.py:

Backend	DATABASE_URL example
SQLite (dev)	`sqlite+aiosqlite:///./db.sqlite3`
PostgreSQL	`postgresql+asyncpg://user:pass@localhost:5432/mydb`
MariaDB / MySQL	`mysql+aiomysql://user:pass@localhost:3306/mydb`

Redis Configuration

Background tasks and rate-limiting require Redis. Install redis:

sudo apt install redis # Linux
brew install redis # MacOS
sudo dnf install redis # Fedora

Set the URL via the CACHE_URL / broker settings in settings.py:

CACHE_URL = "redis://localhost:6379/0"

# Background Tasks
TASKS: dict[str, Any] = dataclasses.field(
    default_factory=lambda: {
        "enabled": 1,
        "scheduler_enabled": 1,
        "tracking_enabled": 1,
        "log_to_file": 1,
        "log_level": "DEBUG",
        "log_format": "json",
        "log_dir": "logs",
        "broker": "redis",
        "broker_url": os.environ.get("REDIS_URL", "redis://localhost:6379/0"),
        "backend_url": os.environ.get("REDIS_BACKEND_URL", "redis://localhost:6379/1"),
     }
 )

Verifying the Installation

After installing, the openviper CLI should be available:

openviper version
# OpenViper 0.0.6

You can also verify from Python:

import openviper
print(openviper.__version__)   # 0.0.6

Development Server

OpenViper ships with Uvicorn as its ASGI server. Start the development server with either:

# Via management command (from inside a project)
python viperctl.py runserver --reload # --host 127.0.0.1 --port 8000