Metadata-Version: 1.1
Name: amendment-back-up
Version: 0.0.4
Summary: Incremental backup
Home-page: https://github.com/sunyu0410/AmendmentBackUp
Author: Yu Sun
Author-email: sunyu0410@gmail.com
License: UNKNOWN
Description: A Python class for file comparison and new file backup.
        
        Author: Yu Sun at University of Sydney
        
        Email: sunyu0410@gmail.com
        
        Website: https://github.com/sunyu0410/AmendmentBackUp
        
        ## Motivation
        When it comes to backing up a large amout of data, it is often preferable to only copy the modified and unique files, rather than simply coping the whole directory. The `AmendmentBackUp` (`ABU`) class provides a simple interface to do that. No dependencies are required apart from the Python 3 standard library.
        
        ## Design
        Say we have two folders, a source folder `dir1` which you have your most recent files and a reference folder `dir2` which holds some of your previous backup. What the `ABU` does is to compare all files in `dir1` with those in `dir2`, and copy the files to a third destination folder `dst`. If you simply want to add the files to the original back, you can set `dst` to `dir2`.
        
        ## A quick example
        
        
        
        
        ## Limitation
        The `ABU` is best suited for when the source folder `dir1` is a natural growth of the reference folder `dir2`. What I mean by *natural growth* is that there should not be too much renaming or move of the subfolders from `dir2` to `dir1`. If that's the case, using a version control system is probably a better option.
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: System :: Archiving :: Backup
