AIVEX

Getting Started

Prerequisites, installation, and running your first AIVEX research cycle.

Prerequisites

  • Python 3.11 or 3.13
  • MySQL 8.0+ (local or remote)
  • A .env file with the required environment variables (see below)

Installation

Clone the repository and install dependencies:

git clone https://github.com/aivex/aivex.git
cd aivex
pip install -r requirements.txt

Environment Configuration

Copy the example environment file:

cp .env.example .env

Required variables:

| Variable | Description | |----------|-------------| | DB_HOST | MySQL host (default: localhost) | | DB_PORT | MySQL port (default: 3306) | | DB_NAME | Database name | | DB_USER | Database user | | DB_PASSWORD | Database password |

Optional variables:

| Variable | Description | |----------|-------------| | API_TOKEN | Bearer token for the Eye API (unset = auth disabled) | | GOVERNOR_KILL_SWITCH | Set to 1 to disable signal emission |

Running the System

Start everything (24/7 mode):

python Main.py

Run a single module once (for testing):

python -m watchdog.runners.module_runner news --mode once

Start only the Eye API:

python -m uvicorn eye.main:create_app --factory --port 8000

Verifying the Setup

After starting the system, check the Eye API:

curl http://localhost:8000/health

Expected response:

{"status": "ok", "version": "2.0.0"}

Database Setup

AIVEX automatically creates required tables on first run. For the OHLCV data, run the ingestion script once to populate historical data:

python Ingest_ohlcv.py

Next Steps