Getting Started

This guide will help you set up an5 in your project in under 5 minutes for Python with Googlesheets.

For the current implementation and package maturity overview, see Feature Status.

Prerequisites

  • Node.js 18+ (Node 24 recommended for schema compiler and CLI)
  • Python 3.9+ (pip or poetry)

  • Connection to Googlesheets (or local embedded setup)

Installation

# Generated Python client runs alongside your app
pip install pydantic python-dotenv

Generate your client using npm run generate from an5Orm/.

Configuration

1. Set up Environment Variables

Edit .env and configure your database connection string:


DATABASE_URL=googlesheets://spreadsheet_id?credentials=./service-account.json

2. Define Your Schema

Create .an5 files in the an5Schema/ directory:

// an5Schema/User.an5
model User {
  id        NVARCHAR(1000) @id @default(uuid())
  email     NVARCHAR(255)  @unique
  name      NVARCHAR(255)?
  createdAt DATETIME2      @default(now())
  
  @@map("users")
}

3. Generate Client Code

Run from the an5Orm/ repository directory:

npm run generate

This generates type-safe client code in an5Client/python/.

4. Push Schema to Database

npm run db:push

This creates the tables in your database.

Your First Query

import os
from an5_client import An5Client

# Initialize client (reads DATABASE_URL)
db = An5Client(connection_string=os.getenv("DATABASE_URL"))

def main():
    # Create a user
    user = db.user.create(data={
        "email": "john@example.com",
        "name": "John Doe"
    })
    print("Created user:", user)

    # Find all users
    users = db.user.find_many()
    print("All users:", users)

if __name__ == "__main__":
    main()

Project Structure

an5/
├── an5Schema/           # Schema definitions (.an5 files)
├── an5Client/           # Generated client code for all target languages
│   ├── typescript/
│   ├── python/
│   ├── dotnet/
│   ├── golang/
│   ├── rust/
│   ├── java/
│   ├── kotlin/
│   └── swift/
├── an5Orm.config.js     # ORM configuration & database mapping
└── .env                 # Environment variables & connection strings

Available Commands

Schema/database commands run from the an5Orm/ repository directory:

Command Where Description
npm run generate an5Orm/ Generate client code from schema
npm run db:push an5Orm/ Push schema to database
npm run db:pull an5Orm/ Pull schema from database
npm run db:seed an5Orm/ Seed database with sample data
npm run db:migrate diff an5Orm/ Compare schema with database
npm run db:migrate:generate an5Orm/ Generate migration SQL
npm run db:migrate:apply an5Orm/ Apply pending migration files
npm run db:migrate:rollback an5Orm/ Roll back migrations
npm run db:migrate:status an5Orm/ Show migration status

Next Steps