Skip to content

Reference

Complete reference documentation for VenomQA.

API Reference

Complete documentation for all public classes and functions.

CLI Reference

Command-line interface documentation.

Configuration

All configuration options and environment variables.

Database Backends

Configure state management backends.

Adapters

Available adapters for external services.

Reporters

Report formats and custom reporters.

API Overview

Core Models

Python
from venomqa import (
    Journey,          # Complete user scenario
    Step,             # Single action
    Checkpoint,       # Database savepoint
    Branch,           # Multiple paths
    Path,             # Path within a branch
)

Results

Python
from venomqa import (
    JourneyResult,    # Journey execution result
    StepResult,       # Step execution result
    PathResult,       # Path execution result
    Issue,            # Captured failure
    Severity,         # Issue severity level
)

Execution

Python
from venomqa import (
    JourneyRunner,    # Execute journeys
    Client,           # HTTP client
    ExecutionContext, # Shared state
    QAConfig,         # Configuration
)

State Management

Python
from venomqa.state import (
    PostgreSQLStateManager,  # PostgreSQL backend
    SQLiteStateManager,      # SQLite backend
    BaseStateManager,        # Base class
)

Ports & Adapters

Python
from venomqa.ports import (
    CachePort,        # Cache interface
    MailPort,         # Email interface
    QueuePort,        # Queue interface
    # ... more ports
)

from venomqa.adapters import (
    RedisCacheAdapter,   # Redis cache
    MailhogAdapter,      # Mailhog email
    # ... more adapters
)

CLI Commands

Command Description
venomqa run [JOURNEYS] Run journeys
venomqa list List available journeys
venomqa report Generate reports
venomqa --version Show version
venomqa --help Show help

Configuration Quick Reference

YAML
# venomqa.yaml
base_url: "http://localhost:8000"
db_url: "postgresql://user:pass@host:5432/db"
db_backend: "postgresql"
timeout: 30
retry_count: 3
parallel_paths: 1
fail_fast: false
verbose: false
report_dir: "reports"
report_formats: ["markdown", "junit"]

Environment variables:

Bash
VENOMQA_BASE_URL=http://api.example.com
VENOMQA_DB_URL=postgresql://...
VENOMQA_TIMEOUT=60
VENOMQA_VERBOSE=true