https://github.com/judahpaul16/python-urbackup
Python wrapper to access and control an UrBackup server
https://github.com/judahpaul16/python-urbackup
api python urbackup wrapper
Last synced: 2 months ago
JSON representation
Python wrapper to access and control an UrBackup server
- Host: GitHub
- URL: https://github.com/judahpaul16/python-urbackup
- Owner: judahpaul16
- License: apache-2.0
- Created: 2024-04-28T03:11:57.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-05-07T05:54:13.000Z (about 1 year ago)
- Last Synced: 2025-04-24T20:18:02.500Z (2 months ago)
- Topics: api, python, urbackup, wrapper
- Language: Python
- Homepage: https://www.urbackup.org
- Size: 83 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Python UrBackup [](https://www.urbackup.org/)
[](https://pypi.org/project/python-urbackup/)
[](https://github.com/judahpaul16/python-urbackup/actions)
[](https://coveralls.io/github/judahpaul16/python-urbackup?branch=master)
[](https://python-urbackup.readthedocs.io/en/latest/?badge=latest)
Python UrBackup is a powerful Python wrapper designed to interact with UrBackup servers. This library allows you to manage backups, restore operations, and monitor the server status programmatically.
*Originally [urbackup-server-web-api-wrapper](https://github.com/uroni/urbackup-server-python-web-api-wrapper)*
## Installation
Install with:
```bash
pip install python-urbackup
```
## Usage
### Initialization
Create an instance of the `urbackup_server` by specifying the server URL, username, and password. Replace `'your_server_url'`, `'your_username'`, and `'your_password'` with your server details:
```python
from urbackup import urbackup_server
server = urbackup_server('your_server_url', 'your_username', 'your_password')
```
### Logging In
To perform any operations, you need to log in:
```python
if server.login():
print("Login successful!")
else:
print("Login failed!")
```
### Getting Client Status
Retrieve the status of a specific client:
```python
client_status = server.get_client_status('client_name')
if client_status:
print(f"Client status: {client_status}")
else:
print("Client not found or access denied.")
```
### Downloading an Installer
To download an installer for a new client, specify the file path and the client's name:
```python
if server.download_installer('path/to/installer', 'new_client_name'):
print("Installer downloaded successfully.")
else:
print("Failed to download installer.")
```
### Starting Backups
You can start different types of backups for a client. Here are examples of starting an incremental file backup and a full file backup:
```python
if server.start_incr_file_backup('client_name'):
print("Incremental file backup started successfully.")
else:
print("Failed to start incremental file backup.")
if server.start_full_file_backup('client_name'):
print("Full file backup started successfully.")
else:
print("Failed to start full file backup.")
```
### Managing Clients
Add a new client to the server:
```python
new_client = server.add_client('new_client_name')
if new_client:
print("New client added:", new_client)
else:
print("Failed to add new client.")
```
List clients with no file backup in the last three days:
```python
import urbackup
import time
import datetime
server = urbackup.urbackup_server("http://127.0.0.1:55414/x", "admin", "foo")
clients = server.get_status()
diff_time = 3*24*60*60 # 3 days
for client in clients:
if client["lastbackup"]=="-" or client["lastbackup"] < time.time() - diff_time:
if client["lastbackup"]=="-" or client["lastbackup"]==0:
lastbackup = "Never"
else:
lastbackup = datetime.datetime.fromtimestamp(client["lastbackup"]).strftime("%x %X")
print("Last file backup at {lastbackup} of client {clientname} is older than three days".format(
lastbackup=lastbackup, clientname=client["name"] ) )
```
For more information, please refer to the [API Reference](https://python-urbackup.readthedocs.io/en/latest/api_reference/).
## UrBackup CLI ![]()
The UrBackup CLI is a command-line interface that allows you to interact with the UrBackup server from a client machine.
*Important Note: For Windows the command-line tool is `urbackupclient_cmd`. Mac and Linux use `urbackupclientctl`.*
CLI options for `urbackupclientctl` and `urbackupclientctl` are as follows:
```sh
USAGE:
urbackupclientctl [--help] [--version] []
Get specific command help with urbackupclientctl --help
urbackupclientctl start
Start an incremental/full image/file backup
urbackupclientctl status
Get current backup status
urbackupclientctl browse
Browse backups and files/folders in backups
urbackupclientctl restore-start
Restore files/folders from backup
urbackupclientctl set-settings
Set backup settings
urbackupclientctl reset-keep
Reset keeping files during incremental backups
urbackupclientctl add-backupdir
Add new directory to backup set
urbackupclientctl list-backupdirs
List directories that are being backed up
urbackupclientctl remove-backupdir
Remove directory from backup set
```
For more information, please refer to the [UrBackup Administration Documentation](https://www.urbackup.org/administration_manual.html).
## Contributing 🤝
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
## License 📃
This project is licensed under the Apache License - see the [LICENSE](LICENSE) file for details.