Package: borg-qt
Borg-QtBorg-Qt is a Python 3 based graphical frontend for the backup toolBorgBackupas its name implies it is
using the Qt5 Framework. Currently it works only on Linux.MotivationI 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 StartedThese instructions will get you a copy of the project up and running on your
local machine.PrerequisitesYou need to have Borg installed in order to have Borg-Qt working. You can get a
binary for your operating system here:https://github.com/borgbackup/borg/releasesOn a Debian based system you can install it by copying to~/.local/bin/. Borg
needs to be able to get executed by calling the commandborg.cp~/Downloads/borg-linux64~/.local/bin/borg
chmod+x~/.local/bin/borgFor other systems check theirdocumenation.InstallingInstalling Borg-Qt is very simple. Download the binary for your operating
system here:https://github.com/borgqt/borg-qt/releasesor install it with pip:pip3installborg-qtCopy the config file fromdocs/borg_qt.conf.exampleto~/.config/borg_qt/borg_qt.confand 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.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 aborg-qt.desktopfile in~/.local/share/applications/.[Desktop Entry]
Version=1.0
Name=Borg-Qt
Exec=/home/username/.local/bin/borg-qt
Terminal=false
Type=Application
Categories=Tools
MimeType=x-scheme-handler/tg;Make sure the file is executable:chmod+x~/.local/share/applications/borg-qt.desktopNow you should find Borg-Qt in your desktop's start menu.If you installed Borg-Qt with pip you can either runborg_qtfrom the
command line or edit the desktop file to execborg_qtinstead of the full
path.DevelopmentTo start working on Borg-Qt first clone the git repository and install
BorgBackup as described in [Prerequisites].gitclonehttps://github.com/borg-qt/borg-qt.gitNow create a virtual environment.cdborg-qt
python3-mvenvvenvAnd activate it.sourcevenv/bin/activateFinally you can install Borg-Qt and it's dependencies.pip3install-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.maketestTo make testing the application while programming a bit easier there's a script
which reloads the application everytime a file changes in theborg_qtdirectory. You to use it run the following command from the root of the
repository../scripts/debugging.shToDosTo have a look at all the planned tasks you can have a look at the planned
features here:todos.mdUsed packagesPyQt5- the GUI frameworkPyInstaller- used for
creating the binarypytest- used for testingpytest-cov- used for
coverage analysisContributingEveryone 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.VersioningCurrently there is no versioning as such. In the future a versioning scheme
based onsemantic versioningmight get used. The master
branch is considered to be the stable branch. Other branches might be highly
experimental.AuthorsAndreas Zweili -Initial work-NebucatnetzerLicenseThis project is licensed under the GPLv3 License - see the  file
for details.AcknowledgmentsThanks to PurpleBooth for herREADME
template.Thanks toBack in Timefor the
inspiration.Thanks toFeather Iconsfor their
great icon set.Thanks toKenneth Reitzfor the
example repo for setup.py