skilleter-thingy 0.1.2__tar.gz → 0.1.3__tar.gz

{skilleter_thingy-0.1.2 → skilleter_thingy-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: skilleter_thingy
-Version: 0.1.2
+Version: 0.1.3
 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
@@ -89,6 +89,8 @@ The command takes a number of options that can be used to select the list of wor
 
 `--tag TAG` / `-t TAG` Run only in working trees that are tagged with the specified tag
 
+`--subdir` / `-s` Run only in working trees that are in the current directory tree.
+
 These options are AND-ed together, so specifying `--modified --branched --tag WOMBAT` will select only working trees that are modified AND branched AND tagged with `WOMBAT`, but the parameters to the `--repos` and `--tag` options are OR-ed together, so specifying `--tag WOMBAT --tag EMU` will select repos that are tagged as `WOMBAT` *OR* `EMU`.
 
 Multigit tags are stored in the configuration file, not within the working tree and each working tree can have multiple tags.
@@ -97,6 +99,8 @@ Multigit tags are stored in the configuration file, not within the working tree
 
 Multigit supports a small list of subcommands, each of which are prefixed with a `+` to distinguish them from Git commands:
 
+`+clone` - Clone a repo containing a multigit configuration file then clone all the repos specified in the configuration, checking out the default branch in each one.
+
 `+init` - Create or update the configuration file
 
 `+dir` - Given the name of a working tree, output the location within the multigit tree of that working tree if the name matches uniquely, or the name of the directory where the multigit configuration file resides if no parameter is specified.

{skilleter_thingy-0.1.2 → skilleter_thingy-0.1.3}/README.md

@@ -67,6 +67,8 @@ The command takes a number of options that can be used to select the list of wor
 
 `--tag TAG` / `-t TAG` Run only in working trees that are tagged with the specified tag
 
+`--subdir` / `-s` Run only in working trees that are in the current directory tree.
+
 These options are AND-ed together, so specifying `--modified --branched --tag WOMBAT` will select only working trees that are modified AND branched AND tagged with `WOMBAT`, but the parameters to the `--repos` and `--tag` options are OR-ed together, so specifying `--tag WOMBAT --tag EMU` will select repos that are tagged as `WOMBAT` *OR* `EMU`.
 
 Multigit tags are stored in the configuration file, not within the working tree and each working tree can have multiple tags.
@@ -75,6 +77,8 @@ Multigit tags are stored in the configuration file, not within the working tree
 
 Multigit supports a small list of subcommands, each of which are prefixed with a `+` to distinguish them from Git commands:
 
+`+clone` - Clone a repo containing a multigit configuration file then clone all the repos specified in the configuration, checking out the default branch in each one.
+
 `+init` - Create or update the configuration file
 
 `+dir` - Given the name of a working tree, output the location within the multigit tree of that working tree if the name matches uniquely, or the name of the directory where the multigit configuration file resides if no parameter is specified.

{skilleter_thingy-0.1.2 → skilleter_thingy-0.1.3}/pyproject.toml

@@ -7,7 +7,7 @@ name = "skilleter_thingy"
 
 # Version must be incremented to install updated Thingy
 
-version = "0.1.2"
+version = "0.1.3"
 
 authors = [
     {name="John Skilleter", email="john@skilleter.org.uk"},

{skilleter_thingy-0.1.2 → skilleter_thingy-0.1.3}/skilleter_thingy/multigit.py

@@ -14,6 +14,7 @@ import thingy.colour as colour
 
 ################################################################################
 
+# DONE: ***MUST use relative paths in config file, or we can't store in git and clone and use somewhere else!***
 # DONE: / Output name of each working tree as it is processed as command sits there seeming to do nothing otherwise.
 # DONE: Better error-handling - e.g. continue/abort option after failure in one working tree
 # DONE: Currently doesn't handle single letter options in concatenated form - e.g. -dv
@@ -21,29 +22,30 @@ import thingy.colour as colour
 # DONE: Don't use a fixed list of default branch names
 # DONE: If the config file isn't in the current directory then search up the directory tree for it but run in the current directory
 # DONE: Use the configuration file
+# DONE: When specifying list of working trees, if name doesn't contain '/' prefix it with '*'?
 # DONE: command to categorise working trees then command line filter to only act on working trees in category (in addition to other filtering options) - +tag <TAG> command tags all selected working trees and updates the configuration, +untag <TAG> command to remove tags in the same way
 # DONE: init function
+# NOPE: Clone to have option to update - as discussed, should be part of init
 # NOPE: Dry-run option - just pass the option to the Git command
 # NOPE: Is it going to be a problem if the same repo is checked out twice or more in the same workspace - user problem
 # NOPE: Pull/fetch - only output after running command and only if something updated
 # NOPE: Switch to tomlkit
-# TODO: -j option to run in parallel - yes, but it will only work with non-interactive Git commands
-# TODO: Command that takes partial working tree name and either returns full path or pops up window to autocomplete until single match found
-# TODO: Consistent colours in output
-# TODO: Option to +dir to return all matches so that caller can select one they want
-# TODO: Verbose option
-# TODO: When filtering by tag, if tag starts with '!' only match if tag isn't present (and don't allow '!' at start of tag otherwise)
-# DONE: When specifying list of working trees, if name doesn't contain '/' prefix it with '*'?
-# TODO: select_git_repos() and +dir should use consist way of selecting repos if possible
-# TODO: +run command to do things other than git commands
-# TODO: init option '--update' to update the configuration file with new working trees and remove ones that are no longer there
-# TODO: init option '--set-default' to update the default branch to the current one for specified working trees
-# TODO: If run in a subdirectory, only process working trees in that tree (or have an option to do so, or an option _not_ to do so; --all)
-# TODO: Ability to read default configuration options from ~/.config/thingy/multigit.rc - these are insert before argv[1] before argparse called
-# TODO: When we have something with multiple matches display a menu for user to select the one that they one - make it a library routine so can be used, for instance, for branch selection
-# TODO: Use pygit2
-# TODO: Use PathLib
-# TODO: Shell autocomplete for +dir
+# TODO: 2 .init option '--update' to update the configuration file with new working trees and remove ones that are no longer there
+# TODO: 2. +run command to do things other than git commands
+# TODO: 2. If run in a subdirectory, only process working trees in that tree (or have an option to do so, or an option _not_ to do so; --all)
+# TODO: 2. select_git_repos() and +dir should use consist way of selecting repos if possible
+# TODO: 3 .init option '--set-default' to update the default branch to the current one for specified working trees
+# TODO: 3. Ability to read default configuration options from ~/.config/thingy/multigit.rc - these are insert before argv[1] before argparse called
+# TODO: 3. Command that takes partial working tree name and either returns full path or pops up window to autocomplete until single match found
+# TODO: 3. Verbose option
+# TODO: 3. When filtering by tag or by repo name, if name starts with '!' only match if tag isn't present or repo name doesn't match (and don't allow '!' at start of tag otherwise)
+# TODO: 4. Option to +dir to return all matches so that caller can select one they want
+# TODO: 4. Shell autocomplete for +dir
+# TODO: 5. -j option to run in parallel - yes, but it will only work with non-interactive Git commands
+# TODO: 5. Consistent colours in output
+# TODO: 6. Use PathLib
+# TODO: 6. When we have something with multiple matches display a menu for user to select the one that they one - make it a library routine so can be used, for instance, for branch selection
+# TODO: 7. Use pygit2 directly
 ################################################################################
 
 DEFAULT_CONFIG_FILE = 'multigit.toml'
@@ -54,9 +56,11 @@ DEFAULT_CONFIG_FILE = 'multigit.toml'
 DEFAULT_BRANCH = 'DEFAULT'
 
 ################################################################################
+# Command line help - we aren't using argparse since it isn't flexible enough to handle arbtirary git
+# commands are parameters so we have to manually create the help and parse the command line
 
 HELP_INFO = """usage: multigit [-h] [--verbose] [--quiet] [--config CONFIG] [--repos REPOS] [--modified] [--branched] [--sub] [--tag TAGS]
-                {+init, +config, +dir, GIT_COMMAND} ...
+                {+clone, +init, +config, +dir, GIT_COMMAND} ...
 
 Run git commands in multiple Git repos. DISCLAIMER: This is beta-quality software, with missing features and liable to fail with a stack trace, but shouldn't eat your data
 
@@ -71,11 +75,12 @@ options:
   --modified, -m        Select repos that have local modifications
   --branched, -b        Select repos that do not have the default branch checked out
   --tag TAG, -t TAG     Select repos that have the specified tag (can be issued multiple times on the command line)
-  --continue, -C        Continue if a git command returns an error (by default, executation terminates when a command fails)
   --sub, -s             Select only the repos in the current directory and subdirectories
+  --continue, -C        Continue if a git command returns an error (by default, executation terminates when a command fails)
 
 Sub-commands:
-  {+init,+dir,+config,GIT_COMMAND}
+  {+clone, +init,+dir,+config, GIT_COMMAND}
+    +clone REPO {BRANCH} Clone a repo containing a multigit configuration file, then clone all the child repos and check out the default branch in each
     +init                Build or update the configuration file using the current branch in each repo as the default branch
     +config              Return the name and location of the configuration file
     +dir                 Return the location of a working tree, given the repo name, or if no parameter specified, the root directory of the multigit tree
@@ -136,6 +141,14 @@ def error(msg, status=1):
 
 ################################################################################
 
+def absolute_repo_path(args, relative_path=''):
+    """Given a path relative to the multigit configuration file, return
+       the absolute path thereto"""
+
+    return os.path.join(os.path.dirname(args.configuration_file), relative_path)
+
+################################################################################
+
 def find_configuration(default_config_file):
     """If the configuration file name has path elements, try and read it, otherwise
        search up the directory tree looking for the configuration file.
@@ -157,7 +170,8 @@ def find_configuration(default_config_file):
 ################################################################################
 
 def show_progress(width, msg):
-    """Show a single line progress message"""
+    """Show a single line progress message without moving the cursor to the next
+       line."""
 
     colour.write(msg[:width-1], newline=False, cleareol=True, cr=True)
 
@@ -176,20 +190,19 @@ def find_working_trees(args):
 
     for root, dirs, _ in os.walk(os.path.dirname(args.configuration_file)):
         if '.git' in dirs:
-            if root.startswith('./'):
-                root = root[2:]
+            relative_path = os.path.relpath(root)
 
             if args.repos:
                 for card in args.repos:
-                    if fnmatch.fnmatch(root, card):
-                        if root not in repos:
-                            yield root
-                            repos.add(root)
+                    if fnmatch.fnmatch(relative_path, card):
+                        if relative_path not in repos:
+                            yield relative_path
+                            repos.add(relative_path)
                         break
             else:
-                if root not in repos:
-                    yield root
-                    repos.add(root)
+                if relative_path not in repos:
+                    yield relative_path
+                    repos.add(relative_path)
 
 ################################################################################
 
@@ -250,7 +263,7 @@ def select_git_repos(args, config):
         # If subdirectories specified, only match if the repo is in the current directory tree
 
         if matching and args.subdirectories:
-            repo_path_rel = os.path.relpath(repo_path)
+            repo_path_rel = os.path.relpath(absolute_repo_path(args, repo_path))
 
             if repo_path_rel == '..' or repo_path_rel.startswith('../'):
                 matching = False
@@ -269,6 +282,77 @@ def branch_name(name, default_branch):
 
 ################################################################################
 
+def mg_clone(args, config, console):
+    """Clone a repo, optionally check out a branch and attempt to read the
+       configuration file and clone all the repos listed therein, checkouting
+       the default branch in each one"""
+
+    _ = console
+
+    # Sanity checks
+
+    if not args.parameters:
+        error('The "clone" subcommand takes 1 or 2 parameters - the repo to clone and, optionally, the branch to check out')
+
+    if args.branched or args.modified:
+        error('The "modified" and "branched" options cannot be used with the "clone" subcommand')
+
+    # Destination directory is the last portion of the repo URL with the extension removed
+
+    directory = os.path.splitext(os.path.basename(args.parameters[0]))[0]
+
+    if os.path.exists(directory):
+        if os.path.isdir(directory):
+            error(f'The "[BLUE:{directory}]" directory already exists')
+        else:
+            error(f'[BLUE:{directory}]" already exists')
+
+    # Clone the repo and chdir into it
+
+    if not args.quiet:
+        colour.write(f'Cloning [BOLD:{args.parameters[0]}] into [BLUE:{directory}]')
+
+    git.clone(args.parameters[0], path=directory)
+
+    os.chdir(directory)
+
+    # Optionally checkout a branch, if specified
+
+    if len(args.parameters) > 1:
+        git.checkout(args.parameters[1])
+
+    # Open the configuration file in the repo (if no configuration file has been specified, use the default)
+
+    if not args.configuration_file:
+        args.configuration_file = args.default_configuration_file
+
+    if not os.path.isfile(args.configuration_file):
+        error(f'Cannot find the configuration file: [BOLD:{args.default_configuration_file}]')
+
+    config.read(args.configuration_file)
+
+    # Now iterate through the repos, creating directories and cloning them and checking
+    # out the default branch
+
+    for repo in select_git_repos(args, config):
+        if repo.name != '.':
+            directory = os.path.dirname(repo.name)
+
+            if directory:
+                os.makedirs(directory, exist_ok=True)
+
+            if not args.quiet:
+                colour.write(f'Cloning [BOLD:{repo["origin"]}] into [BLUE:{directory}]')
+
+            git.clone(repo['origin'], path=repo.name)
+
+            if not args.quiet:
+                colour.write(f'    Checking out [BLUE:{repo["default branch"]}]')
+
+            git.checkout(repo['default branch'], path=repo.name)
+
+################################################################################
+
 def mg_init(args, config, console):
     """Create or update the configuration
        By default, it scans the tree for git directories and adds or updates them
@@ -289,6 +373,9 @@ def mg_init(args, config, console):
         repo_list.append(repo)
 
         if repo not in config:
+            # Add a new configuration entry containing the default branch, remote origin
+            # and name
+
             default_branch = git.branch(path=repo)
 
             config[repo] = {
@@ -331,14 +418,19 @@ def mg_dir(args, config, console):
        of the tree if not
        Returns an error unless there is a unique match"""
 
-    # DONE: Should return location relative to the current directory or as absolute path
-
     _ = console
     _ = config
 
     if len(args.parameters) > 1:
         error('The +dir command takes no more than one parameter - the name of the working tree to search for')
-    elif args.parameters:
+
+    if args.modified or args.branched or args.tag or args.subdirectories:
+        error('The "--tag", "--modified" "--sub", and "--branched" options cannot be used with the "dir" subcommand')
+
+    # If a parameter is specified, look for matches, otherwise just return the location of the
+    # configuration file
+
+    if args.parameters:
         location = []
         wild_prefix_location = []
         wild_location = []
@@ -377,7 +469,8 @@ def mg_dir(args, config, console):
             dest_list = "\n\t".join([os.path.relpath(d) for d in destination])
             error(f'Multiple matches with [BLUE:{search_name}]: \n\t{dest_list}')
 
-        colour.write(os.path.join(os.path.dirname(args.configuration_file), destination[0]))
+        colour.write(absolute_repo_path(args, destination[0]))
+
     else:
         colour.write(os.path.dirname(args.configuration_file))
 
@@ -445,17 +538,23 @@ def run_git_command(args, config, console):
     """Run a command in each of the working trees, optionally continuing if
        there's an error"""
 
-    _ = config
     _ = console
 
     for repo in select_git_repos(args, config):
         repo_command = [args.command]
+
+        # Replace 'DEFAULT' in the command with the default branch in the repo
+
         for cmd in args.parameters:
             repo_command.append(branch_name(cmd, repo['default branch']))
 
         colour.write(f'\n[BOLD:{os.path.relpath(repo.name)}]\n')
 
-        _, status = git.git_run_status(repo_command, path=repo.name, redirect=False)
+        # Run the command in the workng tree
+
+        repo_path = absolute_repo_path(args, repo.name)
+
+        _, status = git.git_run_status(repo_command, path=repo_path, redirect=False)
 
         if status and not args.error_continue:
             sys.exit(status)
@@ -479,7 +578,7 @@ def parse_command_line():
             for c in arg[1:]:
                 argv.append('-' + c)
 
-    # Parse the command line
+    # Parse the command line, setting options in the args dataclass appropriately
 
     i = 1
     while i < len(argv):
@@ -525,7 +624,7 @@ def parse_command_line():
             args.error_continue = True
 
         elif param in ('--help', '-h'):
-            print(HELP_INFO)
+            colour.write(HELP_INFO)
             sys.exit(0)
 
         elif param[0] == '-':
@@ -549,8 +648,12 @@ def parse_command_line():
     except IndexError:
         error('Missing command')
 
+    # Save the command parameters
+
     args.parameters = argv[i+1:]
 
+    # Locate the configuration file
+
     args.configuration_file = find_configuration(args.default_configuration_file)
 
     return args
@@ -558,16 +661,20 @@ def parse_command_line():
 ################################################################################
 
 COMMANDS = {
-   'init': mg_init,
-   'dir': mg_dir,
-   'config': mg_config,
-   'tag': mg_tag,
-   'untag': mg_untag,
+    'clone': mg_clone,
+    'init': mg_init,
+    'dir': mg_dir,
+    'config': mg_config,
+    'tag': mg_tag,
+    'untag': mg_untag,
 }
 
 def main():
     """Main function"""
 
+    # Parse the command line and santity check the command to run
+    # (if it is an external command we let git worry about it)
+
     args = parse_command_line()
 
     if args.internal_command and args.command not in COMMANDS:
@@ -582,12 +689,13 @@ def main():
     # Otherwise, fail if we can't find the configuration file.
 
     if not args.configuration_file:
-        if args.internal_command and args.command == 'init':
-            args.configuration_file = os.path.abspath(args.default_configuration_file)
+        if args.internal_command:
+            if args.command == 'init':
+                args.configuration_file = os.path.abspath(args.default_configuration_file)
         else:
             error('Cannot locate configuration file')
 
-    if os.path.isfile(args.configuration_file):
+    if args.configuration_file and os.path.isfile(args.configuration_file):
         config.read(args.configuration_file)
 
     # Get the console size

{skilleter_thingy-0.1.2 → skilleter_thingy-0.1.3}/skilleter_thingy/thingy/git2.py

@@ -109,13 +109,13 @@ def git_run_status(cmd, stdout=None, stderr=None, path=None, redirect=True):
 
 ################################################################################
 
-def clone(reponame, directory=None):
+def clone(reponame, path=None):
     """ Clone a repo """
 
     cmd = ['clone', reponame]
 
-    if directory:
-        cmd.append(directory)
+    if path:
+        cmd.append(path)
 
     return git(cmd)
 

{skilleter_thingy-0.1.2 → skilleter_thingy-0.1.3}/skilleter_thingy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: skilleter_thingy
-Version: 0.1.2
+Version: 0.1.3
 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
@@ -89,6 +89,8 @@ The command takes a number of options that can be used to select the list of wor
 
 `--tag TAG` / `-t TAG` Run only in working trees that are tagged with the specified tag
 
+`--subdir` / `-s` Run only in working trees that are in the current directory tree.
+
 These options are AND-ed together, so specifying `--modified --branched --tag WOMBAT` will select only working trees that are modified AND branched AND tagged with `WOMBAT`, but the parameters to the `--repos` and `--tag` options are OR-ed together, so specifying `--tag WOMBAT --tag EMU` will select repos that are tagged as `WOMBAT` *OR* `EMU`.
 
 Multigit tags are stored in the configuration file, not within the working tree and each working tree can have multiple tags.
@@ -97,6 +99,8 @@ Multigit tags are stored in the configuration file, not within the working tree
 
 Multigit supports a small list of subcommands, each of which are prefixed with a `+` to distinguish them from Git commands:
 
+`+clone` - Clone a repo containing a multigit configuration file then clone all the repos specified in the configuration, checking out the default branch in each one.
+
 `+init` - Create or update the configuration file
 
 `+dir` - Given the name of a working tree, output the location within the multigit tree of that working tree if the name matches uniquely, or the name of the directory where the multigit configuration file resides if no parameter is specified.