/backupy

backupy is a handy backup tool written in python 3

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

backupy is a handy backup tool written in python 3

License: GPLv3

Copyright 2024, Balint Fekete

Feature list

  • backup sets are separatable in unique config files
  • multiple config files as parameters - able to execute them in one batch (in sequence)
  • unique backup tasks in backup sets (up to 99)
  • global exclude lists (file, dir, filetype) for entire backup set
  • handling broken symlinks for "tar+follow syms+broken syms" use case
  • validate mode: only config file validation, no execution
  • create md5sum from archive file
  • every backup task is customizable
    • enabled / disabled
    • archive file name
    • result dir
    • create date-format subdir in result dir
    • compression method (tar, targz, tarbz2, zip)
    • store files/directories with/without full path
    • follow symlinks (yes/no)
    • include directories (multiple entries)
    • exclude directory names
    • exclude directory with fullpath
    • exclude filenames
    • exclude filetypes (special: '~' → mynovel.doc~ )
    • skip task if permission fail
    • skip task if directory is non-existent

Basics

Set up, get repo

git clone https://github.com/kaktusztea/backupy.git

Help

./backupy.py --help

Initial configuration: creating default.cfg

./backupy.py

customize default backup set and start backup

vi ~/.config/backupy/default.cfg   (customize)
./backupy.py   (start backup with default backup set)

create custom backup set and start backup

cp ~/.config/backupy/default.cfg /my/path/mybackup.cfg
vi /my/path/mybackup.cfg   (customize)
./backupy.py /my/path/mybackup.cfg

Known issues

  • follow symlink does not work with zip compression (old zip standard doesn't support it, will try to hack it anyway :)

Planned features

  • exclude / include unique files

  • 7zip/lz support

  • META section

   [META]
   description = "This is my set for weekly data backup"
   author = myuser
   creation_date = 2016-09-01

  • [HOME_CONFIGS] unique backup section

  • remote compression target (ssh, etc)

  • reserve and move n previous backups

  • comment file addition to archive (zip)

  • filelist file creation from archive - after compression

  • pre-calculate estimated file size → predict if free space will be enough or not

  • logging

Contact

If you have comments, found a bug or just want to explain how awesome this script is :) - write a mail:

kaktusztea _ at_ protonmail _ dot_ com