Skip to main content

restic-profile

English | 简体中文

GitHub Actions Workflow Status PyPI - Version Docs

Profile-based restic wrapper, deployed with Ansible.

This repository is an Ansible collection (ak1ra_lab.restic_profile) plus the restic-profile CLI it installs:

  • restic-profile - reads a TOML config and runs restic backup / forget / prune with hooks and IM notifications.
  • restic_profile role - deploys the CLI, renders the TOML config, and manages one systemd timer per profile (including user-level systemd_scope: user).
  • restic_rest_server role - deploys a rest-server instance for remote backup storage.

Install the CLI

Install the CLI on its own - Ansible, root, and systemd are not needed. restic must be installed and on PATH:

uv tool install restic-profile-cli
restic-profile --help

Start from the TOML config template.

Deploy with Ansible

git clone https://github.com/ak1ra-lab/restic-profile.git
cd restic-profile
ansible-galaxy collection install -r requirements.yaml -p ./.ansible/collections
ansible-galaxy collection install --force --collections-path .ansible/collections .

Pick an example from Ansible examples, fill in your host_vars, and run the playbook. See Ansible toolchain for the control-node setup; building restic from source (restic_profile_restic_install_source: go_build) also needs a go toolchain.

Documentation

Full documentation: https://ak1ra-lab.github.io/restic-profile/

Development

uv sync --group dev
just lint
just typecheck
just test

See AGENTS.md for the Ansible, Molecule, and documentation workflow.

Metadata

Release files for restic-profile-cli 0.5.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 restic-profile-cli 0.5.0
File Size Uploaded Provenance Actions
restic_profile_cli-0.5.0.tar.gz 224.4 kB With provenance Details for restic_profile_cli-0.5.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for restic-profile-cli 0.5.0
File Interpreter ABI Platform Actions
restic_profile_cli-0.5.0-py3-none-any.whl Python 3 none any Details for restic_profile_cli-0.5.0-py3-none-any.whl

Total release size: 244.0 kB

Release files / restic_profile_cli-0.5.0.tar.gz

Download URL restic_profile_cli-0.5.0.tar.gz
Size 224.4 kB
Tags Source
SHA-256 checksum
How to use checksums
050e570a8b7419ca2e73fc1b330d4f291ea01355eb08b02a36335419163df671
BLAKE2b-256 checksum
How to use checksums
733be8dee0e8b9c510dc093c464df0c8db79e31336c64efdef8ca8ab07697455
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.

Transparency log

Release files / restic_profile_cli-0.5.0-py3-none-any.whl

Download URL restic_profile_cli-0.5.0-py3-none-any.whl
Size 19.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
472481696ee8778df55874ab151d739b4083dd280007f627de9f287a7b1de398
BLAKE2b-256 checksum
How to use checksums
4dd894719ec8cd45e43b927dc6ed15a6cc249b0b6ed1d9571c6bb07662d62ec5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.

Transparency log

Security for restic-profile-cli 0.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for restic_profile_cli-0.5.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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