skilleter-thingy 0.0.69__tar.gz → 0.0.70__tar.gz

{skilleter_thingy-0.0.69/skilleter_thingy.egg-info → skilleter_thingy-0.0.70}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: skilleter_thingy
-Version: 0.0.69
+Version: 0.0.70
 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
@@ -18,6 +18,7 @@ Requires-Dist: pyaml
 Requires-Dist: pygit2
 Requires-Dist: python-dateutil
 Requires-Dist: requests
+Requires-Dist: tomlkit
 
 # Thingy
 

{skilleter_thingy-0.0.69 → skilleter_thingy-0.0.70}/pyproject.toml

@@ -7,7 +7,7 @@ name = "skilleter_thingy"
 
 # Version must be incremented to install updated Thingy
 
-version = "0.0.69"
+version = "0.0.70"
 
 authors = [
     {name="John Skilleter", email="john@skilleter.org.uk"},
@@ -34,6 +34,7 @@ dependencies = [
     "pygit2",
     "python-dateutil",
     "requests",
+    "tomlkit",
 ]
 
 [project.urls]
@@ -64,6 +65,7 @@ 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"
 moviemover      =  "skilleter_thingy:moviemover.moviemover"
 photodupe       =  "skilleter_thingy:photodupe.photodupe"
 phototidier     =  "skilleter_thingy:phototidier.phototidier"

skilleter_thingy-0.0.70/skilleter_thingy/multigit.py

@@ -0,0 +1,244 @@
+#!/usr/bin/env python3
+
+"""mg - MultiGit - utility for managing multiple Git repos in a hierarchical directory tree"""
+
+import os
+import sys
+import argparse
+
+import tomlkit
+
+import thingy.git2 as git
+import thingy.colour as colour
+
+################################################################################
+
+"""Configuration file format:
+
+    [default]
+    # Default settings
+    default branch = name
+
+    [repos]
+    name = path
+    default branch = name
+
+    [git-repo-location] # Either absolute or relative to the directory where the configuration file is found
+    # Repo-specific settings to override default section
+"""
+
+# TODO: -j option to run in parallel
+# TODO: init function
+# TODO: Use the configuration file
+# TODO: Don't use a fixed list of default branch names
+# TODO: Output name of each git repo as it is processed as command sits there seeming to do nothing otherwise.
+
+################################################################################
+
+DEFAULT_CONFIG_FILE = 'multigit.toml'
+
+DEFAULT_BRANCHES = ('main', 'scv-poc', 'master')
+
+################################################################################
+
+def error(msg, status=1):
+    """Quit with an error"""
+
+    sys.stderr.write(f'{msg}\n')
+    sys.exit(status)
+
+################################################################################
+
+def show_progress(width, msg):
+    """Show a single line progress message"""
+
+    name = msg[:width-1]
+
+    colour.write(f'{name}', newline=False)
+
+    if len(name) < width-1:
+        colour.write(' '*(width-len(name)), newline=False)
+
+    colour.write('\r', newline=False)
+
+################################################################################
+
+def find_git_repos(directory):
+    """Locate and return a list of '.git' directory parent directories in the
+       specified path"""
+
+    git_repos = []
+
+    for root, dirs, _ in os.walk(directory):
+        if '.git' in dirs:
+            git_repos.append(root)
+
+    return git_repos
+
+################################################################################
+
+def mg_init(args, config, console):
+    """Create or update the configuration"""
+
+    error('Not used - yet!')
+
+    if config:
+        print(f'Updating existing multigit configuration file - {args.config}')
+        error('Not supported yet')
+    else:
+        print(f'Creating new multigit configuration file - {args.config}')
+
+    # Search for .git directories
+
+    git_repos = find_git_repos(args.directory)
+
+################################################################################
+
+def mg_status(args, config, console):
+    """Report Git status for any repo that has a non-empty status"""
+
+    for repo in find_git_repos(args.directory):
+        if not args.quiet:
+            show_progress(console.columns, repo)
+
+        status = git.status(path=repo)
+        branch = git.branch(path=repo)
+
+        if status or branch not in DEFAULT_BRANCHES:
+            if branch in DEFAULT_BRANCHES:
+                colour.write(f'[BOLD:{repo}]')
+            else:
+                colour.write(f'[BOLD:{repo}] - branch: [BLUE:{branch}]')
+
+            for entry in status:
+                if entry[0] == '??':
+                    colour.write(f'    Untracked: [BLUE:{entry[1]}]')
+                else:
+                    colour.write(f'    [BLUE:{entry}]')
+
+            colour.write()
+
+################################################################################
+
+def mg_fetch(args, config, console):
+    """Run git fetch everywhere"""
+
+    for repo in find_git_repos(args.directory):
+        if not args.quiet:
+            show_progress(console.columns, repo)
+
+        result = git.fetch(path=repo)
+
+        if result:
+            colour.write(f'[BOLD:{repo}]')
+            for item in result:
+                if item.startswith('From '):
+                    colour.write(f'    [BLUE:{item}]')
+                else:
+                    colour.write(f'    {item}')
+
+            colour.write()
+
+################################################################################
+
+def mg_pull(args, config, console):
+    """Run git pull everywhere"""
+
+    for repo in find_git_repos(args.directory):
+        if not args.quiet:
+            show_progress(console.columns, repo)
+
+        try:
+            result = git.pull(path=repo)
+        except git.GitError as exc:
+            error(f'Error in {repo}: {exc}')
+
+        if result and result[0] != 'Already up-to-date.':
+            colour.write(f'[BOLD:{repo}]')
+            for item in result:
+                if item.startswith('Updating'):
+                    colour.write(f'    [BLUE:{item}]')
+                else:
+                    colour.write(f'    {item}')
+
+            colour.write()
+
+################################################################################
+
+def mg_push(args, config, console):
+    """Run git push everywhere where the current branch isn't one of the defaults
+       and where the most recent commit was the current user and was on the branch
+    """
+
+    # TODO: Add option for force-push?
+    # TODO: Add option for manual confirmation?
+
+    pass
+
+################################################################################
+
+def main():
+    """Main function"""
+
+    commands = {
+       'init': mg_init,
+       'status': mg_status,
+       'fetch': mg_fetch,
+       'pull': mg_pull,
+       'push': mg_push,
+    }
+
+    # Parse args in the form COMMAND OPTIONS SUBCOMMAND SUBCOMMAND_OPTIONS PARAMETERS
+
+    parser = argparse.ArgumentParser(description='Gitlab commands')
+
+    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('--quiet', '-q', action='store_true', help='Minimal console output')
+    parser.add_argument('--config', '-c', action='store', default=DEFAULT_CONFIG_FILE, help=f'The configuration file (defaults to {DEFAULT_CONFIG_FILE})')
+    parser.add_argument('--directory', '--dir', action='store', default='.', help='The top-level directory of the multigit tree (defaults to the current directory)')
+
+    subparsers = parser.add_subparsers(dest='command')
+
+    # Subcommands - currently just init, status, fetch, pull, push, with more to come
+
+    parser_init = subparsers.add_parser('init', help='')
+
+    parser_status = subparsers.add_parser('status', help='Report git status in every repo that has one')
+    parser_fetch = subparsers.add_parser('fetch', help='Run git fetch in every repo')
+    parser_pull = subparsers.add_parser('pull', help='Run git pull in every repo')
+    parser_push = subparsers.add_parser('push', help='Run git push in every repo where the current branch isn\'t the default and the most recent commit was by the current user')
+
+    # Parse the command line
+
+    args = parser.parse_args()
+
+    # If the configuration file exists, read it
+
+    config = tomlkit.loads(args.config) if os.path.isfile(args.config) else None
+
+    # Get the console size
+
+    console = os.get_terminal_size()
+
+    # Run the subcommand
+
+    commands[args.command](args, config, console)
+
+################################################################################
+
+def mg():
+    """Entry point"""
+
+    try:
+        main()
+    except KeyboardInterrupt:
+        sys.exit(1)
+    except BrokenPipeError:
+        sys.exit(2)
+
+################################################################################
+
+if __name__ == '__main__':
+    mg()

{skilleter_thingy-0.0.69 → skilleter_thingy-0.0.70}/skilleter_thingy/thingy/git2.py

@@ -42,12 +42,12 @@ import thingy.gitlab as gitlab
 class GitError(run.RunError):
     """ Run exception """
 
-    def __init__(self, msg, status=1):
-        super().__init__(msg, status)
+    def __init__(self, msg, exit_status=1):
+        super().__init__(msg, exit_status)
 
 ################################################################################
 
-def git(cmd, stdout=None, stderr=None):
+def git(cmd, stdout=None, stderr=None, path=None):
     """ Wrapper for run.run that raises a GitError instead of RunError
         so that Git module users do not to include the run module just
         to get the exception.
@@ -55,24 +55,34 @@ def git(cmd, stdout=None, stderr=None):
 
     logging.debug('Running git %s', ' '.join(cmd))
 
+    git_cmd = ['git']
+
+    if path:
+        git_cmd += ['-C', path]
+
     try:
-        return run.run(['git'] + cmd, stdout=stdout, stderr=stderr)
+        return run.run(git_cmd + cmd, stdout=stdout, stderr=stderr)
     except run.RunError as exc:
         raise GitError(exc.msg, exc.status)
 
 ################################################################################
 
-def git_run_status(cmd, stdout=None, stderr=None):
+def git_run_status(cmd, stdout=None, stderr=None, path=None):
     """ Wrapper for run.run that returns the output and status, and
         does not raise an exception on error.
         Optionally redirect stdout and stderr as specified. """
 
     logging.debug('Running git %s', ' '.join(cmd))
 
-    result = subprocess.run(['git'] + cmd,
+    git_cmd = ['git']
+
+    if path:
+        git_cmd += ['-C', path]
+
+    result = subprocess.run(git_cmd + cmd,
                             stdout=stdout or subprocess.PIPE,
-                            stderr=stdout or subprocess.PIPE,
-                            text=True,
+                            stderr=stderr or subprocess.PIPE,
+                            text=True, check=False,
                             errors='ignore',
                             universal_newlines=True)
 
@@ -137,11 +147,11 @@ def iscommit(commit, remote=False, remote_only=False):
 
 ################################################################################
 
-def branch(branchname='HEAD'):
+def branch(branchname='HEAD', path=None):
     """ Return the name of the current git branch or None"""
 
     try:
-        return git(['symbolic-ref', '--short', '-q', branchname])[0]
+        return git(['symbolic-ref', '--short', '-q', branchname], path=path)[0]
     except GitError:
         return None
 
@@ -178,7 +188,7 @@ def current_commit(short=False):
 
 ################################################################################
 
-def pull(repo=None, all=False):
+def pull(repo=None, all=False, path=None):
     """ Run a git pull """
 
     cmd = ['pull']
@@ -189,7 +199,7 @@ def pull(repo=None, all=False):
     if repo:
         cmd.append(repo)
 
-    return git(cmd)
+    return git(cmd, path=path)
 
 ################################################################################
 
@@ -227,15 +237,15 @@ def set_upstream(branch, upstream=None):
     """ Set the default upstream branch """
 
     if not upstream:
-        upstream = 'origin/%s' % branch
+        upstream = f'origin/{branch}'
 
-    cmd = ['branch', '--set-upstream-to=%s' % upstream, branch]
+    cmd = ['branch', f'--set-upstream-to={upstream}', branch]
 
     return git(cmd)
 
 ################################################################################
 
-def fetch(all=False):
+def fetch(all=False, path=None):
     """ Run git fetch """
 
     cmd = ['fetch']
@@ -243,7 +253,7 @@ def fetch(all=False):
     if all:
         cmd.append('--all')
 
-    return git(cmd)
+    return git(cmd, path=path)
 
 ################################################################################
 
@@ -310,9 +320,9 @@ def remotes():
     """ Return the list of git remotes """
 
     repo = pygit2.Repository(os.getcwd())
-    
+
     git_remotes = {}
-    
+
     for name in repo.remotes.names():
         git_remotes[name] = repo.remotes[name].url
 
@@ -324,7 +334,7 @@ def remote_names():
     """ Return the list of remote names """
 
     repo = pygit2.Repository(os.getcwd())
-    
+
     results = list(repo.remotes.names())
 
     return results
@@ -343,7 +353,7 @@ def project(short=False):
                 name = git_remotes[remote].split('//')[-1].split('/', 1)[-1]
                 break
 
-            elif '@' in git_remotes[remote]:
+            if '@' in git_remotes[remote]:
                 name = git_remotes[remote].split(':')[-1]
                 break
 
@@ -386,10 +396,10 @@ def status_info(ignored=False, untracked=False):
     if results:
         result = results[0].split('\0')
 
-        for result in result:
-            if len(result) > 3 and result[2] == ' ':
-                git_status = result[0:2]
-                name = result[3:]
+        for r in result:
+            if len(r) > 3 and r[2] == ' ':
+                git_status = r[0:2]
+                name = r[3:]
 
                 info[name] = git_status
 
@@ -397,7 +407,7 @@ def status_info(ignored=False, untracked=False):
 
 ################################################################################
 
-def status(ignored=False, untracked=False):
+def status(ignored=False, untracked=False, path=None):
     """ Git status, optionally include files ignored in .gitignore and/or
         untracked files.
         Similar to status_info, but returns data as a list, rather than a
@@ -411,7 +421,7 @@ def status(ignored=False, untracked=False):
     if untracked:
         cmd.append('--untracked-files=all')
 
-    results = git(cmd)
+    results = git(cmd, path=path)
 
     # Nested list of results. For each entry:
     # item 0 is the status where: M=modified, A=added, D=deleted, R=renamed, C=copied, U=unmerged, ?=untracked, !=ignored
@@ -592,7 +602,7 @@ def diff_status(commit1, commit2='HEAD'):
 def show(revision, filename, outfile=None):
     """ Return the output from git show revision:filename """
 
-    return git(['show', '%s:%s' % (revision, filename)], stdout=outfile)
+    return git(['show', f'{revision}:{filename}'], stdout=outfile)
 
 ################################################################################
 
@@ -732,7 +742,7 @@ def config_get(section, key, source=LOCAL, defaultvalue=None):
     elif source == SYSTEM:
         cmd.append('--system')
 
-    cmd += ['--get', '%s.%s' % (section, key)]
+    cmd += ['--get', f'{section}.{key}']
 
     try:
         return git(cmd)[0]
@@ -751,7 +761,7 @@ def config_set(section, key, value, source=LOCAL):
     elif source == SYSTEM:
         cmd.append('--system')
 
-    cmd += ['--replace-all', '%s.%s' % (section, key), value]
+    cmd += ['--replace-all', f'{section}.{key}', value]
 
     return git(cmd)
 
@@ -767,7 +777,7 @@ def config_rm(section, key, source=LOCAL):
     elif source == SYSTEM:
         cmd.append('--system')
 
-    cmd += ['--unset', '%s.%s' % (section, key)]
+    cmd += ['--unset', f'{section}.{key}']
 
     return git(cmd)
 
@@ -779,7 +789,7 @@ def ref(fields=('objectname'), sort=None, remotes=False):
     cmd = ['for-each-ref']
 
     if sort:
-        cmd.append('--sort=%s' % sort)
+        cmd.append(f'--sort={sort}')
 
     field_list = []
     for field in fields:
@@ -857,7 +867,7 @@ def remote_prune(remote, dry_run=False):
 def get_commits(commit1, commit2):
     """ Get a list of commits separating two commits """
 
-    return git(['rev-list', commit1, '^%s' % commit2])
+    return git(['rev-list', commit1, f'^{commit2}'])
 
 ################################################################################
 

{skilleter_thingy-0.0.69 → skilleter_thingy-0.0.70/skilleter_thingy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: skilleter_thingy
-Version: 0.0.69
+Version: 0.0.70
 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
@@ -18,6 +18,7 @@ Requires-Dist: pyaml
 Requires-Dist: pygit2
 Requires-Dist: python-dateutil
 Requires-Dist: requests
+Requires-Dist: tomlkit
 
 # Thingy
 

{skilleter_thingy-0.0.69 → skilleter_thingy-0.0.70}/skilleter_thingy.egg-info/SOURCES.txt

@@ -28,6 +28,7 @@ skilleter_thingy/gl.py
 skilleter_thingy/gphotosync.py
 skilleter_thingy/linecount.py
 skilleter_thingy/moviemover.py
+skilleter_thingy/multigit.py
 skilleter_thingy/photodupe.py
 skilleter_thingy/phototidier.py
 skilleter_thingy/py_audit.py

{skilleter_thingy-0.0.69 → skilleter_thingy-0.0.70}/skilleter_thingy.egg-info/entry_points.txt

@@ -23,6 +23,7 @@ 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
 moviemover = skilleter_thingy:moviemover.moviemover
 photodupe = skilleter_thingy:photodupe.photodupe
 phototidier = skilleter_thingy:phototidier.phototidier

{skilleter_thingy-0.0.69 → skilleter_thingy-0.0.70}/skilleter_thingy.egg-info/requires.txt

@@ -6,3 +6,4 @@ pyaml
 pygit2
 python-dateutil
 requests
+tomlkit