skilleter-thingy 0.2.14__tar.gz → 0.3.0__tar.gz

{skilleter_thingy-0.2.14 → skilleter_thingy-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: skilleter_thingy
-Version: 0.2.14
+Version: 0.3.0
 Summary: A collection of useful utilities, mainly aimed at making Git more friendly
 Author-email: John Skilleter <john@skilleter.org.uk>
 Project-URL: Home, https://skilleter.org.uk
@@ -52,7 +52,7 @@ For ease of use it is recommended that you create an alias for multigit called `
 
     alias mg="multigit $@"
 
-## Initialisation
+### Initialisation
 
 To use multigit, start by creating working trees for the repositories that you want to use in a directory tree - the working trees can be at different levels or even nested, for example:
 
@@ -70,7 +70,7 @@ To use multigit, start by creating working trees for the repositories that you w
 
 Start by running ensuring that the default branch (e.g. `main`) is checked out in each of the working trees and, in the top-level directory, run `multigit init` to create the configuration file which, by default is called `multigit.toml` - this is just a text file that sets the configuration for each working tree in terms of name, origin, default branch, tags and location.
 
-## Multigit Command Line
+### Multigit Command Line
 
 The multigit command line format is:
 
@@ -100,7 +100,7 @@ These options are AND-ed together, so specifying `--modified --branched --tag WO
 
 Multigit tags are stored in the configuration file, not within the working tree and each working tree can have multiple tags.
 
-## Multigit Commands
+### Multigit Commands
 
 Multigit supports a small list of subcommands, each of which are prefixed with a `+` to distinguish them from Git commands:
 
@@ -184,6 +184,21 @@ This is most useful where branches contain ticket numbers so, for instance given
 
 Note that the concept of the default branch `DEFAULT` mentioned above *only* applies when using the `multigit` command, although some of the commands will treat branches called `master` or `main` as special cases (see the individual command documentation).
 
+## git br
+
+List or delete branches that have been merged
+
+        usage: git-br [-h] [--all] [--delete] [--path PATH] [branches ...]
+
+        positional arguments:
+          branches              Filter the list of branches according to one or more patterns
+
+        options:
+          -h, --help            show this help message and exit
+          --all, -a             List all branches, including remotes
+          --delete, -d          Delete the specified branch(es), even if it is the current one (list of branches to delete must be supplied as parameters)
+          --path PATH, -C PATH  Run the command in the specified directory
+
 ## git ca
 
 Improved version of 'git commit --amend'. Updates files that are already in the commit and, optionally, adds and commits additional files.
@@ -242,6 +257,37 @@ Equivalent to `git checkout` but with enhanced branch matching as described abov
         --exact, -e   Do not use branch name matching - check out the branch as specified (if it exists)
         --debug       Enable debug output
 
+## git common
+
+Find the most recent common ancestor for two commits
+
+        usage: git-common [-h] [--short] [--long] [--path PATH] [commit1] [commit2]
+
+        positional arguments:
+          commit1               First commit (default=HEAD)
+          commit2               Second commit (default=master)
+
+        options:
+          -h, --help            show this help message and exit
+          --short, -s           Just output the ancestor commit ID
+          --long, -l            Output the log entry for the commit
+          --path PATH, -C PATH  Run the command in the specified directory
+
+## git hold
+
+Archive, list or recover one or more Git branches
+
+        usage: git-hold [-h] [--list] [--restore] [--path PATH] [branches ...]
+
+        positional arguments:
+          branches              Branches
+
+        options:
+          -h, --help            show this help message and exit
+          --list, -l            List archived branches
+          --restore, -r         Restore archived branches
+          --path PATH, -C PATH  Run the command in the specified directory
+
 ## git parent
 
 Attempt to determine the parent branch for the specified branch (defaulting to the current one).
@@ -258,6 +304,21 @@ Attempt to determine the parent branch for the specified branch (defaulting to t
           --all, -a      Include feature branches as possible parents
           --verbose, -v  Report verbose results (includes number of commits between branch and parent)
 
+## git retag
+
+Apply or update a tag, optionally updating it on the remote as well. If the specified tag exists, it is deleted
+and re-applied, otherwise it is recreated.
+
+        usage: git-retag [-h] [--push] [--path PATH] tag
+
+        positional arguments:
+          tag                   The tag
+
+        options:
+          -h, --help            show this help message and exit
+          --push, -p            Push the tag to the remote
+          --path PATH, -C PATH  Run the command in the specified directory
+
 ## git update
 
 Update the rworking tree from the remote, rebase local branch(es) against their parents and optionally run git cleanup.
@@ -313,6 +374,14 @@ Menu-driven Git code review tool
       --dir DIR             Work in the specified directory
       --difftool DIFFTOOL   Override the default git diff tool
 
+## ggit
+
+Run a git command in all working trees under the current directory (somewhat superceded by multigit).
+
+## ggrep
+
+Run 'git grep' in all repos under the current directory (somewhat superceded by multigit).
+
 # General Commands
 
 ## addpath
@@ -334,6 +403,10 @@ Add or remove entries from a path list (e.g. as used by the PATH environment var
       --separator SEPARATOR
                             Override the default path separator
 
+## consolecolours
+
+Display all available colours in the console.
+
 ## docker-purge
 
 Stop or kill docker instances and/or remove docker images.
@@ -470,24 +543,6 @@ Recursively delete empty directories
                             Files to ignore when considering whether a directory is empty
       --keep KEEP, -K KEEP  Directories that should be kept even if they are empty
 
-## rmdupe
-
-Search for duplicate files.
-
-    rmdupe [-h] [--debug] [--save SAVE] [--load LOAD] [--script SCRIPT] [--exclude EXCLUDE] [--ignore IGNORE] [path]
-
-    positional arguments:
-      path               Path(s) to search for duplicates
-
-    options:
-      -h, --help         show this help message and exit
-      --debug            Debug output
-      --save SAVE        Save duplicate file list
-      --load LOAD        Load duplicate file list
-      --script SCRIPT    Generate a shell script to delete the duplicates
-      --exclude EXCLUDE  Directories to skip when looking for duplicates
-      --ignore IGNORE    Wildcards to ignore when looking for duplicates
-
 ## rpylint
 
 Run pylint on all the Python source files in a directory tree
@@ -500,10 +555,6 @@ Run pylint on all the Python source files in a directory tree
     options:
       -h, --help  show this help message and exit
 
-## s3-sync
-
-Synchronise files from S3 to local storage.
-
 ## strreplace
 
 Simple search and replace utility for those times when trying to escape characters in a regexp to use sed is more hassle than it is worth.
@@ -592,33 +643,3 @@ YAML validator - checks that a file is valid YAML (use yamllint to verify that i
       --block     Force block style when dumping the YAML data
       --flow      Force flow style when dumping the YAML data
       --hiera     Process the file as Puppet Hiera data
-
-# Obsolescent Utilities
-
-These will be moved to the skilleter-extras package in due course.
-
-## consolecolours
-
-Display all available colours in the console.
-
-# Obsolescent Commands
-
-These commands will probably be retired in future versions of Thingy
-
-## ggit
-
-Run a git command in all working trees under the current directory (superceded by multigit).
-
-## ggrep
-
-Run 'git grep' in all repos under the current directory (superceded by multigit).
-
-## GitLab Commands
-
-### git mr
-
-Push a feature branch to GitLab and create a merge request
-
-### gl
-
-Command line for GitLab

{skilleter_thingy-0.2.14 → skilleter_thingy-0.3.0}/README.md

@@ -29,7 +29,7 @@ For ease of use it is recommended that you create an alias for multigit called `
 
     alias mg="multigit $@"
 
-## Initialisation
+### Initialisation
 
 To use multigit, start by creating working trees for the repositories that you want to use in a directory tree - the working trees can be at different levels or even nested, for example:
 
@@ -47,7 +47,7 @@ To use multigit, start by creating working trees for the repositories that you w
 
 Start by running ensuring that the default branch (e.g. `main`) is checked out in each of the working trees and, in the top-level directory, run `multigit init` to create the configuration file which, by default is called `multigit.toml` - this is just a text file that sets the configuration for each working tree in terms of name, origin, default branch, tags and location.
 
-## Multigit Command Line
+### Multigit Command Line
 
 The multigit command line format is:
 
@@ -77,7 +77,7 @@ These options are AND-ed together, so specifying `--modified --branched --tag WO
 
 Multigit tags are stored in the configuration file, not within the working tree and each working tree can have multiple tags.
 
-## Multigit Commands
+### Multigit Commands
 
 Multigit supports a small list of subcommands, each of which are prefixed with a `+` to distinguish them from Git commands:
 
@@ -161,6 +161,21 @@ This is most useful where branches contain ticket numbers so, for instance given
 
 Note that the concept of the default branch `DEFAULT` mentioned above *only* applies when using the `multigit` command, although some of the commands will treat branches called `master` or `main` as special cases (see the individual command documentation).
 
+## git br
+
+List or delete branches that have been merged
+
+        usage: git-br [-h] [--all] [--delete] [--path PATH] [branches ...]
+
+        positional arguments:
+          branches              Filter the list of branches according to one or more patterns
+
+        options:
+          -h, --help            show this help message and exit
+          --all, -a             List all branches, including remotes
+          --delete, -d          Delete the specified branch(es), even if it is the current one (list of branches to delete must be supplied as parameters)
+          --path PATH, -C PATH  Run the command in the specified directory
+
 ## git ca
 
 Improved version of 'git commit --amend'. Updates files that are already in the commit and, optionally, adds and commits additional files.
@@ -219,6 +234,37 @@ Equivalent to `git checkout` but with enhanced branch matching as described abov
         --exact, -e   Do not use branch name matching - check out the branch as specified (if it exists)
         --debug       Enable debug output
 
+## git common
+
+Find the most recent common ancestor for two commits
+
+        usage: git-common [-h] [--short] [--long] [--path PATH] [commit1] [commit2]
+
+        positional arguments:
+          commit1               First commit (default=HEAD)
+          commit2               Second commit (default=master)
+
+        options:
+          -h, --help            show this help message and exit
+          --short, -s           Just output the ancestor commit ID
+          --long, -l            Output the log entry for the commit
+          --path PATH, -C PATH  Run the command in the specified directory
+
+## git hold
+
+Archive, list or recover one or more Git branches
+
+        usage: git-hold [-h] [--list] [--restore] [--path PATH] [branches ...]
+
+        positional arguments:
+          branches              Branches
+
+        options:
+          -h, --help            show this help message and exit
+          --list, -l            List archived branches
+          --restore, -r         Restore archived branches
+          --path PATH, -C PATH  Run the command in the specified directory
+
 ## git parent
 
 Attempt to determine the parent branch for the specified branch (defaulting to the current one).
@@ -235,6 +281,21 @@ Attempt to determine the parent branch for the specified branch (defaulting to t
           --all, -a      Include feature branches as possible parents
           --verbose, -v  Report verbose results (includes number of commits between branch and parent)
 
+## git retag
+
+Apply or update a tag, optionally updating it on the remote as well. If the specified tag exists, it is deleted
+and re-applied, otherwise it is recreated.
+
+        usage: git-retag [-h] [--push] [--path PATH] tag
+
+        positional arguments:
+          tag                   The tag
+
+        options:
+          -h, --help            show this help message and exit
+          --push, -p            Push the tag to the remote
+          --path PATH, -C PATH  Run the command in the specified directory
+
 ## git update
 
 Update the rworking tree from the remote, rebase local branch(es) against their parents and optionally run git cleanup.
@@ -290,6 +351,14 @@ Menu-driven Git code review tool
       --dir DIR             Work in the specified directory
       --difftool DIFFTOOL   Override the default git diff tool
 
+## ggit
+
+Run a git command in all working trees under the current directory (somewhat superceded by multigit).
+
+## ggrep
+
+Run 'git grep' in all repos under the current directory (somewhat superceded by multigit).
+
 # General Commands
 
 ## addpath
@@ -311,6 +380,10 @@ Add or remove entries from a path list (e.g. as used by the PATH environment var
       --separator SEPARATOR
                             Override the default path separator
 
+## consolecolours
+
+Display all available colours in the console.
+
 ## docker-purge
 
 Stop or kill docker instances and/or remove docker images.
@@ -447,24 +520,6 @@ Recursively delete empty directories
                             Files to ignore when considering whether a directory is empty
       --keep KEEP, -K KEEP  Directories that should be kept even if they are empty
 
-## rmdupe
-
-Search for duplicate files.
-
-    rmdupe [-h] [--debug] [--save SAVE] [--load LOAD] [--script SCRIPT] [--exclude EXCLUDE] [--ignore IGNORE] [path]
-
-    positional arguments:
-      path               Path(s) to search for duplicates
-
-    options:
-      -h, --help         show this help message and exit
-      --debug            Debug output
-      --save SAVE        Save duplicate file list
-      --load LOAD        Load duplicate file list
-      --script SCRIPT    Generate a shell script to delete the duplicates
-      --exclude EXCLUDE  Directories to skip when looking for duplicates
-      --ignore IGNORE    Wildcards to ignore when looking for duplicates
-
 ## rpylint
 
 Run pylint on all the Python source files in a directory tree
@@ -477,10 +532,6 @@ Run pylint on all the Python source files in a directory tree
     options:
       -h, --help  show this help message and exit
 
-## s3-sync
-
-Synchronise files from S3 to local storage.
-
 ## strreplace
 
 Simple search and replace utility for those times when trying to escape characters in a regexp to use sed is more hassle than it is worth.
@@ -569,33 +620,3 @@ YAML validator - checks that a file is valid YAML (use yamllint to verify that i
       --block     Force block style when dumping the YAML data
       --flow      Force flow style when dumping the YAML data
       --hiera     Process the file as Puppet Hiera data
-
-# Obsolescent Utilities
-
-These will be moved to the skilleter-extras package in due course.
-
-## consolecolours
-
-Display all available colours in the console.
-
-# Obsolescent Commands
-
-These commands will probably be retired in future versions of Thingy
-
-## ggit
-
-Run a git command in all working trees under the current directory (superceded by multigit).
-
-## ggrep
-
-Run 'git grep' in all repos under the current directory (superceded by multigit).
-
-## GitLab Commands
-
-### git mr
-
-Push a feature branch to GitLab and create a merge request
-
-### gl
-
-Command line for GitLab

{skilleter_thingy-0.2.14 → skilleter_thingy-0.3.0}/pyproject.toml

@@ -7,7 +7,7 @@ name = "skilleter_thingy"
 
 # Version must be incremented to install updated Thingy
 
-version = "0.2.14"
+version = "0.3.0"
 
 authors = [
     {name="John Skilleter", email="john@skilleter.org.uk"},
@@ -53,7 +53,6 @@ git-cleanup     =  "skilleter_thingy:git_cleanup.git_cleanup"
 git-co          =  "skilleter_thingy:git_co.git_co"
 git-common      =  "skilleter_thingy:git_common.git_common"
 git-hold        =  "skilleter_thingy:git_hold.git_hold"
-git-mr          =  "skilleter_thingy:git_mr.git_mr"
 git-parent      =  "skilleter_thingy:git_parent.git_parent"
 git-retag       =  "skilleter_thingy:git_retag.git_retag"
 git-review      =  "skilleter_thingy:git_review.git_review"
@@ -61,22 +60,16 @@ git-update      =  "skilleter_thingy:git_update.git_update"
 git-wt          =  "skilleter_thingy:git_wt.git_wt"
 gitcmp-helper   =  "skilleter_thingy:gitcmp_helper.gitcmp_helper"
 gitprompt       =  "skilleter_thingy:gitprompt.gitprompt"
-gl              =  "skilleter_thingy:gl.gl"
-gphotosync      =  "skilleter_thingy:gphotosync.gphotosync"
 linecount       =  "skilleter_thingy:linecount.linecount"
-mg              =  "skilleter_thingy:mg.mg"
 multigit        =  "skilleter_thingy:multigit.multigit"
 py-audit        =  "skilleter_thingy:py_audit.py_audit"
 readable        =  "skilleter_thingy:readable.readable"
 remdir          =  "skilleter_thingy:remdir.remdir"
-rmdupe          =  "skilleter_thingy:rmdupe.rmdupe"
 rpylint         =  "skilleter_thingy:rpylint.rpylint"
-s3-sync         =  "skilleter_thingy:s3_sync.s3_sync"
 strreplace      =  "skilleter_thingy:strreplace.strreplace"
 tfm             =  "skilleter_thingy:tfm.tfm"
 tfparse         =  "skilleter_thingy:tfparse.tfparse"
 trimpath        =  "skilleter_thingy:trimpath.trimpath"
 venv-create     =  "skilleter_thingy:venv_create.venv_create"
-webwatch        =  "skilleter_thingy:webwatch.webwatch"
 xchmod          =  "skilleter_thingy:xchmod.xchmod"
 yamlcheck       =  "skilleter_thingy:yamlcheck.yamlcheck"

{skilleter_thingy-0.2.14 → skilleter_thingy-0.3.0}/skilleter_thingy/docker_purge.py

@@ -21,6 +21,7 @@ from thingy import docker
 def initialise():
     """ Parse the command line """
 
+    breakpoint()
     parser = argparse.ArgumentParser(description='Purge docker instances and images')
 
     parser.add_argument('--stop', '-s', action='store_true', help='Stop Docker instances')

{skilleter_thingy-0.2.14 → skilleter_thingy-0.3.0}/skilleter_thingy/gitcmp_helper.py

@@ -298,8 +298,10 @@ def main():
             if not deleted_file or not skip_deleted:
                 try:
                     subprocess.run([difftool, args.old_file, args.new_file], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, check=True)
+
                 except subprocess.CalledProcessError as exc:
                     print(f'WARNING: Diff failed - status = {exc.returncode}')
+
                 except FileNotFoundError:
                     print(f'ERROR: Unable to locate diff tool {difftool}')
                     sys.exit(1)

{skilleter_thingy-0.2.14 → skilleter_thingy-0.3.0}/skilleter_thingy/multigit.py

@@ -646,16 +646,18 @@ def mg_run(args, config, console):
         repo_path = absolute_repo_path(args, repo.name)
 
         try:
-            status = subprocess.run(args.parameters, cwd=repo_path, check=False)
+            status = subprocess.run(args.parameters, cwd=repo_path, check=True)
+
         except FileNotFoundError:
             err_msg = f'"[BLUE:{args.parameters[0]}]" - Command not found'
             if args.error_continue:
                 colour.write(f'[RED:WARNING]: {err_msg}')
             else:
                 colour.error(f'[RED:ERROR]: {err_msg}')
-        else:
-            if status.returncode and not args.error_continue:
-                sys.exit(status)
+
+        except subprocess.CalledProcessError as exc:                
+            if not args.error_continue:
+                sys.exit(exc.returncode)
 
 ################################################################################
 

{skilleter_thingy-0.2.14 → skilleter_thingy-0.3.0}/skilleter_thingy/py_audit.py

@@ -100,11 +100,12 @@ def main():
                          f' && python3 -m pip {PIP_OPTIONS} list | tail -n+3 | tee {package_list.name}' \
                           ' && deactivate'
 
-                result = subprocess.run(script, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=True)
+                try:
+                    subprocess.run(script, check=True, shell=True)
 
-                if result.returncode:
-                    print(f'ERROR #{result.returncode}: {result.stdout}')
-                    sys.exit(result.returncode)
+                except subprocess.CalledProcessError as exc:
+                    print(f'ERROR #{exc.returncode}: {exc.stdout}')
+                    sys.exit(exc.returncode)
 
                 with open(package_list.name) as infile:
                     for package in infile.readlines():

{skilleter_thingy-0.2.14 → skilleter_thingy-0.3.0}/skilleter_thingy/thingy/docker.py

@@ -12,7 +12,7 @@
 """
 ################################################################################
 
-import thingy.run as run
+import subprocess
 
 ################################################################################
 
@@ -33,9 +33,12 @@ def instances(all=False):
 
     instances_list = []
     try:
-        for result in run.run(cmd):
+        process = subprocess.run(cmd, capture_output=True, check=True, text=True)
+
+        for result in process.stdout:
             instances_list.append(result)
-    except run.RunError as exc:
+
+    except subprocess.CalledProcessError as exc:
         raise DockerError(exc)
 
     return instances_list
@@ -48,8 +51,9 @@ def stop(instance, force=False):
     # TODO: force option not implemented
 
     try:
-        run.run(['docker', 'stop', instance], output=True)
-    except run.RunError as exc:
+        subprocess.run(['docker', 'stop', instance], check=True, capture_output=False)
+
+    except suprocess.CalledProcessError as exc:
         raise DockerError(exc)
 
 ################################################################################
@@ -65,8 +69,9 @@ def rm(instance, force=False):
     cmd.append(instance)
 
     try:
-        run.run(cmd, output=True)
-    except run.RunError as exc:
+        subprocess.run(cmd, check=True, capture_output=False)
+
+    except subprocess.CalledProcessError as exc:
         raise DockerError(exc)
 
 ################################################################################
@@ -75,9 +80,12 @@ def images():
     """ Return a list of all current Docker images """
 
     try:
-        for result in run.run(['docker', 'images', '-q']):
+        process = subprocess.run(['docker', 'images', '-q'], capture_output=True, check=True)
+
+        for result in process:
             yield result
-    except run.RunError as exc:
+
+    except subprocess.CalledProcessError as exc:
         raise DockerError(exc)
 
 ################################################################################
@@ -92,6 +100,6 @@ def rmi(image, force=False):
     cmd.append(image)
 
     try:
-        run.run(cmd, foreground=True)
-    except run.RunError as exc:
+        subprocess.run(cmd, capture_output=False, check=True)
+    except subprocess.CalledProcessError as exc:
         raise DockerError(exc)

{skilleter_thingy-0.2.14 → skilleter_thingy-0.3.0}/skilleter_thingy/thingy/git.py

@@ -85,7 +85,7 @@ def git(cmd, stdout=None, stderr=None, path=None):
 ################################################################################
 
 def git_run_status(cmd, stdout=None, stderr=None, path=None, redirect=True):
-    """ Wrapper for run.run that returns the output and status, and
+    """ Wrapper for subprocess.run that returns the output and status, and
         does not raise an exception on error.
         Optionally redirect stdout and stderr as specified. """
 
@@ -948,7 +948,7 @@ def ref(fields=('objectname'), sort=None, remotes=False, path=None):
 
 ################################################################################
 
-def branches(all=False, path=None):
+def branches(all=False, path=None, remote=False):
     """ Return a list of all the branches in the current repo """
 
     cmd = ['branch', '--format=%(refname:short)','--list']
@@ -956,6 +956,9 @@ def branches(all=False, path=None):
     if all:
         cmd.append('--all')
 
+    if remote:
+        cmd.append('--remote')
+
     results = []
     for output in git(cmd, path=path):
         if ' -> ' not in output and '(HEAD detached at ' not in output:
@@ -1250,7 +1253,10 @@ def matching_branch(branchname, case=False, path=None):
         otherwise, it just checks for a branches containing the branchname
         as a substring. """
 
-    all_branches = branches(all=True, path=path)
+    local_branches = branches(path=path)
+    remote_branches = branches(path=path, remote=True)
+
+    all_branches = local_branches + remote_branches
 
     # Always return exact matches
 
@@ -1284,8 +1290,8 @@ def matching_branch(branchname, case=False, path=None):
                 # If the match is a remote branch, ignore it if we already have the equivalent
                 # local branch, otherwise add the name of the local branch that would be created.
 
-                if branch.startswith('remotes/'):
-                    localbranch = '/'.join(branch.split('/')[2:])
+                if branch in remote_branches:
+                    localbranch = '/'.join(branch.split('/')[1:])
                     if localbranch not in matching:
                         matching_remote.append(localbranch)
                 else: