Skip to main content

Backup and restore all your self-hosted WordPress content

Project description

# py-wordpress-backup

A Python package for backing up and restoring a self-hosted WordPress installation, including the database and uploaded content.

The backup file will contain:

  • Your database as a MySQL dump.

  • An exact copy of your entire WordPress directory.

## TODO

  • Unit tests.

  • Handle wp-config.php being somewhere other than the default location.

## Installation

`shell pip install wpbackup2 `

## Usage

To backup:

` python3 -m wpbackup2 --backup --wp-dir /www/wordpress --archive ~/backup.tar.gz `

Note that the current release of py-wordpress-backup expected wp-config.php to exist within your WordPress directory, and will use it to read your database credentials to perform the backup. Keeping your wp-config.php file in this location might not be the best practice, and I’ll likely handle this in a future update.

To restore using database admin credentials held in AWS Secrets Manager:

`shell python3 -m wpbackup2 --restore --wp-dir /www/wordpress --archive ~/backup.tar.gz --admin-credentials-aws-secret-id AdminUserSecretID --admin-credentials-aws-region eu-west-1 `

To restore with specified database admin credentials:

`shell python3 -m wpbackup2 --restore --wp-dir /www/wordpress --archive ~/backup.tar.gz --admin-user admin --admin-password trustno1 --new-site-url https://new.site.url --new-site-host https://new.site.url --new-db-host --new-db-port 3306 --new-db-name new-wordpress-db-name `

## Development

### Prerequisites

py-wordpress-backup requires Python 3.6 or newer.

### Installing dependencies

`shell pip install -e .[dev] `

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

wpbackup2-0.2.4.tar.gz (7.0 kB view hashes)

Uploaded Source

Built Distributions

wpbackup2-0.2.4-py3.7.egg (15.4 kB view hashes)

Uploaded Source

wpbackup2-0.2.4-py3-none-any.whl (9.3 kB view hashes)

Uploaded Python 3

Supported by

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