Phzyx Forge

The Phzyx data stack in one install — Pydantic schema, failsafe migrations, dual sync/async ORM, AdminBoard, and the phzyx CLI.

Define once in Pydantic. Push or migrate safely. Ship AdminBoard without bolting on a second product.

Start here (website & docs)

PyPI is only the install surface. Full guides, tutorials, performance story, and product home live on the Phzyx site:

If you only open one page after install → phzyx.xyz/forge/beginner.

Install

uv add phzyx-forge
# or
pip install phzyx-forge

That is the full library for local work: schema · engine · ORM · AdminBoard (FastAPI + SPA) · CLI · SQLite (aiosqlite included).

FastAPI is required for the default AdminBoard path (included as a dependency). Forge is built to complete the FastAPI-era feature set — stay on the API stack you chose instead of switching frameworks only for admin/batteries.

# First run — any OS (macOS / Linux / Windows)
uv tool install phzyx-forge
# upgrading an older install?
uv tool install phzyx-forge --reinstall

forge new myapp --yes            # alias: phzyx new myapp --yes
cd myapp
uv sync
uv run forge start               # alias: uv run phzyx start
# → http://127.0.0.1:9898  /docs  /admin/

# Already inside a uv project? scaffold *here* (no nested folder):
#   uv add phzyx-forge
#   uv run forge init --yes
#   uv run forge start

Always use uv run … inside a project. Do not run bare uvicorn from Homebrew/global Python.

Full CLI docs: phzyx.xyz/forge/cli.

Extras (when you need them)

uv add 'phzyx-forge[postgres]'
uv add 'phzyx-forge[auth]'
uv add 'phzyx-forge[full]'

Already installed Forge? Same commands merge extras — nothing to uninstall.

Quick taste

from phzyx.schema.model import Model
from phzyx.orm import Session
from phzyx.admin.fastapi import AdminBoard

# Prefer the full walkthrough:
# https://phzyx.xyz/forge/getting-started

Imports stay under phzyx.* — one brand, one mental model.

What you get

• Schema — Pydantic models as source of truth
• Engine — push / migrate with failsafe-minded workflow
• ORM — dual sync + async sessions
• AdminBoard — intentional admin API + SPA (not a bolt-on afterthought)
• CLI — phzyx new, phzyx db push, doctor, presets

Pre-1.0: APIs may evolve. Prefer a lockfile (uv.lock); read the site for the current story.

Where to go next

1. Getting started — first app path
2. Forge docs hub — guides & reference
3. AdminBoard — operator UI
4. GitHub forge — source, issues, releases

License

MIT · Athul Nandaswaroop · phzyx.xyz