skilleter-thingy 0.2.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

skilleter_thingy/borger.py

@@ -0,0 +1,273 @@
+#! /usr/bin/env python3
+
+"""
+Wrapper for the borg backup command
+
+Copyright (C) 2018 John Skilleter
+
+TODO: Major tidy-up as this is a translation of a Bash script.
+TODO: Merge with the usb-backup script since both do almost the same job
+TODO: Default configuration file should be named for the hostname
+TODO: Move all configuration data into the configuration file
+"""
+
+################################################################################
+# Imports
+
+import sys
+import os
+import time
+import argparse
+import configparser
+import subprocess
+from pathlib import Path
+
+################################################################################
+# Variables
+
+DEFAULT_CONFIG_FILE = Path('borger.ini')
+
+COMMANDS = ('backup', 'mount', 'umount', 'compact', 'info', 'prune', 'check', 'init')
+
+# TODO: NOT USED
+PRUNE_OPTIONS = [
+    '--keep-within', '7d',
+    '--keep-daily', '30',
+    '--keep-weekly', '26',
+    '--keep-monthly', '24',
+    '--keep-yearly', '10',
+]
+
+################################################################################
+
+def run(args, cmd):
+    """Run a subprocess."""
+
+    if args.debug:
+        cmd_str = ' '.join(cmd)
+        print(f'Running "{cmd_str}"')
+
+    try:
+        return subprocess.run(cmd, check=True)
+    except FileNotFoundError:
+        print('Borg backup is not installed')
+        sys.exit(1)
+
+################################################################################
+
+def borg_backup(args, exclude_list):
+    """Perform a backup."""
+
+    create_options = ['--compression', 'auto,lzma']
+
+    version = time.strftime('%Y-%m-%d-%H:%M:%S')
+
+    print(f'Creating backup version {version}')
+
+    if args.verbose:
+        create_options += ['--list', '--filter=AMC']
+
+    if args.dryrun:
+        create_options.append('--dry-run')
+    else:
+        create_options.append('--stats')
+
+    exclude_opts = []
+
+    if exclude_list:
+        for exclude in exclude_list:
+            exclude_opts += ['--exclude', exclude]
+
+    os.chdir(args.source)
+
+    run(args,
+        ['borg'] + args.options + ['create', f'{str(args.destination)}::{version}', str(args.source)] + create_options +
+        ['--show-rc', '--one-file-system', '--exclude-caches'] + exclude_opts)
+
+################################################################################
+
+def borg_prune(args):
+    """Prune the repo by limiting the number of backups stored."""
+
+    print('Pruning old backups')
+
+    # Keep all backups for at least 7 days, 1 per day for 30 days, 1 per week for 2 years
+    # 1 per month for 4 years and 1 per year for 10 years.
+
+    run(args, ['borg'] + args.options + ['prune', str(args.destination)] + PRUNE_OPTIONS)
+
+################################################################################
+
+def borg_compact(args):
+    """Compact the repo."""
+
+    print('Compacting the backup')
+
+    # Keep all backups for at least 7 days, 1 per day for 30 days, 1 per week for 2 years
+    # 1 per month for 4 years and 1 per year for 10 years.
+
+    run(args, ['borg'] + args.options + ['compact', str(args.destination)])
+
+################################################################################
+
+def borg_info(args):
+    """Info."""
+
+    run(args, ['borg'] + args.options + ['info', str(args.destination)])
+
+################################################################################
+
+def borg_mount(args):
+    """Mount."""
+
+    print(f'Mounting Borg backups at {args.mount_dir}')
+
+    mount = Path(args.mount_dir)
+
+    if not mount.is_dir():
+        mount.mkdir()
+
+    run(args, ['borg'] + args.options + ['mount', str(args.destination), str(mount)])
+
+################################################################################
+
+def borg_umount(args):
+    """Unmount."""
+
+    print('Unmounting {args.mount}')
+
+    run(args, ['borg'] + args.options + ['umount', str(args.mount)])
+
+################################################################################
+
+def borg_check(args):
+    """Check the status of a backup."""
+
+    run(args, ['borg'] + args.options + ['check', str(args.destination)])
+
+################################################################################
+
+def borg_init(args):
+    """Initialise a backup."""
+
+    run(args, ['borg'] + args.options + ['init', str(args.destination), '--encryption=none'])
+
+################################################################################
+
+def process_excludes(exclude_data):
+    """Process the include list from the configuration file."""
+
+    return exclude_data.replace('%', str(Path.cwd())).split('\n')
+
+################################################################################
+
+def main():
+    """Entry point."""
+
+    command_list = ', '.join(COMMANDS)
+
+    parser = argparse.ArgumentParser(description='Wrapper app for Borg backup to make it easier to use')
+    parser.add_argument('--dryrun', '--dry-run', '-D', action='store_true', help='Dry-run comands')
+    parser.add_argument('--debug', '-d', action='store_true', help='Debug')
+    parser.add_argument('--verbose', '-v', action='store_true', help='Verbosity to the maximum')
+    parser.add_argument('--config', '-c', default=None, help='Specify the configuration file')
+    parser.add_argument('commands', nargs='+', help=f'One or more commands ({command_list})')
+    args = parser.parse_args()
+
+    # If no config file specified then look in all the usual places
+
+    if args.config:
+        args.config = Path(args.config)
+    elif DEFAULT_CONFIG_FILE.is_file():
+        args.config = DEFAULT_CONFIG_FILE
+    else:
+        args.config = Path.home() / DEFAULT_CONFIG_FILE
+
+        if not args.config.is_file():
+            args.config = Path(sys.argv[0]).parent / DEFAULT_CONFIG_FILE
+
+    # Check that the configuration file exists
+
+    if not args.config.is_file():
+        print(f'Configuration file "{args.config}" not found')
+        sys.exit(1)
+
+    # Default options
+
+    args.options = []
+
+    # Read the configuration file
+
+    config = configparser.ConfigParser(interpolation=configparser.ExtendedInterpolation())
+    config.read(args.config)
+
+    if 'borger' not in config:
+        print('Invalid configuration file "args.config"')
+        sys.exit(1)
+
+    exclude = process_excludes(config['borger']['exclude']) if 'exclude' in config['borger'] else []
+
+    if 'prune' in config['borger']:
+        # TODO: Stuff
+        print('Parser for the prune option is not implemented yet')
+        sys.exit(1)
+
+    if 'destination' in config['borger']:
+        args.destination = config['borger']['destination']
+    else:
+        print('Destination directory not specified')
+        sys.exit(1)
+
+    if 'source' in config['borger']:
+        args.source = Path(config['borger']['source'])
+    else:
+        print('Source directory not specified')
+        sys.exit(1)
+
+    # Initialise if necessary
+
+    if args.debug:
+        args.options.append('--verbose')
+
+    if args.verbose:
+        args.options.append('--progress')
+
+    # Decide what to do
+
+    for command in args.commands:
+        if command == 'backup':
+            borg_backup(args, exclude)
+        elif command == 'mount':
+            borg_mount(args)
+        elif command == 'umount':
+            borg_umount(args)
+        elif command == 'info':
+            borg_info(args)
+        elif command == 'prune':
+            borg_prune(args)
+        elif command == 'check':
+            borg_check(args)
+        elif command == 'init':
+            borg_init(args)
+        elif command == 'compact':
+            borg_compact(args)
+        else:
+            print(f'Unrecognized command: {command}')
+            sys.exit(2)
+
+################################################################################
+
+def borger():
+    """Entry point"""
+
+    try:
+        main()
+    except KeyboardInterrupt:
+        sys.exit(1)
+    except BrokenPipeError:
+        sys.exit(2)
+
+################################################################################
+
+if __name__ == '__main__':
+    borger()

