skilleter-thingy 0.1.25__tar.gz → 0.1.27__tar.gz

{skilleter_thingy-0.1.25 → skilleter_thingy-0.1.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: skilleter_thingy
-Version: 0.1.25
+Version: 0.1.27
 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
@@ -104,7 +104,7 @@ 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.
+`+clone REPO <BRANCH>` - Clone REPO (which should contain a multigit configuration file), checking out BRANCH, if specified, then clone all the repos specified in the configuration, checking out the default branch in each one.
 
 `+init` - Create or update the configuration file
 
@@ -118,6 +118,10 @@ Multigit supports a small list of subcommands, each of which are prefixed with a
 
 `+untag TAG` - Remove the tag from the specified working trees (do nothing if the tag is not applied in the first place).
 
+`+run COMMAND` - Run the specified command in each of the specified working trees
+
+`+add REPO DIR` - Clone REPO into the DIR directory and, if successful, add it to the multigit configuration
+
 Any command *not* prefixed with `+` is run in each of the working trees (filtered by the various multigit options) as a git command.
 
 For example; `multigit -m commit -ab` would run `git commit -a` in each of the working trees that is branched and contains modified files.

{skilleter_thingy-0.1.25 → skilleter_thingy-0.1.27}/README.md

@@ -81,7 +81,7 @@ 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.
+`+clone REPO <BRANCH>` - Clone REPO (which should contain a multigit configuration file), checking out BRANCH, if specified, then clone all the repos specified in the configuration, checking out the default branch in each one.
 
 `+init` - Create or update the configuration file
 
@@ -95,6 +95,10 @@ Multigit supports a small list of subcommands, each of which are prefixed with a
 
 `+untag TAG` - Remove the tag from the specified working trees (do nothing if the tag is not applied in the first place).
 
+`+run COMMAND` - Run the specified command in each of the specified working trees
+
+`+add REPO DIR` - Clone REPO into the DIR directory and, if successful, add it to the multigit configuration
+
 Any command *not* prefixed with `+` is run in each of the working trees (filtered by the various multigit options) as a git command.
 
 For example; `multigit -m commit -ab` would run `git commit -a` in each of the working trees that is branched and contains modified files.

{skilleter_thingy-0.1.25 → skilleter_thingy-0.1.27}/pyproject.toml

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

{skilleter_thingy-0.1.25 → skilleter_thingy-0.1.27}/skilleter_thingy/multigit.py

@@ -6,6 +6,7 @@ import os
 import sys
 import fnmatch
 import configparser
+import subprocess
 
 from dataclasses import dataclass, field
 
@@ -27,6 +28,8 @@ import thingy.colour as colour
 # 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
 # DONE Consistent colours in output
+# DONE:+run command to do things other than git commands
+# DONE: Command that takes partial working tree name and either returns full path or pops up window to autocomplete until single match found - returns list of paths you can pipe into fzf
 #
 # 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
@@ -36,14 +39,12 @@ import thingy.colour as colour
 # NOPE: Use PathLib - Don't really see the need
 # NOPE: 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 - Use fzf
 # NOPE: Use pygit2 directly - don't see the need
+# NOPE: .init option '--update' to update the configuration file with new working trees and remove ones that are no longer there - init does the removal, and added the '+add' command instead
+# NOPE: Ability to read default configuration options from ~/.config/thingy/multigit.rc - these are insert before argv[1] before argparse called - limited use for this
 #
-# 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: 3. (alternative to above) A '--not' option that inverts all the matching criteria, so '--not --branched --modified' selects all unmodified repos which aren't branched
@@ -66,7 +67,7 @@ DEFAULT_BRANCH = 'DEFAULT'
 # commands are parameters so we have to manually create the help and parse the command line
 
 HELP_INFO = """usage: multigit [--help|-h] [--verbose|-v] [--quiet|-q] [--config|-c CONFIG] [--repos|-r REPOS] [--modified|-m] [--branched|-b] [--sub|-s] [--tag|-t TAGS] [--continue|-o] [--path|-C PATH]
-                {+clone, +init, +config, +dir, +list, GIT_COMMAND} ...
+                {+clone, +init, +config, +dir, +list, +run, +add, 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
 
@@ -86,7 +87,7 @@ options:
   --path, -C PATH       Run as if the command was started in PATH instead of the current working directory
 
 Sub-commands:
-  {+clone, +init, +dir, +config, +list, GIT_COMMAND}
+  {+clone, +init, +dir, +config, +list, +run, +add, 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
@@ -94,6 +95,8 @@ Sub-commands:
     +list                Return a list of the top level directories of each of the Git repos
     +tag TAG             Apply a configuration tag to repos filtered by the command line options (list configuration tags if no parameter specified)
     +untag TAG           Remove a configuration tag to repos filtered by the command line options
+    +run COMMAND         Run the specified command in repos filtered by the command line options
+    +add REPO DIR        Clone REPO into the DIR directory and add it to the multigit configuration
     GIT_COMMAND          Any git command, including options and parameters - this is then run in all specified working trees
 
 """
@@ -308,9 +311,37 @@ def branch_name(name, default_branch):
 
 ################################################################################
 
+def add_new_repo(args, config, repo):
+    """Add a new configuration entry containing the default branch, remote origin
+    (if there is one) and name"""
+
+    abs_repo_path = absolute_repo_path(args, repo)
+
+    config[repo] = {}
+
+    default_branch = git.branch(path=abs_repo_path)
+
+    if not default_branch:
+        colour.error(f'Unable to determine default branch in [BLUE:{repo}]', prefix=True)
+
+    config[repo]['default branch'] = default_branch
+
+    remote = git.remotes(path=abs_repo_path)
+
+    if 'origin' in remote:
+        config[repo]['origin'] = remote['origin']
+        config[repo]['repo name'] = os.path.basename(remote['origin']).removesuffix('.git')
+    else:
+        config[repo]['repo name'] = os.path.basename(repo)
+
+    if not args.quiet:
+        colour.write(f'Added [BLUE:{repo}] with default branch [BLUE:{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
+       multigit configuration file and clone all the repos listed therein, checkouting
        the default branch in each one"""
 
     _ = console
@@ -399,29 +430,7 @@ 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
-            # (if there is one) and name
-
-            abs_repo_path = absolute_repo_path(args, repo)
-
-            config[repo] = {}
-
-            default_branch = git.branch(path=abs_repo_path)
-
-            if not default_branch:
-                colour.error(f'Unable to determine default branch in [BLUE:{repo}]', prefix=True)
-
-            config[repo]['default branch'] = default_branch
-
-            remote = git.remotes(path=abs_repo_path)
-
-            if 'origin' in remote:
-                config[repo]['origin'] = remote['origin']
-                config[repo]['repo name'] = os.path.basename(remote['origin']).removesuffix('.git')
-            else:
-                config[repo]['repo name'] = os.path.basename(repo)
-
-            colour.write(f'Added [BLUE:{repo}] with default branch [BLUE:{default_branch}]')
+            add_new_repo(args, config, repo)
 
     if not args.quiet:
         colour.write(cleareol=True)
@@ -444,6 +453,39 @@ def mg_init(args, config, console):
 
 ################################################################################
 
+def mg_add(args, config, console):
+    """Add a new repo - takes 2 parameters; the repo to clone and the directory
+       to clone it into. If successful, adds the repo to the configuration"""
+
+    _ = console
+    _ = config
+
+    verbose(args, f'add: Parameters: {", ".join(args.parameters)}')
+
+    if len(args.parameters) != 2:
+        colour.error('The "[BOLD:+add]" command takes two parameters; the repo to clone the location to clone it into', prefix=True)
+
+    if args.modified or args.branched or args.tag or args.subdirectories:
+        colour.error('The "[BOLD:--tag]", "[BOLD:--modified]" "[BOLD:--sub]", and "[BOLD:--branched]" options cannot be used with the "[BOLD:+add]" subcommand', prefix=True)
+
+    repo = args.parameters[0]
+    location = args.parameters[1]
+
+    if os.path.exists(location):
+        colour.error(f'"[BLUE:{location}]" already exists', prefix=True)
+
+    git.clone(repo, path=location)
+
+    # Add to the configuration
+
+    add_new_repo(args, config, location)
+
+    # The configuration file needs to be updated
+
+    args.config_modified = True
+
+################################################################################
+
 def mg_dir(args, config, console):
     """Return the location of a working tree, given the name, or the root directory
        of the tree if not
@@ -571,12 +613,43 @@ def mg_list(args, config, console):
 
 ################################################################################
 
-def run_git_command(args, config, console):
+def mg_run(args, config, console):
     """Run a command in each of the working trees, optionally continuing if
        there's an error"""
 
     _ = console
 
+    if not args.parameters:
+        colour.error('[BOLD:+run] command - missing parameter(s)')
+
+    # Run the command in each of the working trees
+
+    for repo in select_git_repos(args, config):
+        if not args.quiet:
+            colour.write(f'\n[BLUE:{os.path.relpath(repo.name)}]\n')
+
+        repo_path = absolute_repo_path(args, repo.name)
+
+        try:
+            status = subprocess.run(args.parameters, cwd=repo_path, check=False)
+        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)
+
+################################################################################
+
+def run_git_command(args, config, console):
+    """Run a Git command in each of the working trees, optionally continuing if
+       there's an error"""
+
+    _ = console
+
     for repo in select_git_repos(args, config):
         repo_command = [args.command]
 
@@ -585,9 +658,10 @@ def run_git_command(args, config, console):
         for cmd in args.parameters:
             repo_command.append(branch_name(cmd, repo['default branch']))
 
-        colour.write(f'\n[BLUE:{os.path.relpath(repo.name)}]\n')
+        if not args.quiet:
+            colour.write(f'\n[BLUE:{os.path.relpath(repo.name)}]\n')
 
-        # Run the command in the workng tree
+        # Run the command in the working tree
 
         repo_path = absolute_repo_path(args, repo.name)
 
@@ -680,11 +754,12 @@ def parse_command_line():
                     colour.error('The "[BOLD:--path]" option takes a path parameter')
 
                 try:
-                    os.chdir(arg_list.pop(0))
+                    workingdir = arg_list.pop(0)
+                    os.chdir(workingdir)
                 except IndexError:
                     colour.error('The "[BOLD:-C]" option takes a path parameter', prefix=True)
                 except FileNotFoundError:
-                    colour.error('"[BOLD:--path]" - path not found', prefix=True)
+                    colour.error(f'"[BOLD:--path]" - path "[BLUE:{workingdir}]" not found', prefix=True)
 
             elif option in ('help', 'h'):
                 colour.write(HELP_INFO)
@@ -729,6 +804,8 @@ COMMANDS = {
     'tag': mg_tag,
     'untag': mg_untag,
     'list': mg_list,
+    'run': mg_run,
+    'add': mg_add,
 }
 
 def main():
@@ -811,6 +888,8 @@ def multigit():
 
     except git.GitError as exc:
         sys.stderr.write(exc.msg)
+        sys.stderr.write('\n')
+
         sys.exit(exc.status)
 
 ################################################################################

{skilleter_thingy-0.1.25 → skilleter_thingy-0.1.27}/skilleter_thingy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: skilleter_thingy
-Version: 0.1.25
+Version: 0.1.27
 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
@@ -104,7 +104,7 @@ 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.
+`+clone REPO <BRANCH>` - Clone REPO (which should contain a multigit configuration file), checking out BRANCH, if specified, then clone all the repos specified in the configuration, checking out the default branch in each one.
 
 `+init` - Create or update the configuration file
 
@@ -118,6 +118,10 @@ Multigit supports a small list of subcommands, each of which are prefixed with a
 
 `+untag TAG` - Remove the tag from the specified working trees (do nothing if the tag is not applied in the first place).
 
+`+run COMMAND` - Run the specified command in each of the specified working trees
+
+`+add REPO DIR` - Clone REPO into the DIR directory and, if successful, add it to the multigit configuration
+
 Any command *not* prefixed with `+` is run in each of the working trees (filtered by the various multigit options) as a git command.
 
 For example; `multigit -m commit -ab` would run `git commit -a` in each of the working trees that is branched and contains modified files.