API Reference

This section documents the core Velox API.

Velox Core

Request

Response

Router / Blueprint

WebSocket

Route Pattern

Module Functions

velox.core.load_env(path='.env')

Loads environment variables from a .env file.

Parameters:

path (str) – Path to the .env file

Raises:

FileNotFoundError – If the file doesn’t exist

Example:

velox.core.load_env('.env.prod')

Constants

velox.core.CONVERTERS

Dictionary of URL parameter converters.

Type Aliases

velox.core.MeuFramework

Alias for velox.core.Velox (for backwards compatibility).

from velox import MeuFramework

is equivalent to:

from velox import Velox

velox.core.Blueprint

Alias for velox.core.Router.

from velox import Blueprint

is equivalent to:

from velox import Router