Skip to content

Installation

Requirements

  • Python 3.12 or later
  • uv (recommended) or pip

Install with uv

For most projects you want the full stack — models, routers, and scaffolding:

uv add pyoas[fastapi]

Models only (no FastAPI dependency)

uv add pyoas

Claude Code skills (optional)

Can be combined with either install above:

uv add "pyoas[fastapi,claude]"

Install with pip

pip install "pyoas[fastapi]"

Verify

pyoas --help

Development install

To work on pyoas itself, clone the repo and install with all extras:

git clone https://github.com/wianra/pyoas.git
cd pyoas
uv sync --extra fastapi --extra claude

Run tests:

uv run pytest