skilleter-thingy 0.0.87__tar.gz → 0.0.88__tar.gz

{skilleter_thingy-0.0.87/skilleter_thingy.egg-info → skilleter_thingy-0.0.88}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: skilleter_thingy
-Version: 0.0.87
+Version: 0.0.88
 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
@@ -33,7 +33,56 @@ The following commands are documented in detail in the help output that can be d
 
 This README just contains a summary of the functionality of each command.
 
-# Git Utilities
+# Git Repo Management
+
+## multigit
+
+Manage a collection of related git working trees.
+
+This is intended for use in a situation where you have a collection of related git working trees organised in a directory hierarchy and not necessarily managed using git submodules or any other tool. It allows you to run git commands on multiple working trees at once, without navigating around the different working trees to do so.
+
+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 and location.
+
+By default, when a multigit command, other than `init` is run, it runs a git command in each of the working trees. The command takes a number of options that can be used to select the list of working trees that each of the subcommands that it supports runs in:
+
+*--repos / -r* Allows a list of working trees to be specfied, either as the full or relative path, the name or a wildcard.
+
+*--modified / -m* Run only in working trees containing locally modified files
+
+*--branched / -b* Run only working trees where the current branch that is checked out is NOT the default branch
+
+# TODO - Do we actually need any commands other than init, dir, config as everything else can be done via run?
+# TODO - Could just make the commands multigit +init/+dir/+config and then for anything else, just pass the whole of the command line to git once we've parsed the default branch?
+
+Multigit supports a (growing) list of subcommands:
+
+*init* - Create or update the configuration file
+
+*status* - Run `git status` in each of the working trees.
+
+*fetch* - Run `git fetch` in each of the working trees
+
+*pull* - Run `git pull` in each of the working trees
+
+*push* - Run `git push` in each of the working trees
+
+*co*
+
+*commit*
+
+*update*
+
+*clean*
+
+*dir*
+
+*config*
+
+*review*
+
+*run*
+
+# Miscellaneous Git Utilities
 
 ## ggit
 
