transer42 / pgbackup

practice project that backs up postgres to s3; created using test driven development

pgbackup

CLI for backup remote PostgresSQL database either locally or to S3.

Preparing for Development

1. Ensure pip and pipenv are installed
2. Clone reponsitory: gitclone [e-mail]: example/pgbackup
3. cd into the reponsitory
4. Fetch development dependencies make install
5. Activate virtualenv: pipenv shell

Usage

Pass in a full database URL, the storage driver, and the destination.

S3 Example w/ bucket name:

$ pgbackup postgres://[e-mail]:5432/db_one --driver s3 backups

Local Example w/ local path

$ pgbackup postgres://[e-mail]:5432/db_one --driver local /var/local/db_one/backups/dump.sql

Running Tests

Run tests locally using make if virtualenv is active:

$ make

If virtualenv isn't active then use:

$ pipenv run make