makes both dbus and gobject optional

Author: tadly

README.md

@@ -28,18 +28,19 @@ See [deployment](#deployment) for notes on how to deploy dups on a live system.
 ### Prerequisites
 Required system packages:
 ```
-dbus
 rsync
 ```
 
 Required python packages:
 ```
 # Runtime
-dbus-python
 paramiko
-pygobject
 ruamel.yaml>=0.15.0
 
+# Runtime (Optional)
+dbus-python  # Daemon support
+pygobject  # Desktop notification support
+
 # Unittests
 ddt
 ```

data/pkg/archlinux/PKGBUILD

@@ -6,8 +6,9 @@ pkgdesc="It deduplicates things - Backup as simple as possible."
 arch=("x86_64")
 url="https://github.com/linuxwhatelse/dups"
 license=('GPL3')
-depends=('python' 'rsync' 'dbus' 'python-gobject' 'python-dbus'
-         'python-paramiko' 'python-ruamel-yaml')
+depends=('python' 'rsync' 'python-paramiko' 'python-ruamel-yaml')
+optdepends=('python-dbus: Daemon support'
+            'python-gobject: Desktop notification support')
 makedepends=('python-setuptools')
 provides=("${_pkgname}")
 source=("${_pkgname}::git+https://github.com/linuxwhatelse/dups.git")
@@ -35,4 +36,3 @@ package() {
 
 
 # vim: set syntax=sh:
-

data/pkg/archlinux/python-dups.install

@@ -1,22 +1,27 @@
 post_install() {
     echo "---"
-    echo "Reload user units with:"
+    echo "Start user unit with:"
     echo "  systemctl --user daemon-reload"
-    echo ""
-    echo "Start dups with:"
     echo "  systemctl --user start dups"
     echo ""
+    echo "Start system unit with:"
+    echo "  sudo systemctl daemon-reload"
+    echo "  sudo systemctl start dups@<USERNAME>"
+    echo ""
     echo "To automatically start dups after login:"
     echo "  systemctl --user enable dups"
+    echo "  sudo systemctl enable dups@<USERNAME>"
     echo "---"
 }
 
 post_upgrade() {
     echo "---"
-    echo ""
-    echo "Restart dups with:"
+    echo "Restart user unit with:"
     echo "  systemctl --user daemon-reload"
     echo "  systemctl --user restart dups"
     echo ""
+    echo "Restart system unit with:"
+    echo "  sudo systemctl daemon-reload"
+    echo "  sudo systemctl restart dups@<USERNAME>"
     echo "---"
 }

data/pkg/debian/stdeb.cfg

@@ -1,6 +1,5 @@
 [DEFAULT]
-Depends3: rsync, dbus, python3-gi, libdbus-1-dev, python3-dbus,
-          python3-paramiko, python3-ruamel.yaml
-Suggests3: anacron
+Depends3: rsync, python3-paramiko, python3-ruamel.yaml
+Suggests3: python3-dbus, python3-gi, anacron
 X-Python3-Version: >= 3.5
 Setup-Env-Vars: INCLUDE_DATA_FILES=systemd dbus desktop

dependencies.txt

@@ -1,2 +1 @@
-dbus
 rsync

dups/__main__.py

@@ -3,9 +3,14 @@
 import logging
 import sys
 
-import dbus
+from . import const, helper, user, utils
 
-from . import const, daemon, helper, user, utils
+try:
+    import dbus
+    from . import daemon
+except ImportError:
+    dbus = None
+    daemon = None
 
 LOGGER = logging.getLogger(__name__)
 
@@ -275,10 +280,28 @@ def handle_management(args, cfg):
         cfg.remove_excludes(args.remove_excludes)
 
 
+def is_dbus_required(args):
+    if any((args.daemon, args.system_daemon)):
+        return True
+
+    if 'background' in args and args.background:
+        return True
+
+    if 'system_background' in args and args.system_background:
+        return True
+
+    return False
+
+
 def main():
     """Entrypoint for dups."""
     args = parse_args()
 
+    if is_dbus_required(args) and dbus is None:
+        print('To use any of the daemon functionality, "dbus-python" '
+              'is required.')
+        sys.exit(1)
+
     try:
         usr = user.User(args.user)
     except ValueError as e:

dups/helper.py

@@ -6,12 +6,19 @@
 from contextlib import contextmanager
 from typing import Tuple
 
-import dbus
 import paramiko
 import ruamel.yaml
 
 from . import backup, config, const, exceptions, rsync, user, utils
 
+try:
+    from dbus.exceptions import DBusException
+except ImportError:
+
+    class DBusException(Exception):
+        pass
+
+
 LOGGER = logging.getLogger(__name__)
 
 
@@ -133,7 +140,7 @@ def error_handler(callback, *args, **kwargs):
     except (KeyError, socket.gaierror):
         error_msg = 'Could not connect to host.'
 
-    except dbus.exceptions.DBusException:
+    except DBusException:
         LOGGER.debug(traceback.format_exc())
         error_msg = 'Unable to connect to daemon. Is one running?'
 
@@ -167,7 +174,10 @@ def notify(title, body=None, priority=None, icon=const.APP_ICON):
     if not cfg.notify:
         return
 
-    utils.notify(const.APP_ID, title, body, priority, icon)
+    try:
+        utils.notify(const.APP_ID, title, body, priority, icon)
+    except RuntimeError as e:
+        LOGGER.warning(str(e))
 
 
 def get_backups(include_valid=True, include_invalid=True):

dups/utils.py

@@ -11,18 +11,19 @@
 from typing import TypeVar
 
 import paramiko
-from gi.repository import Gio
 
 from . import config
 
+try:
+    from gi.repository import Gio
+except ImportError:
+    Gio = None
+
 _IO = TypeVar('_IO', bound='IO')
 
 
 class NPriority:
-    NORMAL = Gio.NotificationPriority.NORMAL
-    LOW = Gio.NotificationPriority.LOW
-    HIGH = Gio.NotificationPriority.HIGH
-    URGENT = Gio.NotificationPriority.URGENT
+    NORMAL, LOW, HIGH, URGENT = 0, 1, 2, 3
 
 
 def confirm(msg, default_yes=False):
@@ -86,7 +87,13 @@ def notify(app_id, title, body=None, priority=None, icon=None):
         body (str): The notifications body.
         priority (NPriority): The notifications priority level.
         icon (str): Name or path of the notifications icon.
+
+    Raises:
+        RuntimeError: If pygobject is missing.
     """
+    if Gio is None:
+        raise RuntimeError('"pygobject" required but not available.')
+
     app = Gio.Application.new(app_id, Gio.ApplicationFlags.FLAGS_NONE)
     app.register()
 

requirements.txt

@@ -1,8 +1,10 @@
 # Runtime
-dbus-python
 paramiko
-pygobject
 ruamel.yaml>=0.15.0
 
+# Runtime (Optional)
+dbus-python  # Daemon support
+pygobject  # Desktop notification support
+
 # Unittests
 ddt

setup.py

@@ -2,22 +2,6 @@
 
 from setuptools import find_packages, setup
 
-HERE = os.path.dirname(os.path.realpath(__file__))
-
-
-def get_requirements():
-    requirements = []
-    with open(os.path.join(HERE, 'requirements.txt'), 'r') as f:
-        for line in f.readlines():
-            line = line.strip()
-            if not line or line.startswith('#'):
-                if line.lstrip('#').strip().lower().startswith('unittests'):
-                    break
-                continue
-            requirements.append(line)
-
-    return requirements
-
 
 def get_data_files():
     include_data_files = os.environ.get('INCLUDE_DATA_FILES', '').split(' ')
@@ -67,6 +51,10 @@ def get_data_files():
     ]},
     data_files=get_data_files(),
     scripts=['data/bin/dups'],
-    install_requires=get_requirements(),
+    install_requires=['paramiko', 'ruamel.yaml>=0.15.0'],
+    extras_require={
+        'daemon': ['dbus-python'],
+        'notification': ['pygobject']
+    },
     zip_safe=False,
 )