Quickstart

1. Install

pip install pawabase-iac

Python 3.11 or newer. This installs the pawabase command.

2. Create a project

mkdir shop && cd shop
pawabase init

init creates:

File	Purpose
`pawabase.toml`	Where to deploy: the gateway address, the environment, and where your definitions live
`infra/app.py`	A small working backend to start from
`.env.example`	The variables you’ll need (copy to `.env`)

pawabase.toml:

url = "http://localhost:8080"     # your Pawabase gateway
environment = "development"      # the environment to deploy to
entry = "infra"                  # a file or a folder of .py files holding your definitions

3. Make a deploy key

In Studio, open the environment and go to the API keys page: New key, role Secret, preset Deploy and configure. Put it in .env:

echo 'PAWABASE_API_KEY=pb_sk_...' >> .env

Never commit .env. The key doesn’t live in pawabase.toml.

4. Look at the definitions

infra/app.py defines a few things. Here is a table and the access rules for it:

from pawabase_iac import P, Policy, String, Boolean, Table, crud

mine = Policy("mine", P.owner("user_id"))

todos = Table(
    "todos",
    fields=[
        String("title", required=True, max_length=200),
        Boolean("done", default=False),
        String("user_id", indexed=True),
    ],
    operations=crud(mine),
)

5. Validate, rehearse, plan, deploy

pawabase validate       # offline: names, types, rules, references
pawabase emulate        # a pretend deploy: nothing real is touched
pawabase plan           # what would change in the real environment (reads only)
pawabase deploy         # apply it

plan prints something like:

+ table   todos
+ policy  mine
2 to create, 0 to change, 0 to remove

deploy applies it. The environment now has the table and the rule; open Studio to see them under Data and Access → Policies.

6. Change something

Edit the file (add a field), run pawabase plan and you’ll see ~ table todos with the fields that differ. Run pawabase deploy to apply it.

Project files

pawabase.toml, .env and structure.

Tables

Everything about a table.

Overview

Infrastructure as code

Define your backend

Logic and events

Files and mail

Ship it

Reference

SDK clients

1. Install

2. Create a project

3. Make a deploy key

4. Look at the definitions

5. Validate, rehearse, plan, deploy

6. Change something

Next

Project files

Tables

​1. Install

​2. Create a project

​3. Make a deploy key

​4. Look at the definitions

​5. Validate, rehearse, plan, deploy

​6. Change something

​Next

Project files

Tables

1. Install

2. Create a project

3. Make a deploy key

4. Look at the definitions

5. Validate, rehearse, plan, deploy

6. Change something

Next