Why this repository?

Learning a framework is best done by example. This repository provides a structured, progressive set of examples that mirror the official documentation. Each section builds upon the previous one, taking you from a simple "hello world" to production-grade applications with Domain Driven Design, AI model serving, and more.

Quick Start

# Clone
git clone https://github.com/vortico/flama-examples.git && cd flama-examples

# Install (using uv, recommended)
uv sync

# Run any example
cd <section> && python <script>.py

Contents

#	Section	Description
01	Introduction	First steps with Flama: minimal apps, routing basics, and project structure
02	Getting Started	Setting up your environment and building your first complete application
03	Fundamentals	Applications, routes, components, modules, middleware, endpoints, resources, and responses
04	CLI Commands	Flama CLI usage: run, serve, start, model, get, upgrade
05	Advanced Topics	Config, debug, client, pagination, background tasks, lifespan, authentication, and testing
06	Predictive AI	Model packaging, adding models, model resources, and model components
07	Generative AI	Overview, serving LLMs, chatbot, and MCP
08	Domain Driven Design	Data models, repositories, workers, resources, and full application
09	Contributing	Contributing to Flama

What's Inside

flama-examples/
├── 01-introduction/            # Introduction to Flama
├── 02-getting-started/         # Getting started with Flama
├── 03-fundamentals/            # Applications, routes, components, modules, middleware, endpoints, resources, responses
├── 04-cli-commands/            # CLI usage: run, serve, start, model, get, upgrade
├── 05-advanced-topics/         # Config, debug, client, pagination, background tasks, lifespan, auth, testing
├── 06-predictive-ai/           # Model packaging, adding models, model resources, model components
├── 07-generative-ai/           # Overview, serving LLMs, chatbot, MCP
├── 08-domain-driven-design/    # Data models, repositories, workers, resources, full application
├── 09-contributing/            # Contributing to Flama
└── pyproject.toml              # Project config and dependencies

Tech Stack

Layer	Tool	Purpose
Language	Python 3.13+	Core language
Framework	Flama	Async-first API framework with ML-native support
ORM	SQLAlchemy	Database access and modelling
Migrations	Alembic	Schema versioning
Schemas	Pydantic, Marshmallow, Typesystem	Data validation and serialisation
Testing	pytest, pytest-asyncio	Async test suite
Package Manager	uv	Fast, modern Python dependency management

Contributing

# 1. Clone and install
git clone https://github.com/vortico/flama-examples.git && cd flama-examples
uv sync

# 2. Make your changes

# 3. Submit a pull request

License

This project is maintained by Vortico as companion material for the Flama documentation.

---