multiversion-backup

Summary

An easily configurable BackUp class which copies a target file or folder to set output folders. Detects and keeps a set amount of backup versions and deletes old backups outside that range.

Breakdown

• You initialise a BackUp object and use .copy()
• A version of the backup target is saved to the output folder or folders
• A log file is generated, with logs detailing the backup activity (see example directory)
• Older backups outside of the specified limit are deleted
• Backups won't occur if the target hasn't changed (coming soon for folders)

Quick Install

pip install multiversion-backup

Usage

Import the BackUp class

from multiversion_backup import BackUp

Create the BackUp object

Per File backup

backup_object = BackUp(r"F:\image.jpg",  # Source file as a string
                     r"F:\File Backup",  # String or list of output folders
                     "important_file",  # Prefix for the output file name and log messages
                     3)  # Maximum amount of backups to keep

Per Folder backup

backup_object = BackUp(r"F:\Folder",  # Source folder as a string
                       [r"F:\Folder Backup 1", r"F:\Folder Backup 2"],  # String or list of output folders
                       "important_folder",  # Prefix for the output folder name and log messages
                       5)  # Maximum amount of backups to keep

Call the .copy() method

backup_object.copy()

Troubleshooting

• File or folder names in the output folders will be ignored if they do not start with the defined prefix
• Changes to the datetime string formatting of the output file's names will raise exceptions

Why?

I made this since I was frustrated with syncing behaviours of services like OneDrive, which when used to sync files that were actively in use, would cause lag and other issues.

This method side steps the issue by letting you schedule when you copy to OneDrive, providing incremental multi-version backup and synchronisation without OneDrive disruptively trying to synchronise files that are always being actively used and changed like game saves and settings.