Version bump

.gitignore

@@ -1 +1,2 @@
 .idea/
+test/

PKGBUILD

@@ -1,31 +1,47 @@
-#Arch Linux PKGBUILD
+# PKGBUILD
-#
+
-#Maintainer: Daniele Fucini <dfucini@gmail.com>
+# Maintainer: Daniele Fucini <dfucini@gmail.com>
-#
 
 pkgname=simple_backup
-pkgver=2.0.0.r3.gc61c704
+pkgver=3.2.3.r1.ga42ade4
 pkgrel=1
 pkgdesc='Simple backup script that uses rsync to copy files'
 arch=('any')
 url="https://github.com/Fuxino/simple_backup.git"
 license=('GPL3')
-makedepends=('git')
+makedepends=('git'
-depends=('python3'
+             'python-setuptools'
+             'python-build'
+             'python-installer'
+             'python-wheel')
+depends=('python'
          'rsync'
          'python-dotenv')
+optdepends=('python-systemd: use systemd log')
 install=${pkgname}.install
 source=(git+https://github.com/Fuxino/${pkgname}.git)
 sha256sums=('SKIP')
 
 pkgver() 
 {  
-   cd "$pkgname"
+   cd ${pkgname}
    git describe --long --tags | sed 's/\([^-]*-g\)/r\1/;s/-/./g'
 }
 
+prepare()
+{
+   git -C ${srcdir}/${pkgname} clean -dfx
+}
+
+build()
+{
+   cd ${srcdir}/${pkgname}
+   python -m build --wheel --no-isolation
+}
+
 package()
 {
-   install -Dm755 "${srcdir}/${pkgname}/${pkgname}.py" "${pkgdir}/usr/bin/${pkgname}"
+   cd ${srcdir}/${pkgname}
-   install -Dm644 "${srcdir}/${pkgname}/${pkgname}.config" "${pkgdir}/etc/${pkgname}/${pkgname}.config"
+   python -m installer --destdir=${pkgdir} dist/*.whl
+   install -Dm644 ${srcdir}/${pkgname}/${pkgname}.conf ${pkgdir}/etc/${pkgname}/${pkgname}.conf
 }

README.md

@@ -1,10 +1,47 @@
-# simple_backup
+simple_backup
+============
 A simple backup script
 
 ## Description
 simple_backup is a Python script that allows you to backup your files.
-It reads from a configuration file the files/directories that must be copied,
+Parameters like input files/directories, output directory etc. can be specified in a configuration file, or on the command line.
-the destination directory for the backup and a few other options.
+Run:
+
+```bash
+simple_backup -h
+```
+
+to print all possible command line options.
 
 ## Dependencies
-rsync is used to perform the backup.  
+The script uses rsync to actually run the backup, so you will have to install it on your system. For example on Arch Linux:
+
+```bash
+sudo pacman -Syu rsync
+```
+
+## Install
+To install the program, first clone the repository:
+
+```bash
+git clone https://github.com/Fuxino/simple_backup.git
+```
+
+Install tools required to build and install the package:
+
+```bash
+pip install --upgrade build installer wheel
+```
+
+Then run:
+
+```bash
+cd simple_backup
+python -m build --wheel
+python -m installer dist/*.whl
+```
+
+For Arch Linux, a PKGBUILD that automates this process is provided.
+
+After installing, copy simple_backup.conf (if you used the PKGBUILD on Arch, it will be in /etc/simple_backup/) to $HOME/.config/simple_backup and edit is as needed.
+

pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ['setuptools']
+build-backend = 'setuptools.build_meta'

requirements.txt

@@ -1 +0,0 @@
-python-dotenv>=1.0.0

setup.cfg

@@ -0,0 +1,33 @@
+[metadata]
+name = simple_backup
+version = attr: simple_backup.__version__
+description = Simple backup script using rsync
+long_description = file: README.md
+author = Daniele Fucini
+author_email = dfucini@gmail.com
+license = GPL3
+url = https://github.com/Fuxino/simple_backup
+classifiers =
+   Development Status :: 5 - Production/Stable
+   Environment :: Console
+   License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+   Natural Language :: English
+   Operating System :: POSIX :: Linux
+   Programming Language :: Python :: 3.7
+   Programming Language :: Python :: 3.8
+   Programming Language :: Python :: 3.9
+   Programming Language :: Python :: 3.10
+   Programming Language :: Python :: 3.11
+   Topic :: System :: Archiving :: Backup
+
+[options]
+packages = simple_backup
+python_requires = >=3.7
+install_requires =
+   python-dotenv
+   systemd-python
+
+[options.entry_points]
+console_scripts =
+   simple_backup = simple_backup.simple_backup:simple_backup
+

simple_backup.install

@@ -1,6 +1,6 @@
 post_install() {
-   echo "An example configuration file is found in /etc/simple_backup/simple_backup.config."
+   echo "An example configuration file is found in /etc/simple_backup/simple_backup.conf."
-   echo "Copy it to ~/.simple_backup/simple_backup.config and modify it as needed"
+   echo "Copy it to ~/config/simple_backup/simple_backup.conf and modify it as needed"
 }
 
 post_upgrade() {

simple_backup/__init__.py

@@ -0,0 +1,3 @@
+"""Init."""
+
+__version__ = '3.2.4'

simple_backup/simple_backup.conf

@@ -0,0 +1,14 @@
+#Example config file for simple_backup
+
+[default]
+#Input directories. Use a comma to separate items
+inputs=/home/my_home,/etc
+
+#Output directory
+backup_dir=/media/Backup
+
+#Exclude patterns. Use a comma to separate items
+exclude=.gvfs,.local/share/gvfs-metadata,.cache,.dbus,.Trash,.local/share/Trash,.macromedia,.adobe,.recently-used,.recently-used.xbel,.thumbnails
+
+#Number of snapshots to keep (use -1 to keep all)
+keep=-1

simple_backup/simple_backup.py

@@ -1,7 +1,6 @@
 #!/usr/bin/python3
 
 # Import libraries
-from dotenv import load_dotenv
 import os
 from functools import wraps
 from shutil import rmtree
@@ -9,11 +8,16 @@ import argparse
 import configparser
 import logging
 from logging import StreamHandler
-from logging.handlers import RotatingFileHandler
 from timeit import default_timer
 from subprocess import Popen, PIPE, STDOUT
 from datetime import datetime
 from tempfile import mkstemp
+from dotenv import load_dotenv
+
+try:
+    from systemd import journal
+except ImportError:
+    journal = None
 
 
 load_dotenv()
@@ -29,25 +33,21 @@ logging.getLogger().setLevel(logging.DEBUG)
 logger = logging.getLogger(os.path.basename(__file__))
 c_handler = StreamHandler()
 
-try:
-    f_handler = RotatingFileHandler(f'{homedir}/.simple_backup/simple_backup.log', maxBytes=1024000, backupCount=5)
-except Exception:
-    f_handler = None
-
 c_handler.setLevel(logging.INFO)
 c_format = logging.Formatter('%(name)s - %(levelname)s - %(message)s')
 c_handler.setFormatter(c_format)
 logger.addHandler(c_handler)
 
-if f_handler:
+if journal:
-    f_handler.setLevel(logging.INFO)
+    j_handler = journal.JournalHandler()
-    f_format = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+    j_handler.setLevel(logging.INFO)
-    f_handler.setFormatter(f_format)
+    j_format = logging.Formatter('%(levelname)s - %(message)s')
-    logger.addHandler(f_handler)
+    j_handler.setFormatter(j_format)
+    logger.addHandler(j_handler)
 
 
 def timing(_logger):
-    def decorater_timing(func):
+    def decorator_timing(func):
         @wraps(func)
         def wrapper_timing(*args, **kwargs):
             start = default_timer()
@@ -62,7 +62,7 @@ def timing(_logger):
 
         return wrapper_timing
 
-    return decorater_timing
+    return decorator_timing
 
 
 class MyFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter):
@@ -71,12 +71,13 @@ class MyFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFo
 
 class Backup:
 
-    def __init__(self, inputs, output, exclude, keep, options):
+    def __init__(self, inputs, output, exclude, keep, options, remove_before=False):
         self.inputs = inputs
         self.output = output
         self.exclude = exclude
         self.options = options
         self.keep = keep
+        self.remove_before = remove_before
         self._last_backup = ''
         self._output_dir = ''
         self._inputs_path = ''
@@ -89,22 +90,18 @@ class Backup:
 
             return False
 
-        for i in self.inputs:
+        if self.output is None:
-            if os.path.islink(i):
+            logger.critical('No output path specified. Use -o argument or specify output path in configuration file')
-                try:
+
-                    i_new = os.readlink(i)
+            return False
-                    logger.info(f'Input {i} is a symbolic link referencing {i_new}. Copying {i_new} instead')
-                    self.inputs.remove(i)
-                    self.inputs.append(i_new)
-                except Exception:
-                    logger.warning(f'Input {i} is a link and cannot be read. Skipping')
-                    self.inputs.remove(i)
 
         if not os.path.isdir(self.output):
             logger.critical('Output path for backup does not exist')
 
             return False
 
+        self.output = os.path.abspath(self.output)
+
         if self.keep is None:
             self.keep = -1
 
@@ -120,15 +117,14 @@ class Backup:
     def remove_old_backups(self):
         try:
             dirs = os.listdir(f'{self.output}/simple_backup')
-        except Exception:
+        except FileNotFoundError:
-            logger.info('No older backups to remove')
-
             return
 
         if dirs.count('last_backup') > 0:
             dirs.remove('last_backup')
 
         n_backup = len(dirs) - 1
+        count = 0
 
         if n_backup > self.keep:
             logger.info('Removing old backups...')
@@ -137,15 +133,27 @@ class Backup:
             for i in range(n_backup - self.keep):
                 try:
                     rmtree(f'{self.output}/simple_backup/{dirs[i]}')
-                except Exception:
+                    count += 1
-                    logger.error(f'Error while removing backup {dirs[i]}')
+                except FileNotFoundError:
+                    logger.error(f'Error while removing backup {dirs[i]}. Directory not found')
+                except PermissionError:
+                    logger.error(f'Error while removing backup {dirs[i]}. Permission denied')
+
+            if count == 1:
+                logger.info(f'Removed {count} backup')
+            else:
+                logger.info(f'Removed {count} backups')
 
     def find_last_backup(self):
         if os.path.islink(f'{self.output}/simple_backup/last_backup'):
-            try:
+            link = os.readlink(f'{self.output}/simple_backup/last_backup')
-                self._last_backup = os.readlink(f'{self.output}/simple_backup/last_backup')
+
-            except Exception:
+            if os.path.isdir(link):
-                logger.error('Previous backup could not be read')
+                self._last_backup = link
+            else:
+                logger.info('No previous backups available')
+        else:
+            logger.info('No previous backups available')
 
     # Function to read configuration file
     @timing(logger)
@@ -155,15 +163,8 @@ class Backup:
         self.create_backup_dir()
         self.find_last_backup()
 
-        if os.path.islink(f'{self.output}/simple_backup/last_backup'):
+        _, self._inputs_path = mkstemp(prefix='tmp_inputs', text=True)
-            try:
+        _, self._exclude_path = mkstemp(prefix='tmp_exclude', text=True)
-                os.remove(f'{self.output}/simple_backup/last_backup')
-            except Exception:
-                logger.error('Failed to remove last_backup link')
-                self._err_flag = True
-
-        inputs_handle, self._inputs_path = mkstemp(prefix='tmp_inputs', text=True)
-        exclude_handle, self._exclude_path = mkstemp(prefix='tmp_exclude', text=True)
 
         with open(self._inputs_path, 'w') as fp:
             for i in self.inputs:
@@ -178,6 +179,9 @@ class Backup:
                 fp.write(e)
                 fp.write('\n')
 
+        if self.keep != -1 and self.remove_before:
+            self.remove_old_backups()
+
         logger.info('Copying files. This may take a long time...')
 
         if self._last_backup == '':
@@ -192,15 +196,34 @@ class Backup:
         p = Popen(rsync, stdout=PIPE, stderr=STDOUT, shell=True)
         output, _ = p.communicate()
 
-        logger.info(f'Output of rsync command: {output.decode("utf-8")}')
+        if p.returncode != 0:
-
-        try:
-            os.symlink(self._output_dir, f'{self.output}/simple_backup/last_backup')
-        except Exception:
-            logger.error('Failed to create last_backup link')
             self._err_flag = True
 
-        if self.keep != -1:
+        output = output.decode("utf-8").split('\n')
+
+        logger.info(f'rsync: {output[-3]}')
+        logger.info(f'rsync: {output[-2]}')
+
+        if os.path.islink(f'{self.output}/simple_backup/last_backup'):
+            try:
+                os.remove(f'{self.output}/simple_backup/last_backup')
+            except FileNotFoundError:
+                logger.error('Failed to remove last_backup link. File not found')
+                self._err_flag = True
+            except PermissionError:
+                logger.error('Failed to remove last_backup link. Permission denied')
+                self._err_flag = True
+
+        try:
+            os.symlink(self._output_dir, f'{self.output}/simple_backup/last_backup', target_is_directory=True)
+        except FileExistsError:
+            logger.error('Failed to create last_backup link. Link already exists')
+            self._err_flag = True
+        except PermissionError:
+            logger.error('Failed to create last_backup link. Permission denied')
+            self._err_flag = True
+
+        if self.keep != -1 and not self.remove_before:
             self.remove_old_backups()
 
         os.remove(self._inputs_path)
@@ -214,11 +237,11 @@ class Backup:
 
 def _parse_arguments():
     parser = argparse.ArgumentParser(prog='simple_backup',
-                                     description='A simple backup script written in Python that uses rsync to copy files',
+                                     description='Simple backup script written in Python that uses rsync to copy files',
                                      epilog='Report bugs to dfucini<at>gmail<dot>com',
                                      formatter_class=MyFormatter)
 
-    parser.add_argument('-c', '--config', default=f'{homedir}/.simple_backup/simple_backup.config',
+    parser.add_argument('-c', '--config', default=f'{homedir}/.config/simple_backup/simple_backup.conf',
                         help='Specify location of configuration file')
     parser.add_argument('-i', '--input', nargs='+', help='Paths/files to backup')
     parser.add_argument('-o', '--output', help='Output directory for the backup')
@@ -226,6 +249,8 @@ def _parse_arguments():
     parser.add_argument('-k', '--keep', type=int, help='Number of old backups to keep')
     parser.add_argument('-s', '--checksum', action='store_true',
                         help='Use checksum rsync option to compare files (MUCH SLOWER)')
+    parser.add_argument('--remove-before-backup', action='store_true',
+                        help='Remove old backups before executing the backup, instead of after')
 
     args = parser.parse_args()
 
@@ -272,11 +297,15 @@ def simple_backup():
     else:
         backup_options = '-arvh -H -X'
 
-    backup = Backup(inputs, output, exclude, keep, backup_options)
+    backup = Backup(inputs, output, exclude, keep, backup_options, remove_before=args.remove_before_backup)
 
     if backup.check_params():
         backup.run()
 
+        return 0
+
+    return 1
+
 
 if __name__ == '__main__':
     simple_backup()