@@ -47,6 +96,10 @@ Run 'git grep' in all repos under the current directory (note that this is not r
 
 Output a string containing colour-coded shell nesting level, current directory and git working tree status (used in the shell prompt).
 
+# Git Extensions
+
+Due to the way that the git command works, these can be run as they were additional git subcommands
+
 ## git ca
 
 Improved version of 'git commit --amend'. Updates files that are already in the commit and, optionally, adds and commits additional files.
@@ -75,10 +128,6 @@ Output the top level directory of the git working tree or return an error if we
 
 Console-based git change review tool.
 
-## multigit
-
-Manage a collection of related git repoitories.
-
 ## GitLab Commands
 
 ### git mr

{skilleter_thingy-0.0.87 → skilleter_thingy-0.0.88}/README.md

@@ -12,7 +12,56 @@ The following commands are documented in detail in the help output that can be d
 
 This README just contains a summary of the functionality of each command.
 
-# Git Utilities
+# Git Repo Management
+
+## multigit
+
+Manage a collection of related git working trees.
+
+This is intended for use in a situation where you have a collection of related git working trees organised in a directory hierarchy and not necessarily managed using git submodules or any other tool. It allows you to run git commands on multiple working trees at once, without navigating around the different working trees to do so.
+
+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 and location.
+
+By default, when a multigit command, other than `init` is run, it runs a git command in each of the working trees. The command takes a number of options that can be used to select the list of working trees that each of the subcommands that it supports runs in:
+
+*--repos / -r* Allows a list of working trees to be specfied, either as the full or relative path, the name or a wildcard.
+
+*--modified / -m* Run only in working trees containing locally modified files
+
+*--branched / -b* Run only working trees where the current branch that is checked out is NOT the default branch
+
+# TODO - Do we actually need any commands other than init, dir, config as everything else can be done via run?
+# TODO - Could just make the commands multigit +init/+dir/+config and then for anything else, just pass the whole of the command line to git once we've parsed the default branch?
+
+Multigit supports a (growing) list of subcommands:
+
+*init* - Create or update the configuration file
+
+*status* - Run `git status` in each of the working trees.
+
+*fetch* - Run `git fetch` in each of the working trees
+
+*pull* - Run `git pull` in each of the working trees
+
+*push* - Run `git push` in each of the working trees
+
+*co*
+
+*commit*
+
+*update*
+
+*clean*
+
+*dir*
+
+*config*
+
+*review*
+
+*run*
+
+# Miscellaneous Git Utilities
 
 ## ggit
 
@@ -26,6 +75,10 @@ Run 'git grep' in all repos under the current directory (note that this is not r
 
 Output a string containing colour-coded shell nesting level, current directory and git working tree status (used in the shell prompt).
 
+# Git Extensions
+
+Due to the way that the git command works, these can be run as they were additional git subcommands
+
 ## git ca
 
 Improved version of 'git commit --amend'. Updates files that are already in the commit and, optionally, adds and commits additional files.
@@ -54,10 +107,6 @@ Output the top level directory of the git working tree or return an error if we
 
 Console-based git change review tool.
 
-## multigit
-
-Manage a collection of related git repoitories.
-
 ## GitLab Commands
 
 ### git mr

{skilleter_thingy-0.0.87 → skilleter_thingy-0.0.88}/pyproject.toml

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

{skilleter_thingy-0.0.87 → skilleter_thingy-0.0.88}/skilleter_thingy/multigit.py

@@ -507,7 +507,7 @@ def mg_run(args, config, console):
     if len(args.cmd) == 0:
         error('No command specified')
     elif len(args.cmd) == 1:
-        command = shlex.split(args.cmd)
+        command = shlex.split(args.cmd[0])
     else:
         command = args.cmd
 

{skilleter_thingy-0.0.87 → skilleter_thingy-0.0.88/skilleter_thingy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: skilleter_thingy
-Version: 0.0.87
+Version: 0.0.88
 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
@@ -33,7 +33,56 @@ The following commands are documented in detail in the help output that can be d
 
 This README just contains a summary of the functionality of each command.
 
-# Git Utilities
+# Git Repo Management
+
+## multigit
+
+Manage a collection of related git working trees.
+
+This is intended for use in a situation where you have a collection of related git working trees organised in a directory hierarchy and not necessarily managed using git submodules or any other tool. It allows you to run git commands on multiple working trees at once, without navigating around the different working trees to do so.
+
+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 and location.
+
+By default, when a multigit command, other than `init` is run, it runs a git command in each of the working trees. The command takes a number of options that can be used to select the list of working trees that each of the subcommands that it supports runs in:
+
+*--repos / -r* Allows a list of working trees to be specfied, either as the full or relative path, the name or a wildcard.
+
+*--modified / -m* Run only in working trees containing locally modified files
+
+*--branched / -b* Run only working trees where the current branch that is checked out is NOT the default branch
+
+# TODO - Do we actually need any commands other than init, dir, config as everything else can be done via run?
+# TODO - Could just make the commands multigit +init/+dir/+config and then for anything else, just pass the whole of the command line to git once we've parsed the default branch?
+
+Multigit supports a (growing) list of subcommands:
+
+*init* - Create or update the configuration file
+
+*status* - Run `git status` in each of the working trees.
+
+*fetch* - Run `git fetch` in each of the working trees
+
+*pull* - Run `git pull` in each of the working trees
+
+*push* - Run `git push` in each of the working trees
+
+*co*
+
+*commit*
+
+*update*
+
+*clean*
+
+*dir*
+
+*config*
+
+*review*
+
+*run*
+
+# Miscellaneous Git Utilities
 
 ## ggit
 
@@ -47,6 +96,10 @@ Run 'git grep' in all repos under the current directory (note that this is not r
 
 Output a string containing colour-coded shell nesting level, current directory and git working tree status (used in the shell prompt).
 
+# Git Extensions
+
+Due to the way that the git command works, these can be run as they were additional git subcommands
+
 ## git ca
 
 Improved version of 'git commit --amend'. Updates files that are already in the commit and, optionally, adds and commits additional files.
@@ -75,10 +128,6 @@ Output the top level directory of the git working tree or return an error if we
 
 Console-based git change review tool.
 
-## multigit
-
-Manage a collection of related git repoitories.
-
 ## GitLab Commands
 
 ### git mr