skilleter_thingy/diskspacecheck.py

@@ -0,0 +1,67 @@
+#! /usr/bin/env python3
+
+################################################################################
+""" Check how much free space is available on all filesystems, ignoring
+    read-only filesystems, /dev and tmpfs.
+
+    Issue a warning if any are above 90% used.
+"""
+################################################################################
+
+import sys
+import argparse
+import psutil
+
+################################################################################
+
+WARNING_LEVEL = 15
+
+################################################################################
+
+def main():
+    """ Do everything """
+
+    parser = argparse.ArgumentParser(description='Check for filesystems that are running low on space')
+    parser.add_argument('--level', action='store', type=int, default=WARNING_LEVEL,
+                        help='Warning if less than this amount of space is available on any writeable, mounted filesystem (default=%d)' % WARNING_LEVEL)
+    args = parser.parse_args()
+
+    if args.level < 0 or args.level > 100:
+        print('Invalid value: %d' % args.level)
+        sys.exit(3)
+
+    disks = psutil.disk_partitions()
+    devices = []
+    warning = []
+
+    for disk in disks:
+        if 'ro' not in disk.opts.split(',') and disk.device not in devices:
+            devices.append(disk.device)
+            usage = psutil.disk_usage(disk.mountpoint)
+
+            disk_space = 100 - usage.percent
+
+            if disk_space < args.level:
+                warning.append('%s has only %2.1f%% space available' % (disk.mountpoint, disk_space))
+
+    if warning:
+        print('Filesystems with less than %d%% available space:' % args.level)
+        print('\n'.join(warning))
+
+################################################################################
+
+def diskspacecheck():
+    """Entry point"""
+
+    try:
+        main()
+
+    except KeyboardInterrupt:
+        sys.exit(1)
+    except BrokenPipeError:
+        sys.exit(2)
+
+################################################################################
+
+if __name__ == '__main__':
+    diskspacecheck()

