patronx 2.0.0

Simple package for backups and recovery

PatronX

PatronX is a lightweight toolkit for PostgreSQL backups, point‑in‑time recovery and object‑storage offloading. The project is written in modern typed Python and ships with a clean command‑line interface.

Features

• Simple CLI for backup, restore and listing available dumps
• Scheduled backups via cron expressions
• Optional upload to S3 for off‑site storage
• Typed Python code with unit tests

DB

• postgres >= 16

pip install -e . # to install in editable mode
patronx --version
patronx list
patronx check-db
patronx backup [--plain] [--no-progress]
patronx restore --inp /path/to/backup.dump [--plain] [--no-progress]
patronx server

patronx enqueue-backup # with remoulade and rabbitmq

The server command starts schedulers that enqueue backup and cleanup jobs periodically. The backup schedule is controlled via the BACKUP_CRON environment variable while cleanup uses CLEANUP_CRON. Both take standard cron expressions. When unset they default to running once per day for backups and at 1AM for cleanup. Old backups are removed according to the number of days specified in RETENTION_DAYS (defaults to 30).

AWS configuration

Set the following variables so AwsAssetStore can authenticate using the s3-uploader-luxoai IAM user:

AWS_ACCESS_KEY_ID Access key for the IAM user. AWS_SECRET_ACCESS_KEY Secret key for the IAM user. AWS_REGION Region where the bucket resides.

Test

pytest

Linting and Formatting

ruff check . --fix
isort .

Generate requirements

pip install pip-tools
pip-compile --output-file=requirements.txt pyproject.toml