Project files

pawabase.toml

Key	Meaning	Default
`url`	Your Pawabase gateway	none (required to plan and deploy)
`environment`	The environment to deploy to	`development`
`entry`	A file, or a folder of `.py` files, that holds your definitions	`infra`

Override any of them for one run with the shared options:

Option	Overrides
`-e`, `--env`	`environment`
`--url`	`url`
`--entry`	`entry`
`--json`	Print machine-readable output

Environment variables PAWABASE_URL and PAWABASE_ENV do the same, which is how CI sets them.

.env

Local, never committed. The API key and any secrets your definitions read:

PAWABASE_API_KEY=pb_sk_...
ERP_SECRET=...

Real environment variables win over .env. See Secrets and env.

Definitions register themselves

Creating an object registers it. There is no list to maintain:

Role("teacher", permissions=["grades.write"])
Policy("staff", P.role("admin") | P.role("teacher"))

When you run any command, the CLI imports your entry and collects everything that was created.

Splitting across files

With entry = "infra", every .py file in the folder is run once, and files can import each other:

infra/
  roles.py          # Role(...)
  policies.py       # from infra.roles import ...; Policy(...)
  students.py       # tables
  billing.py        # flows, routes, webhooks

# infra/students.py
from infra.policies import staff, mine
from pawabase_iac import Table, String, crud

students = Table("students", fields=[String("name", required=True)], operations=crud(staff))

Pass a definition object where a name is expected (a table’s operations, a route’s handler, a subscription’s run) and the name is filled in for you, so renaming something updates every reference.

Several environments

The same code deploys to every environment. Choose with -e:

pawabase deploy -e staging
pawabase deploy -e production      # production asks to confirm

Keep differences small and in data (env("…") secrets, a different URL), not in code paths.

A typical layout

shop/
  pawabase.toml
  .env                 # not committed
  .env.example
  infra/
  tests/               # test your own helpers
  .github/workflows/   # see CI/CD

Validate

What is checked.

CI/CD

Automate it.

Overview

Infrastructure as code

Define your backend

Logic and events

Files and mail

Ship it

Reference

SDK clients

pawabase.toml

.env

Definitions register themselves

Splitting across files

Several environments

A typical layout

Validate

CI/CD

​pawabase.toml

​.env

​Definitions register themselves

​Splitting across files

​Several environments

​A typical layout

Validate

CI/CD

pawabase.toml

.env

Definitions register themselves

Splitting across files

Several environments

A typical layout