skilleter_thingy/ggit.py

@@ -7,6 +7,7 @@ import os
 import subprocess
 import argparse
 
+# TODO: Update to git2
 import thingy.git as git
 import thingy.colour as colour
 

skilleter_thingy/ggrep.py

@@ -14,6 +14,7 @@ import sys
 import argparse
 
 import thingy.colour as colour
+# TODO: Update to git2
 import thingy.git as git
 
 ################################################################################

skilleter_thingy/git_br.py

@@ -13,6 +13,7 @@
 """
 ################################################################################
 
+import os
 import sys
 import argparse
 import fnmatch
@@ -21,6 +22,7 @@ import datetime
 from dateutil.parser import parse
 from dateutil.relativedelta import relativedelta
 
+# TODO: Update to git2
 import thingy.git as git
 import thingy.colour as colour
 
@@ -34,10 +36,15 @@ def parse_command_line():
     parser.add_argument('--all', '-a', action='store_true', help='List all branches, including remotes')
     parser.add_argument('--delete', '-d', action='store_true',
                         help='Delete the specified branch(es), even if it is the current one (list of branches to delete must be supplied as parameters)')
+    parser.add_argument('--path', '-C', nargs=1, type=str, default=None,
+                        help='Run the command in the specified directory')
     parser.add_argument('branches', nargs='*', help='Filter the list of branches according to one or more patterns')
 
     args = parser.parse_args()
 
+    if args.path:
+        os.chdir(args.path[0])
+
     if args.delete and not args.branches:
         colour.error('You must specify the branches to delete', prefix=True)
 

skilleter_thingy/git_ca.py

@@ -18,6 +18,7 @@ import sys
 import logging
 
 import thingy.colour as colour
+# TODO: Update to git2
 import thingy.git as git
 
 ################################################################################
@@ -43,6 +44,8 @@ def main():
     parser.add_argument('--patch', '-p', action='store_true', help='Use the interactive patch selection interface to chose which changes to commit.')
     parser.add_argument('--verbose', '-v', action='store_true', help='Verbose mode')
     parser.add_argument('--dry-run', '-D', action='store_true', help='Dry-run')
+    parser.add_argument('--path', '-C', nargs=1, type=str, default=None,
+                        help='Run the command in the specified directory')
 
     parser.add_argument('files', nargs='*', help='List of files to add to the commit')
 
@@ -54,6 +57,11 @@ def main():
         logging.basicConfig(level=logging.INFO)
         logging.info('Debug logging enabled')
 
+    # Change directory, if specified
+
+    if args.path:
+        os.chdir(args.path[0])
+
     # 'Add' implies 'all'
 
     if args.everything:

skilleter_thingy/git_cleanup.py

@@ -9,10 +9,12 @@
 """
 ################################################################################
 
