Getting Started

Vorte is an AI-first Python framework built on FastAPI with a high-performance Rust engine. This guide walks you through installation, project scaffolding, and your first application.

Requirements

Dependency	Minimum Version	Notes
Python	3.11+	Required for all installations
Rust	1.75+	Required only for the native engine
pip	23.0+	Package manager

Installation

Install the core framework with a single command. Vorte pulls in FastAPI, Pydantic v2, and the module loader automatically.

terminal

bash

Copied!

1	pip install vorte

Optional Dependency Groups

Vorte ships optional extras so you only install what your project needs. Combine multiple groups in a single install command.

terminal

bash

Copied!

1	# AI provider integrations (OpenAI, Anthropic, Google, Groq)
2	pip install vorte[ai]
3
4	# Database support (SQLAlchemy async, Alembic)
5	pip install vorte[database]
6
7	# Caching layer (Redis, Memcached)
8	pip install vorte[cache]
9
10	# Queue and background jobs (Celery, RQ)
11	pip install vorte[queue]
12
13	# Storage backends (S3, GCS, Azure Blob)
14	pip install vorte[storage]
15
16	# GraphQL support (Strawberry, Ariadne)
17	pip install vorte[graphql]
18
19	# Authentication (JWT, OAuth2, MFA)
20	pip install vorte[auth]
21
22	# Everything at once
23	pip install vorte[all]

Quick Start

The Vorte CLI scaffolds a production-ready project structure with sensible defaults, configuration files, and a pre-configured module layout.

Create a New Project

terminal

bash

Copied!

1	# Create a new project with the default template
2	vorte new my-app
3
4	# Navigate into the project directory
5	cd my-app
6
7	# Install project dependencies
8	pip install -r requirements.txt

The scaffolded project includes a main.py entry point, amodules/ directory, configuration files, and apyproject.toml ready for customization.

Run the Development Server

terminal

bash

Copied!

1	# Start the development server with hot reload
2	vorte serve
3
4	# Or specify host and port
5	vorte serve --host 0.0.0.0 --port 8000 --reload

The development server starts with hot reload enabled by default. Openhttp://localhost:8000 to see your application. Built-in endpoints such as /health, /ready, and /info are available immediately.

Minimal Application

The fastest way to get a Vorte application running is the auto_load flag. It discovers and registers all modules in your project automatically.

root.py

python

Copied!

1	from vorte import Vorte
2
3	app = Vorte(auto_load=True)
4
5	@app.get("/")
6	async def root():
7	return {"message": "Hello from Vorte!"}
8
9	if __name__ == "__main__":
10	app.run()

Cherry-Picking Modules

For more control, specify exactly which modules to load. Only the listed modules are registered; everything else is ignored.

example.py

python

Copied!

1	from vorte import Vorte
2
3	app = Vorte(
4	modules=["auth", "database", "ai"],
5	auto_load=False,
6	)

Excluding Modules

Use exclude to load everything except specific modules. This is useful when you want most defaults but need to replace one.

example.py

python

Copied!

1	from vorte import Vorte
2
3	app = Vorte(
4	auto_load=True,
5	exclude=["graphql", "queue"],
6	)

Custom Configuration

Pass a configuration dictionary or path to a YAML/JSON file to customize module behavior without touching code.

example.py

python

Copied!

1	from vorte import Vorte
2
3	app = Vorte(
4	auto_load=True,
5	config_path="config/production.yaml",
6	)
7
8	# Or inline configuration
9	app = Vorte(
10	auto_load=True,
11	config={
12	"database": {"url": "postgresql+asyncpg://user:pass@localhost/db"},
13	"cache": {"backend": "redis", "url": "redis://localhost:6379"},
14	"ai": {"default_provider": "openai", "model": "gpt-4o"},
15	},
16	)

Verifying Your Installation

Run the built-in health check to confirm Vorte and its modules are loaded correctly.

terminal

bash

Copied!

1	# From the CLI
2	vorte doctor
3
4	# Or via HTTP
5	curl http://localhost:8000/health

The vorte doctor command checks Python and Rust versions, module availability, dependency health, and configuration validity.

Next Steps

Learn about the Application class and lifecycle hooks
Explore the Module System to understand how Vorte loads and prioritizes modules
Set up Routing with versioning and deprecation headers
Configure the AI Module for multi-provider integration

Getting Started

Requirements

Installation

Optional Dependency Groups

Quick Start

Create a New Project

Run the Development Server

Minimal Application

Cherry-Picking Modules

Excluding Modules

Custom Configuration

Verifying Your Installation

Next Steps

Stay in the loop