Skip to main content

A simple CLI utility for backing up PostgreSQL databases.

Project description


An open-source CLI tool for backing up PostgreSQL database Locally or to Amazon S3 bucket


You will pass in the following on the command line:

  • The CLI command backup
  • The database URL you need to connect to
  • The storage driver (S3 or Local)
  • The destination (S3 bucket or local path)


$ pip install backupdb


$ backupdb postgres://[USERNAME]:[PASSWORD]@[SERVER_IP:80/<db_name> --driver <driver_type> <destination>

Example usage for S3 backup

$ backupdb postgres://[USERNAME]:[PASSWORD]@[SERVER_IP:80/<db_name> --driver s3 mybucket01

Example usage for Local backup

$ backupdb postgres://[USERNAME]:[PASSWORD]@[SERVER_IP:80/<db_name> --driver local /var/local/mybackup.sql

Installation From Source

To install the package after you've cloned the repository, you'll want to run the following command from within the project directory:

$ pip install --user -e .

Preparing for Development

Follow these steps to start developing with this project:

  1. Ensure pip and pipenv are installed
  2. Clone repository: git clone
  3. cd into the repository
  4. Activate virtualenv source /venv/bin/activate
  5. Install dependencies: pip install -e . or pip install -r requirements

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

backupdb-0.0.5.tar.gz (4.5 kB view hashes)

Uploaded source

Built Distribution

backupdb-0.0.5-py3-none-any.whl (5.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page