Restic backup Python wrapper
Project description
resticpy
Overview
Minimal Python wrapper around the restic backup command-line interface.
Installation
From pip
pip install resticpy
From source
git clone https://github.com/mtlynch/resticpy.git
cd resticpy
pip install .
Quick start
Create a password file
printf "mysecretpass" > password.txt
Initialize a repository and back up a file
import restic
restic.repository = '/tmp/backup1'
restic.password_file = 'password.txt'
restic.init()
restic.backup(paths=['some-file.txt'])
Restore a snapshot
import restic
restic.repository = '/tmp/backup1'
restic.password_file = 'password.txt'
restic.restore(snapshot_id='latest', target_dir='~/restored')
API Documentation
https://mtlynch.github.io/resticpy/
Example
I personally use this library for my backups. I've published my backup script at mtlynch/mtlynch-backup.
Compatibility
resticpy is tested against restic 0.16.2.
resticpy's scope and future
resticpy is maintained by Michael Lynch as a hobby project.
resticpy is not meant to achieve feature parity with restic. It is meant to cover a small subset of the most useful features of restic.
Due to time limitations, I keep resticpy's scope limited to only the features that fit into my workflows.
Feature requests
I don't fulfill feature requests for resticpy. You are welcome to file a feature request for a third-party contributor to take on.
Pull requests
I accept pull requests when they are:
- Documented
- Tested
- Small
I don't accept pull requests for features that look like they'll be a large maintenance burden.
Acknowledgments
This project is forked from jstzwj/PyRestic.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.