Open-sourced Python library for Borg

[WilliamDEdwards]

We open-sourced our Python library for Borg: https://github.com/CyberfusionNL/python3-cyberfusion-borg-support. We hope it's of use to Borg users.

Features:

• Supports almost all Borg commands.
• Restores to existing directories (not supported by Borg natively).
• Ability to follow progress (includes parser for output of --progress).
• Installable as Debian package (includes source), and from PyPI.
• 100% test coverage.

[ThomasWaldmann]

Thanks for open-sourcing it!

Can you say what you mean by Fully automatic local archive restores (not supported by Borg natively).?

For parsing --progress output, do you use the json mode?

[WilliamDEdwards]

Can you say what you mean by Fully automatic local archive restores (not supported by Borg natively).?

When calling ArchiveRestoration.replace, the given path is reverted to exactly the state in the archive.

This is not natively supported by Borg (source: https://github.com/borgbackup/borg/blob/master/docs/quickstart.rst#restoring-a-backup). For example, when calling borg extract, extraneous files are not deleted.

For the code, please see cyberfusion.BorgSupport.archives.ArchiveRestoration.

For parsing --progress output, do you use the json mode?

Yes, we use --progress and --log-json.

We then write stderr to a file rather than to subprocess.PIPE, as output can be extremely large (most notably when borg check complains).

For the code, please see cyberfusion.BorgSupport.operations.

[ThomasWaldmann]

Ok, thanks for the clarification. Maybe rather write "archive restores to non-empty destination paths (not supported by borg natively)"?

[WilliamDEdwards]

Updated. Thank you for your suggestion.

[FelixSchwarz]

Thank you for open sourcing the library. I guess it would be used more often if your github readme listed at least some functionality of the library and maybe one or two full examples what you can achieve by using the library :-)