A simple backup program in python with an emphasis on data integrity and transparent behaviour
GPL-3.0 License
pip install backupy --upgrade
analysis/callgraph.svg
FileManager
in backupy/fileman.py
) that ever touch your files, no more, no less, three shall be the number of thou functions, and the number of the functions shall be threeFileOps
from backupy.utils
for easy monkey patching (see example_extension.py
)--posix
flag if you plan on using BackuPy between Windows and any other OSMain modes
(how to handle new and deleted files)
Backup mode:
copies files that are only in source to destinationMirror mode:
copies files that are only in source to destination and deletes files that are only in destinationSync mode:
copies files that are only in source to destination and copies files that are only in destination to source
--sync-delete
to propagate deletionswrite_database_x2
in the configuration file if syncing more than two foldersSelection modes
(which file to select in cases where different versions exist on both sides)
Source mode:
copy source files to destinationDestination mode:
copy destination files to sourceNewer mode:
copy newer files based on last modified timeNone mode:
don't copy either, differing files will only be logged for manual interventionCompare modes
(how to detect which files have changed)
Attribute mode:
compare file attributes (size and last modified time)Attribute+ mode:
compare file attributes and calculate CRCs only for new and changed files for future verificationCRC mode:
compare file attributes and CRC for every file, and checks previously stored CRCs to detect corruption
--verify
to verify the CRC of files after they're copied--dry-run
flag--qconflicts
if using --noprompt
, especially if also using --noarchive
<source|dest>/.backupy/Archives/yymmdd-HHMM/<original path>
<source|dest>/.backupy/Trash/yymmdd-HHMM/<original path>
--nofollow
to copy symbolic links to files verbatimusage: backupy [options] -- <source> <dest>
backupy <source> <dest> [options]
backupy <source> --load [-c mode] [--dbscan] [--dry-run]
backupy -h | --help | --version
positional arguments:
source Path to source
dest Path to destination
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
file mode options:
-m mode Main mode: for files that exist only on one side
MIRROR (default)
[source-only -> destination, delete destination-only]
BACKUP
[source-only -> destination, keep destination-only]
SYNC
[source-only -> destination, destination-only -> source]
-s mode Selection mode: for files that exist on both sides but differ
SOURCE (default)
[copy source to destination]
DEST
[copy destination to source]
NEW
[copy newer to opposite side]
NO
[do nothing]
-c mode Compare mode: for detecting which files differ
ATTR (default)
[compare file attributes: mod-time and size]
ATTR+
[compare file attributes and record CRC for changed files]
CRC
[compare file attributes and CRC for every file]
misc file options:
--sync-delete
Use the database to propagate deletions since the last sync
--fi regex [regex ...]
Filter: Only include files matching the regular expression(s)
(include all by default, searches file paths)
--fe regex [regex ...]
Filter: Exclude files matching the regular expression(s)
(exclude has priority over include, searches file paths)
--noarchive Disable archiving files before overwriting/deleting to:
<source|dest>/.backupy/Archives/yymmdd-HHMM/
<source|dest>/.backupy/Trash/yymmdd-HHMM/
--nofollow Do not follow symlinks when copying files
--nomoves Do not detect when files are moved or renamed
execution options:
--noprompt Complete run without prompting for confirmation
-d, --dbscan
Only scan files to check and update their database entries
-n, --dry-run
Perform a dry run with no changes made to your files
-q, --qconflicts
Quit if database conflicts are detected (always notified)
-> unexpected changes on destination (backup and mirror)
-> sync conflict (file modified on both sides since last sync)
-> file corruption (ATTR+ or CRC compare modes)
-v, --verify
Verify CRC of copied files
backend options (experimental):
--cold Do not scan files on destination and only use local databases
--rsync Use rsync for copying files
configuration options:
--nolog Disable writing log and file databases to:
<source>/.backupy/Logs/log-yymmdd-HHMM.csv
<source|dest>/.backupy/database.json
-p, --posix Force posix style paths on non-posix operating systems
-k, --save Save configuration to <source>/.backupy/config.json and exit
-l, --load Load configuration from <source>/.backupy/config.json and run
BackuPy is a simple backup program in python with an emphasis on data
integrity and transparent behaviour - https://github.com/elesiuta/backupy
BackuPy comes with ABSOLUTELY NO WARRANTY. This is free software, and you are
welcome to redistribute it under certain conditions. See the GNU General
Public Licence for details.
<source>/.backupy/config.json
--load
and can override settings in config.json
are -c mode
, --dbscan
, and --dry-run
--dbscan
or --dry-run
but not disablebackupy/config.py
for where all the options and defaults are stored in codesource_unique_id
& dest_unique_id
write_database_x2
is enabled, each assigned a random string by defaultarchive_dir
= ".backupy/Archive"
config_dir
= ".backupy"
log_dir
= ".backupy/Logs"
trash_dir
= ".backupy/Trash"
cleanup_empty_dirs
= True
root_alias_log
= True
<source>
and <dest>
in logsstdout_status_bar
= True
verbose
= True
write_database_x2
= False
unique_id
, useful for syncing groups of more than two folders or with the --sync-delete
flagwrite_log_dest
= False
<dest>/<log_dir>/log-yymmdd-HHMM-dest.csv
write_log_summary
= False
nocolour
= False
python setup.py test
python setup.py sdist
pyinstaller build.spec