nyxa-postgres — PostgreSQL extras for Nyxa

Optional helpers for apps using nyxa-db with PostgreSQL. Core nyxa and nyxa-db do not hard-depend on this package.

Install

uv add nyxa-db nyxa-postgres

Or scaffold with Postgres wiring:

uv run nyxa init myapi --database postgres

That adds both packages, a matching DATABASE_URL, and a docker-compose.yml.

URL helper

from nyxa_postgres import postgres_url

url = postgres_url(user="user", password="pass", database="app")
# postgresql+psycopg://user:pass@localhost:5432/app

Soft pool defaults

When DATABASE_URL is a Postgres URL and nyxa-postgres is installed, nyxa_db.get_engine applies pool_kwargs() (pool_size=5, max_overflow=10, pool_pre_ping=True). Without this package, engines use SQLAlchemy defaults.

Compose snippet

from nyxa_postgres import compose_snippet

print(compose_snippet())  # postgres:16, user/pass/app on :5432

docker compose up -d
uv run nyxa db migrate