+import os
 import sys
 import argparse
 import logging
 
+# TODO: Update to git2
 import thingy.git as git
 import thingy.colour as colour
 
@@ -38,6 +40,8 @@ def parse_command_line():
     parser.add_argument('--unmerged', '-u', action='store_true', dest='list_unmerged', help='List branches that have NOT been merged')
     parser.add_argument('--yes', '-y', action='store_true', dest='force', help='Assume "yes" in response to any prompts (e.g. to delete branches)')
     parser.add_argument('--debug', action='store_true', help='Enable debug output')
+    parser.add_argument('--path', '-C', nargs=1, type=str, default=None,
+                        help='Run the command in the specified directory')
 
     parser.add_argument('branches', nargs='*', help='List of branches to check (default is all branches)')
 
@@ -94,6 +98,11 @@ def main():
     if args.debug:
         logging.basicConfig(level=logging.INFO)
 
+    # Change directory, if specified
+
+    if args.path:
+        os.chdir(args.path[0])
+
     # Get the list of all local branches
 
     try:
@@ -280,6 +289,8 @@ def git_cleanup():
         sys.exit(1)
     except BrokenPipeError:
         sys.exit(2)
+    except git.GitError as exc:
+        colour.error(exc.msg, status=exc.status, prefix=True)
 
 ################################################################################
 

skilleter_thingy/git_co.py

