Skip to content

Bakthat is a MIT licensed backup framework written in Python, it's both a command line tool and a Python module that helps you manage backups on Amazon S3/Glacier. It automatically compress, encrypt (symmetric encryption) and upload your files.

License

yoyama/bakthat

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bakthat

Bakthat is a MIT licensed backup framework written in Python, it's both a command line tool and a Python module that helps you manage backups on Amazon S3/Glacier. It automatically compress, encrypt (symmetric encryption) and upload your files.

Here are some features:

  • Compress with tarfile
  • Encrypt with beefish (optional)
  • Upload/download to S3 or Glacier with boto
  • Local backups inventory stored in a SQLite database with peewee
  • Delete older than, and Grandfather-father-son backup rotation supported
  • Possibility to sync backups database between multiple clients via a centralized server

You can restore backups with or without bakthat, you just have to download the backup, decrypt it with Beefish command-line tool and untar it.

Check out the documentation to get started.

Overview

Bakthat command line tool

$ pip install bakthat

$ bakthat configure

$ bakthat backup mydir
Backing up mydir
Password (blank to disable encryption): 
Password confirmation: 
Compressing...
Encrypting...
Uploading...
Upload completion: 0%
Upload completion: 100%

or

$ cd mydir
$ bakthat backup

$ bakthat show
2013-03-05T19:36:15 s3  3.1 KB  mydir.20130305193615.tgz.enc

$ bakthat restore mydir
Restoring mydir.20130305193615.tgz.enc
Password: 
Downloading...
Decrypting...
Uncompressing...

$ bakthat delete mydir.20130305193615.tgz.enc
Deleting mydir.20130305193615.tgz.enc

Bakthat Python API

import logging
import sh
logging.basicConfig(level=logging.INFO)

from bakthat.helper import BakHelper

BACKUP_NAME = "myhost_mysql"
BACKUP_PASSWORD = "mypassword"
MYSQL_USER = "root"
MYSQL_PASSWORD = "mypassword"

with BakHelper(BACKUP_NAME, password=BACKUP_PASSWORD, tags=["mysql"]) as bh:
    sh.mysqldump("-p{0}".format(MYSQL_PASSWORD),
                u=MYSQL_USER,
                all_databases=True,
                _out="dump.sql")
    bh.backup()
    bh.rotate()

Changelog

0.4.4

Mars 10 2013

  • bugfix (forgot to remove a dumptruck import)

0.4.3

Mars 10 2013

  • bakthat show bugfix

0.4.2

Mars 10 2013

  • Using peewee instead of dumptruck, should be Python2.6 compatible again.

0.4.1

Mars 8 2013

  • small bugfix when restoring from glacier
  • bakhelper now support custom configuration and profiles
  • aligned date in show command

0.4.0

If you come from bakthat 0.3.x, you need to run:

$ bakthat upgrade_to_dump_truck

And you also need to run again bakthat configure.

$ cat ~/.bakthat.conf
$ bakthat configure

Changes:

  • The filename is now a positional argument for all command
  • Using DumpTruck instead of shelve
  • Save backups metadata for both backends
  • BakHelper to help build backup scripts
  • BakSyncer to help keep you list sync over a custom REST API
  • Now adding a dot between the original filename and the date component
  • Tags support (-t/--tags argument)
  • Profiles support (-p/--profile argument)
  • New show command, with search support (tags/filename/destination)
  • Hosted documentation

0.3.10 ~~~~~

  • bug fix glacier upload

0.3.9

  • small bug fixes (when updating an existing configuration)

0.3.8

  • Added remove_older_than command
  • Added rotate_backups command (Grandfather-father-son backup rotation scheme)

Contributors

  • Eric Chamberlain
  • Darius Braziunas
  • Sławomir Żak
  • Andreyev Dias de Melo
  • Jake McGraw

License (MIT)

Copyright (c) 2012 Thomas Sileo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Bakthat is a MIT licensed backup framework written in Python, it's both a command line tool and a Python module that helps you manage backups on Amazon S3/Glacier. It automatically compress, encrypt (symmetric encryption) and upload your files.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 94.2%
  • Shell 5.8%