Skip to main content

The goal of the project is to simplify backup creation.

Project description

Backup Utils

pipeline status Code style: black

The goal of the project is to simplify backup creation. At the beggining it's using BorgBackup and Rclone. Now you can extend it !

1. Installation

make build and get the the pyz file into dist/

2. Usage

There are two commands. The first one is for is for add directory to configuration file which would be backup is the next time.

dist/backup_utils.pyz -d /an/absolute/path -d ./a/relative/path
dist/backup_utils.pyz --dir ~/user/path

It is usefull because this command will resolve the path for to have an absolute path.

Ths seconds command is the command to run a backup :

dist/backup_utils.pyz --run # the long one
dist/backup_utils.pyz -r # the shortcut
dist/backup_utils.pyz # `run` is the default command if there are no argument

3. Configuration

The configuration file is a JSON file store in ~/.config/bak-utils/config.json.

You can see config.example.json to have an example.

Root object:

  • directories: A list of directories to backup, please use --dir command to add a new directory.
  • repo: The directory containing the backup and that will be synchronize to a remote server.

For backup, sync and database object, the most important is the driver key. The other params is depending the driver.

backup driver supported:

  • borg

sync driver supported:

  • rclone

database driver supported:

  • mysql

If there is no database key in the config file, this task will be skipped.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

backup_utils-0.5.4.tar.gz (5.0 kB view hashes)

Uploaded Source

Built Distribution

backup_utils-0.5.4-py3-none-any.whl (6.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page