cpieloth / backbacker

A light backup tool.

BackBacker - A light backup tool.

BackBacker is a light backup tool with a batch file based on simple commands with arguments.

Concept

Job script with one instruction per line:

$ cat examples/job.bb
git_bundle -r /tmp/git_repo -d /tmp
hg_bundle -r /tmp/hg_repo -d /tmp

Run backup job:

$ backbacker.py batch examples/batch.bb

Additional you can run or use each command in your own script by using it as a sub-command:

$ backbacker.py git_bundle -r /tmp/git_repo -d /tmp
$ backbacker.py hg_bundle -r /tmp/hg_repo -d /tmp

Installation & Usage

• Clone repository:

$ git clone https://github.com/cpieloth/BackBacker.git BackBacker

• Install BackBacker:

$ cd BackBacker
$ python3 setup.py install

• Create a config (optional):

$ cp examples/config.ini examples/myconfig.ini
$ editor examples/myconfig.ini

• Create a backup batch:

$ cp examples/batch.bb examples/batch.bb
$ editor examples/batch.bb

• Run your backup job

$ backbacker batch -c examples/config.ini examples/batch.bb

• Create a cron job (optional):

$ crontab -e

backbacker's Issues

Github Clone: No access to Tempfolder on Windows

github clone is not working on Windows, because of access problems of tempfolder.

Git: Git clone not working with URLs

git clone is not working for URLs, because it checks read access with os.access. It is currently designed to clone a folder.

GitHub REST-API broken

• git clone via git protocol fails
• instead use of https
• use clone_url in REST API
• check for other changes

Re-structure to python project template

• see cpieloth project template
• introduce tox, changelog, semver, github action

Create a Singleton Config Object

For commands it should be possible to request commands parameters at anytime without knowing the logic behind the file reading and creating config object.
A singleton pattern which reads a config file on first call is to be implemented, file name is an optional parameter.

Robocopy support

• support robocopy
• see https://docs.microsoft.com/de-de/windows-server/administration/windows-commands/robocopy
• use same interface for robocopy and rsync

Support Variables in Job Script

Variables in job script, e.g. ${BACKUP_DIR} is replaced by pre-processing script file.

Investigate duplicity

• Can BackBacker be transformed to plugin collection for duplicity?
• Can BackBacker create a duplicity wrapper?
• ...

Create SSH/SCP Command

Support/create command for ssh/scp to use it for secure file transfer.

Code Quality: pylint & pycodestyle

Refactor Command Parsing using Argparse

Refactor command class with its instance(cls, params) and prototype(cls) methods.

• prototype(cls) can be removed, because a class object can be used instead.
• instance(cls, params) should use argparse and should be renamed
• command should support external use as sub parser, set default func
• Job file format is then in "CLI format", e.g. git_bundle --src /git/foo --dest /tmp
• Job can may use argparse to check which command has to be triggered
• Job may become a task which reads and executes a job file

Benefits:

• argparse can produce help text
• argparse can check arguments (required, ...)
• opportunity to use sub commnd
• opportunity to create entry points for CLI access

Create a Build System

Create a simple build system using Make. Following targets are desired:

• make doc, make doc_manual (AsciiDoc/Markdown), make doc_api (Sphinx)
• make check_code (pylint)
• make package (trigger setup.py)
• make test (unittest)
• make clean

Export/BackUp VirtualBox Machines

Export/BackUp VirtualBox Machines.

GithubBundleCliCommand does not contain all branches

• GithubBundleCliCommand does not contain all branches
• rename CLI command name