Skip to main content

borgini

License PyPI CI pre-commit.ci status CodeQL codecov.io readthedocs.org python3.8 Black pylint

ini config for borg backup

A wrapper to quickly get you started backing up with borg

An easy to use ini style and profile based format

Requires:

  • Python 3 >= 3.5.0, plus development headers

  • OpenSSL >= 1.0.0, plus development headers

  • libacl (which depends on libattr), both plus development headers

  • liblz4 >= 1.7.0 (r129)

  • libzstd >= 1.3.0

  • libb2

For information on how to install these dependencies for Borg: https://borgbackup.readthedocs.io/en/stable/installation.html

Initialize the config

$ borgini
First run detected for profile: default
Make all necessary changes to config before running this again
You can do this by running the command:

. borgini EDITOR --config --select default

Default settings have been written to the ``include`` and ``exclude`` lists
These can be edited by running:

. borgini EDITOR --include --select default
. borgini EDITOR --exclude --select default

Edit the config

$ borgini vim --config
$ borgini code --config
$ borgini gedit --config
$ borgini notepad --config

Ensure to make necessary changes to the DEFAULT section

And ensure to configure the SSH section if an ssh repo is configured

The remaining configurations will suite most people

If you use the BORG_PASSPHRASE environment variable edit the ENVIRONMENT section to point to the keyfile

Edit the include and exclude files

$ borgini vim --include  # add a list of paths to back up
$ borgini vim --exclude  # add a list of paths to exclude

To switch between profiles add --select PROFILE

$ borgini vim --config  # edit default config
$ borgini vim --config --select profile2  # edit profile2's config
$ borgini vim --include --select profile2  # edit profile2's include file
$ borgini vim --exclude --select profile2  # edit profile2's exclude file
$ borgini --select profile2  # run profile2's backup

Add the following for nightly backups at 12:00 to your crontab

$ 0 0 * * * /usr/local/bin/borgini
$ 0 0 * * * /usr/local/bin/borgini -s profile2  # easy for multiple repos

Metadata

Release files for borgini 1.2.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 borgini 1.2.0
File Size Uploaded Provenance Actions
borgini-1.2.0.tar.gz 16.9 kB Without provenance Details for borgini-1.2.0.tar.gz

Built distribution (wheel)

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

Total release size: 34.5 kB

Release files / borgini-1.2.0.tar.gz

Download URL borgini-1.2.0.tar.gz
Size 16.9 kB
Tags Source
SHA-256 checksum
How to use checksums
7d45cd5b1fac5396edb5955f1adfc140cb0140c0437177ba5aa06bb8f81f1952
BLAKE2b-256 checksum
How to use checksums
5d6f9b63d90dc78ac5353e7e16cd99c71e71b5848a9b9a33c62bf44941c16b47
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.2.1 CPython/3.8.13 Darwin/22.2.0

Release files / borgini-1.2.0-py3-none-any.whl

Download URL borgini-1.2.0-py3-none-any.whl
Size 17.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b265c2e7c9d4ca785198ae2d2abc962b5483a545f086cb99554bd9a85dfe1a08
BLAKE2b-256 checksum
How to use checksums
d3f359f9038829b1e6e26e25920bafa8d2fb92c24b6522669fa38d1cff674b58
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.2.1 CPython/3.8.13 Darwin/22.2.0

Security for borgini 1.2.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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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