Installation¶

Requirements¶

pip install ormai

Install with extras for your preferred ORM:

SQLAlchemyTortoisePeeweeDjangoAll ORMs

pip install ormai[sqlalchemy]

pip install ormai[tortoise]

pip install ormai[peewee]

pip install ormai[django]

pip install ormai[all]

If you're using uv as your package manager:

uv add ormai
uv add ormai --extra sqlalchemy

For development or contributing:

git clone https://github.com/neul-labs/ormai.git
cd ormai
uv sync --all-extras

For Model Context Protocol server integration:

pip install ormai[mcp]

For FastAPI integration:

pip install ormai[fastapi]

Install all optional dependencies:

pip install ormai[all]

Verify your installation by importing OrmAI:

import ormai
print(ormai.__version__)

Or check the available quickstart functions:

from ormai.quickstart import mount_sqlalchemy, mount_tortoise, mount_peewee
print("OrmAI installed successfully!")

For TypeScript/Node.js projects, see the TypeScript Edition documentation.

npm install ormai
# or
yarn add ormai