Python UrBackup ¶

PyPI - Python Version

Python wrapper to interact with UrBackup servers. Manage backups, restore operations, and monitor server status programmatically.

Originally urbackup-server-web-api-wrapper

Features¶

Legacy dict-returning API for backward compatibility
Typed dataclass-returning API with full type hints
Structured exception hierarchy for error handling
MD5 and PBKDF2 authentication support
HTTP basic auth (htpasswd) support

Installation¶

pip install python-urbackup

Requires Python 3.10 or later.

For more detailed setup, see the Getting Started section.

Quick Start¶

from urbackup import urbackup_server

server = urbackup_server("http://127.0.0.1:55414/x", "admin", "password")
if server.login():
    print("Connected!")

For usage examples, visit the Usage section. For the full method listing, see the API Reference.