Metadata-Version: 2.1
Name: wpbackup2
Version: 0.2.9
Summary: Backup and restore all your self-hosted WordPress content
Home-page: https://github.com/ravensorb/py-wordpress-backup
Author: Shawn Anderson
Author-email: code@eye-catcher.com
License: MIT License
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.
        
        The restore process will:
         - Extract the files into the correct location
         - Update ``wp-config.php`` with new settings (if needed)
         - Create the database if it doesn't exist
         - Add the user and grant it access if it doesn't exist
         - Restore the database
        
        ## Credit
        Credit for the original version of this goes to [Cariad Eccleston](https://github.com/cariad/py-wordpress-database).  
        
        ## 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
        
        ```python
        import wpbackup2
        
        wp = WpBackup()
        wpbackup('path to wordpress', 'archive name')
        ```
        
        ### Prerequisites
        
        py-wordpress-backup requires Python 3.6 or newer.
        
        ### Installing dependencies
        
        ```shell
        pip install -e .[dev]
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Description-Content-Type: text/markdown
Provides-Extra: dev