@@ -20,6 +20,7 @@
 """
 ################################################################################
 
+import os
 import logging
 import sys
 import argparse
@@ -68,6 +69,8 @@ def parse_arguments():
     parser.add_argument('--debug', action='store_true', help='Enable debug output')
     parser.add_argument('branchname', nargs=1, type=str,
                         help='The branch name (or a partial name that matches uniquely against a local branch, remote branch, commit ID or tag)')
+    parser.add_argument('--path', '-C', nargs=1, type=str, default=None,
+                        help='Run the command in the specified directory')
 
     args = parser.parse_args()
 
@@ -76,6 +79,9 @@ def parse_arguments():
     if args.debug:
         logging.basicConfig(level=logging.INFO)
 
+    if args.path:
+        os.chdir(args.path[0])
+
     return args
 
 ################################################################################
@@ -198,9 +204,6 @@ def main():
         else:
             checkout_matching_branch(args, args.branchname[0])
 
-    except git.GitError as exc:
-        colour.error(exc.msg, exc.status)
-
 ################################################################################
 
 def git_co():
@@ -213,6 +216,8 @@ def git_co():
         sys.exit(1)
     except BrokenPipeError:
         sys.exit(2)
+    except git.GitError as exc:
+        colour.error(exc.msg, status=exc.status, prefix=True)
 
 ################################################################################
 

skilleter_thingy/git_common.py

@@ -6,10 +6,12 @@ Report the oldest commit in common in the history of two commits
 
 ################################################################################
 
+import os
 import sys
 import argparse
 
 import thingy.colour as colour
+# TODO: Update to git2
 import thingy.git as git
 
 ################################################################################
@@ -21,6 +23,8 @@ def main():
 
     parser.add_argument('--short', '-s', action='store_true', help='Just output the ancestor commit ID')
     parser.add_argument('--long', '-l', action='store_true', help='Output the log entry for the commit')
+    parser.add_argument('--path', '-C', nargs=1, type=str, default=None,
+                        help='Run the command in the specified directory')
     parser.add_argument('commit1', nargs='?', default='HEAD', help='First commit (default=HEAD)')
     parser.add_argument('commit2', nargs='?', default='master', help='Second commit (default=master)')
 
@@ -29,10 +33,12 @@ def main():
     if args.long and args.short:
         colour.error('The [BLUE:--long] and [BLUE:--short] options cannot be used together', prefix=True)
 
-    try:
-        ancestor = git.find_common_ancestor(args.commit1, args.commit2)
-    except git.GitError as exc:
-        colour.error(exc, status=exc.status, prefix=True)
+    # Change directory, if specified
+
+    if args.path:
+        os.chdir(args.path[0])
+
+    ancestor = git.find_common_ancestor(args.commit1, args.commit2)
 
     if args.short:
         print(ancestor)
@@ -54,6 +60,8 @@ def git_common():
         sys.exit(1)
     except BrokenPipeError:
         sys.exit(2)
+    except git.GitError as exc:
+        colour.error(exc.msg, status=exc.status, prefix=True)
 
 ################################################################################
 

skilleter_thingy/git_hold.py

@@ -2,11 +2,13 @@
 """Archive one or more branches by tagging the branch then deleting it
    The branch tag is 'archive/BRANCH_NAME'"""
 
+import os
 import sys
 import argparse
 import fnmatch
 
 import thingy.colour as colour
+# TODO: Update to git2
 import thingy.git as git
 
 ################################################################################
@@ -118,6 +120,8 @@ def main():
     parser = argparse.ArgumentParser(description='Archive, list or recover one or more Git branches')
     parser.add_argument('--list', '-l', action='store_true', help='List archived branches')
     parser.add_argument('--restore', '-r', action='store_true', help='Restore archived branches')
+    parser.add_argument('--path', '-C', nargs=1, type=str, default=None,
+                        help='Run the command in the specified directory')
     parser.add_argument('branches', nargs='*', help='Branches')
 
     args = parser.parse_args()
@@ -128,6 +132,9 @@ def main():
     if not args.branches and not args.list:
         colour.error('No branches specified', prefix=True)
 
+    if args.path:
+        os.chdir(args.path[0])
+
     if args.list:
         list_archive_branches(args.branches)
     elif args.restore:
@@ -147,6 +154,8 @@ def git_hold():
         sys.exit(1)
     except BrokenPipeError:
         sys.exit(2)
+    except git.GitError as exc:
+        colour.error(exc.msg, status=exc.status, prefix=True)
 
 ################################################################################
 

skilleter_thingy/git_mr.py

@@ -4,10 +4,12 @@
 """ Push to Gitlab and create a merge request at the same time """
 ################################################################################
 
+import os
 import logging
 import sys
 import argparse
 
+# TODO: Update to git2
 import thingy.git as git
 import thingy.colour as colour
 
@@ -27,6 +29,8 @@ def parse_arguments():
     parser.add_argument('--parent', '-p', action='store', help='Override the default parent and specify the branch to merge onto')
     parser.add_argument('--reviewer', '-r', action='store', help='Specify the name of the reviewer for the merge request')
     parser.add_argument('--keep', '-k', action='store_true', help='Keep the source branch after the merge (default is to delete it).')
+    parser.add_argument('--path', '-C', nargs=1, type=str, default=None,
+                        help='Run the command in the specified directory')
 
     args = parser.parse_args()
 
@@ -35,6 +39,11 @@ def parse_arguments():
     if args.debug:
         logging.basicConfig(level=logging.INFO)
 
+    # Change directory, if specified
+
+    if args.path:
+        os.chdir(args.path[0])
+
     return args
 
 ################################################################################
@@ -86,6 +95,8 @@ def git_mr():
         sys.exit(1)
     except BrokenPipeError:
         sys.exit(2)
+    except git.GitError as exc:
+        colour.error(exc.msg, status=exc.status, prefix=True)
 
 ################################################################################