Skip to main content

resticpy

PyPI CircleCI Coverage Status License

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.17.1.

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.

Metadata

Release files for resticpy 1.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for resticpy 1.3.0
File Size Uploaded
resticpy-1.3.0.tar.gz 16.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for resticpy 1.3.0
File Interpreter ABI Platform
resticpy-1.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 43.7 kB

Release files / resticpy-1.3.0.tar.gz

Download URL resticpy-1.3.0.tar.gz
Size 16.8 kB
Tags Source
SHA-256 checksum
How to use checksums
b63eb3b45e45386b2a1d21519550cbc3ebcf36b2a0420db7fbd3055b1fb5464b
BLAKE2b-256 checksum
How to use checksums
b369cb549be36e32ac82315d983da61d5de3b41a3c63c123f7e39448df40c4fe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.1

Release files / resticpy-1.3.0-py3-none-any.whl

Download URL resticpy-1.3.0-py3-none-any.whl
Size 26.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
81c114dfa1547a0285dfd7c9d4290f025d4d4762900b00286af469729d12cf57
BLAKE2b-256 checksum
How to use checksums
3d8c8e81026ca917e30439150c6508b0a8e2c4560d532aad97d0e8eab6bb4ef4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.1

Release history Release notifications | RSS feed

This release

1.3.0 This release

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page