You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Andreas Zweili ef34b194a0 add my notes to the repo 3 years ago
borg_qt move the startpoint into its own function 4 years ago
docs add my notes to the repo 3 years ago
scripts add a script to help with testing the application 4 years ago
tests remove the context file 4 years ago
.gitignore ignore pytest and visual studio code directories 4 years ago
LICENSE Initial commit 4 years ago add a manifest 4 years ago
Makefile install borg-qt as an editable package in make init 4 years ago extend the installation to include the pip package 4 years ago
requirements.txt add pytest-cov plugin to the requirements 4 years ago make the version number pypi compatible 4 years ago


Borg-Qt is a Python 3 based graphical frontend for the backup tool BorgBackup as its name implies it is using the Qt5 Framework. Currently it works only on Linux.


I think Borg is a great backup tool which should be available to many more users. Since command line tools can be a bit scary for less experienced users I decided to write a GUI as my "thesis" during my final semester at the IBZ school in Aarau, Switzerland.

Getting Started

These instructions will get you a copy of the project up and running on your local machine.


You need to have Borg installed in order to have Borg-Qt working. You can get a binary for your operating system here:

On a Debian based system you can install it by copying to ~/.local/bin/. Borg needs to be able to get executed by calling the command borg.

cp ~/Downloads/borg-linux64 ~/.local/bin/borg
chmod +x ~/.local/bin/borg

For other systems check their documenation.


  1. Installing Borg-Qt is very simple. Download the binary for your operating system here: or install it with pip:
pip3 install borg-qt
  1. Copy the config file from docs/borg_qt.conf.example to ~/.config/borg_qt/borg_qt.conf and edit it to contain a valid path to your BorgBackup repository and the password. Put all your changes into the [borgqt] section. As of now there is no automated way to setup Borg-Qt.

  2. Run the binary by double clicking on it or by copying it to ~/.local/bin/ like Borg. If you do that you might want to create a desktop file for it. Puth the following code into a borg-qt.desktop file in ~/.local/share/applications/.

[Desktop Entry]

Make sure the file is executable:

chmod +x ~/.local/share/applications/borg-qt.desktop

Now you should find Borg-Qt in your desktop's start menu.

If you installed Borg-Qt with pip you can either run borg_qt from the command line or edit the desktop file to exec borg_qt instead of the full path.


To start working on Borg-Qt first clone the git repository and install BorgBackup as described in [Prerequisites].

git clone

Now create a virtual environment.

cd borg-qt
python3 -m venv venv

And activate it.

source venv/bin/activate

Finally you can install Borg-Qt and it's dependencies.

pip3 install -e .

You're now all set to work on Borg-Qt. It's a good idea to run the tests before starting. You can do this with the following command from the root of the repository.

make test

To make testing the application while programming a bit easier there's a script which reloads the application everytime a file changes in the borg_qt directory. You to use it run the following command from the root of the repository.



To have a look at all the planned tasks you can have a look at the planned features here:

Used packages


Everyone is welcome to submit pull requests and reports issues. Please follow PEP8 and remove unnecessary white space when you contribute code. And most importantly make sure that you don't break any tests and if possible write tests for your code.


Currently there is no versioning as such. In the future a versioning scheme based on semantic versioning might get used. The master branch is considered to be the stable branch. Other branches might be highly experimental.



This project is licensed under the GPLv3 License - see the file for details.