skilleter-thingy 0.0.96__tar.gz → 0.0.98__tar.gz

{skilleter_thingy-0.0.96/skilleter_thingy.egg-info → skilleter_thingy-0.0.98}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: skilleter_thingy
-Version: 0.0.96
+Version: 0.0.98
 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
@@ -36,53 +36,59 @@ This README just contains a summary of the functionality of each command.
 
 # Git Repo Management
 
-## multigit
+## Multigit
 
-Manage a collection of related git working trees.
+Multigit is a tool for managing 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.
+This is intended for use in a situation where you have a collection of related git working trees organised in a directory hierarchy which aren't 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 and to select which working trees commands are run in.
+
+## Initialisation
 
 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.
 
+## Multigit Command Line
+
 The multigit command line format is:
 
     multigit OPTIONS COMMAND
 
-Where COMMAND is an internal multigit command if it starts with a '+' and is a git command otherwise.
+Where COMMAND is an internal multigit command if it starts with a `+` and is a git command otherwise (including the additional git commands described in this document).
 
 By default, when multigit is invoked with a git command, it runs a the command in each of the working trees selected by the command line options passed to multigit (if no options are specified then the command is run in *all* 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 REPO / -r REPO* Allows a list of working trees to be specfied, either by path, name or a wildcard matching either.
+`--repos REPO` / `-r REPO` Allows a list of working trees to be specfied, either by path, name or a wildcard matching either.
 
-*--modified / -m* Run only in working trees containing locally modified files
+`--modified` / `-m` Run only in working trees containing locally modified files
 
-*--branched / -b* Run only in working trees where the current branch that is checked out is NOT the default branch
+`--branched` / `-b` Run only in working trees where the current branch that is checked out is NOT the default branch
 
-*--tag TAG / -t TAG* Run only in working trees that are tagged with the specified tag
+`--tag TAG` / `-t TAG` Run only in working trees that are tagged with the specified tag
 
-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`.
+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.
 
+## Multigit Commands
+
 Multigit supports a small list of subcommands, each of which are prefixed with a `+` to distinguish them from Git commands:
 
-*+init* - Create or update the configuration file
+`+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.
+`+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.
 
-*+config* - Print the name and location of the multigit configuration file.
+`+config` - Print the name and location of the multigit configuration file.
 
-*+tag TAG* - If no tag specified list tags applied to the specified working trees. If a tag *is* specified, then *apply* the tag to the specified working trees.
+`+tag TAG` - If no tag specified list tags applied to the specified working trees. If a tag *is* specified, then *apply* the tag to the specified working trees.
 
-*+untag TAG* - Remove the tag from the specified working trees (do nothing if the tag is not applied in the first place).
+`+untag TAG` - Remove the tag from the specified working trees (do nothing if the tag is not applied in the first place).
 
-Any command not prefixed with '+' is run in each of the working trees (filtered by the various multigit options) as a git command.
+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.
 
-The `+dir` command can be used with shell aliases (or their equivalent in the user's shell of choice) to create an alias to run, for example, `cd (multigit +dir "$@")` (Bash) or `cd (multigit +dir $argv)` (for the Fish shell) that would cd to the top level direcory.
+The `+dir` command can be used with shell aliases (or their equivalent in the user's shell of choice) to create an alias to run, for example, `cd (multigit +dir "$@")` (Bash) or `cd (multigit +dir $argv)` (for the Fish shell) that would cd to the top level directory.
 
 # Miscellaneous Git Utilities
 
@@ -92,23 +98,96 @@ Output a string containing colour-coded shell nesting level, current directory a
 
 # Git Extensions
 
-Due to the way that the git command works, these can be run as they were additional git subcommands.
+Due to the way that the git command works, these can be run as they were additional git subcommands, although, due to a limitation in git, the only things that does not work is the `--help` option where the command has to be run with a hyphen between `git` and the subcommand - for example `git ca --help` does not work, but `git-ca --help` does.
+
+## Branch Names
+
+Where one of the git extensions takes an existing branch name as a parameter, the branch name can be abbreviated and the abbreviated form is expanded according to the following rules:
+
+* If the specified branch name exactly matches an existing branch, tag or commit ID then that is used (this includes remote branches where appropriate, if no local branches match).
+* Otherwise, the branch name is compared to existing branches (again, including remote branches where appropriate, if no local branches match) and, if the specified name uniquely partially matches an existing branch (optionally using `*` and `?` wildcard characters) that branch is used. If it matches multiple branches than an error is reported.
+
+For example, given a repo with the following branches:
+
+        origin/wombat
+        origin/platypus
+        wombat
+        emu
+        battery
+        chaos
+
+Then:
+
+* 'emu' will match 'emu'
+* 'wombat' will match 'wombat' but not 'origin/wombat' since the local branch takes precedence
+* 'at' will match both 'wombat' and 'battery' and will report an error
+* 'pus' will match 'origin/platypus'
+
+This is most useful where branches contain ticket numbers so, for instance given a branch called `feature/SKIL-103` you can check it out using `git co 103` assuming no other local branches contain `103` in their name.
+
+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 ca
 
 Improved version of 'git commit --amend'. Updates files that are already in the commit and, optionally, adds and commits additional files.
 
+        usage: git-ca [-h] [--added] [--all] [--everything] [--ignored] [--patch] [--verbose] [--dry-run] [files ...]
+
+        positional arguments:
+          files             List of files to add to the commit
+
+        options:
+          -h, --help        show this help message and exit
+          --added, -A       Update files in the current commit, including files added with `git add`
+          --all, -a         Append all locally-modified, tracked files to the current commit
+          --everything, -e  Append all modified and untracked files to the current commit (implies `~--all`)
+          --ignored, -i     Include files normally hidden by `.gitignore`
+          --patch, -p       Use the interactive patch selection interface to chose which changes to commit.
+          --verbose, -v     Verbose mode
+          --dry-run, -D     Dry-run
+
 ## git cleanup
 
 List or delete branches that have already been merged and delete tracking branches that are no longer on the remote.
 
+        git-cleanup [-h] [--delete] [--master MASTER] [--force] [--unmerged] [--yes] [--debug] [branches ...]
+
+        positional arguments:
+
+        branches              List of branches to check (default is all branches)
+
+        options:
+        -h, --help            show this help message and exit
+        --delete, -d          Delete all branches that have been merged
+        --master MASTER, -m MASTER, --main MASTER
+                              Specify the master branch (Attempts to read this from GitLab or defaults to "develop" if present or "master" or "main" otherwise
+        --force, -f           Allow protected branches (e.g. master) to be removed
+        --unmerged, -u        List branches that have NOT been merged
+        --yes, -y             Assume "yes" in response to any prompts (e.g. to delete branches)
+        --debug               Enable debug output
+
 ## git co
 
-Equivalent to 'git checkout' but with intelligent branch matching, so specifying a partial branch name will work if it uniquely matches an existing branch
+Equivalent to `git checkout` but with enhanced branch matching as described above. The command does not support the full range of options supported by the `git checkout` comamnd which should still be used where additional functionality is required.
+
+        git-co [-h] [--branch] [--update] [--rebase] [--force] [--exact] [--debug] branchname
+
+        positional arguments:
+
+        branchname    The branch name (or a partial name that matches uniquely against a local branch, remote branch, commit ID or tag)
+
+        options:
+        -h, --help    show this help message and exit
+        --branch, -b  Create the specified branch
+        --update, -u  If a remote branch exists, delete any local branch and check out the remote version
+        --rebase, -r  Rebase the branch onto its parent after checking it out
+        --force, -f   When using the update option, recreate the local branch even if it is owned by the current user (based on the author of the most recent commit)
+        --exact, -e   Do not use branch name matching - check out the branch as specified (if it exists)
+        --debug       Enable debug output
 
 ## git parent
 
-Attempt to determine the parent branch for the specified branch (defaulting to the current one)
+Attempt to determine the parent branch for the specified branch (defaulting to the current one).
 
 ## git update
 

{skilleter_thingy-0.0.96 → skilleter_thingy-0.0.98}/README.md

@@ -14,53 +14,59 @@ This README just contains a summary of the functionality of each command.
 
 # Git Repo Management
 
-## multigit
+## Multigit
 
-Manage a collection of related git working trees.
+Multigit is a tool for managing 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.
+This is intended for use in a situation where you have a collection of related git working trees organised in a directory hierarchy which aren't 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 and to select which working trees commands are run in.
+
+## Initialisation
 
 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.
 
+## Multigit Command Line
+
 The multigit command line format is:
 
     multigit OPTIONS COMMAND
 
-Where COMMAND is an internal multigit command if it starts with a '+' and is a git command otherwise.
+Where COMMAND is an internal multigit command if it starts with a `+` and is a git command otherwise (including the additional git commands described in this document).
 
 By default, when multigit is invoked with a git command, it runs a the command in each of the working trees selected by the command line options passed to multigit (if no options are specified then the command is run in *all* 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 REPO / -r REPO* Allows a list of working trees to be specfied, either by path, name or a wildcard matching either.
+`--repos REPO` / `-r REPO` Allows a list of working trees to be specfied, either by path, name or a wildcard matching either.
 
-*--modified / -m* Run only in working trees containing locally modified files
+`--modified` / `-m` Run only in working trees containing locally modified files
 
-*--branched / -b* Run only in working trees where the current branch that is checked out is NOT the default branch
+`--branched` / `-b` Run only in working trees where the current branch that is checked out is NOT the default branch
 
-*--tag TAG / -t TAG* Run only in working trees that are tagged with the specified tag
+`--tag TAG` / `-t TAG` Run only in working trees that are tagged with the specified tag
 
-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`.
+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.
 
+## Multigit Commands
+
 Multigit supports a small list of subcommands, each of which are prefixed with a `+` to distinguish them from Git commands:
 
-*+init* - Create or update the configuration file
+`+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.
+`+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.
 
-*+config* - Print the name and location of the multigit configuration file.
+`+config` - Print the name and location of the multigit configuration file.
 
-*+tag TAG* - If no tag specified list tags applied to the specified working trees. If a tag *is* specified, then *apply* the tag to the specified working trees.
+`+tag TAG` - If no tag specified list tags applied to the specified working trees. If a tag *is* specified, then *apply* the tag to the specified working trees.
 
-*+untag TAG* - Remove the tag from the specified working trees (do nothing if the tag is not applied in the first place).
+`+untag TAG` - Remove the tag from the specified working trees (do nothing if the tag is not applied in the first place).
 
-Any command not prefixed with '+' is run in each of the working trees (filtered by the various multigit options) as a git command.
+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.
 
-The `+dir` command can be used with shell aliases (or their equivalent in the user's shell of choice) to create an alias to run, for example, `cd (multigit +dir "$@")` (Bash) or `cd (multigit +dir $argv)` (for the Fish shell) that would cd to the top level direcory.
+The `+dir` command can be used with shell aliases (or their equivalent in the user's shell of choice) to create an alias to run, for example, `cd (multigit +dir "$@")` (Bash) or `cd (multigit +dir $argv)` (for the Fish shell) that would cd to the top level directory.
 
 # Miscellaneous Git Utilities
 
@@ -70,23 +76,96 @@ Output a string containing colour-coded shell nesting level, current directory a
 
 # Git Extensions
 
-Due to the way that the git command works, these can be run as they were additional git subcommands.
+Due to the way that the git command works, these can be run as they were additional git subcommands, although, due to a limitation in git, the only things that does not work is the `--help` option where the command has to be run with a hyphen between `git` and the subcommand - for example `git ca --help` does not work, but `git-ca --help` does.
+
+## Branch Names
+
+Where one of the git extensions takes an existing branch name as a parameter, the branch name can be abbreviated and the abbreviated form is expanded according to the following rules:
+
+* If the specified branch name exactly matches an existing branch, tag or commit ID then that is used (this includes remote branches where appropriate, if no local branches match).
+* Otherwise, the branch name is compared to existing branches (again, including remote branches where appropriate, if no local branches match) and, if the specified name uniquely partially matches an existing branch (optionally using `*` and `?` wildcard characters) that branch is used. If it matches multiple branches than an error is reported.
+
+For example, given a repo with the following branches:
+
+        origin/wombat
+        origin/platypus
+        wombat
+        emu
+        battery
+        chaos
+
+Then:
+
+* 'emu' will match 'emu'
+* 'wombat' will match 'wombat' but not 'origin/wombat' since the local branch takes precedence
+* 'at' will match both 'wombat' and 'battery' and will report an error
+* 'pus' will match 'origin/platypus'
+
+This is most useful where branches contain ticket numbers so, for instance given a branch called `feature/SKIL-103` you can check it out using `git co 103` assuming no other local branches contain `103` in their name.
+
+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 ca
 
 Improved version of 'git commit --amend'. Updates files that are already in the commit and, optionally, adds and commits additional files.
 
+        usage: git-ca [-h] [--added] [--all] [--everything] [--ignored] [--patch] [--verbose] [--dry-run] [files ...]
+
+        positional arguments:
+          files             List of files to add to the commit
+
+        options:
+          -h, --help        show this help message and exit
+          --added, -A       Update files in the current commit, including files added with `git add`
+          --all, -a         Append all locally-modified, tracked files to the current commit
+          --everything, -e  Append all modified and untracked files to the current commit (implies `~--all`)
+          --ignored, -i     Include files normally hidden by `.gitignore`
+          --patch, -p       Use the interactive patch selection interface to chose which changes to commit.
+          --verbose, -v     Verbose mode
+          --dry-run, -D     Dry-run
+
 ## git cleanup
 
 List or delete branches that have already been merged and delete tracking branches that are no longer on the remote.
 
+        git-cleanup [-h] [--delete] [--master MASTER] [--force] [--unmerged] [--yes] [--debug] [branches ...]
+
+        positional arguments:
+
+        branches              List of branches to check (default is all branches)
+
+        options:
+        -h, --help            show this help message and exit
+        --delete, -d          Delete all branches that have been merged
+        --master MASTER, -m MASTER, --main MASTER
+                              Specify the master branch (Attempts to read this from GitLab or defaults to "develop" if present or "master" or "main" otherwise
+        --force, -f           Allow protected branches (e.g. master) to be removed
+        --unmerged, -u        List branches that have NOT been merged
+        --yes, -y             Assume "yes" in response to any prompts (e.g. to delete branches)
+        --debug               Enable debug output
+
 ## git co
 
-Equivalent to 'git checkout' but with intelligent branch matching, so specifying a partial branch name will work if it uniquely matches an existing branch
+Equivalent to `git checkout` but with enhanced branch matching as described above. The command does not support the full range of options supported by the `git checkout` comamnd which should still be used where additional functionality is required.
+
+        git-co [-h] [--branch] [--update] [--rebase] [--force] [--exact] [--debug] branchname
+
+        positional arguments:
+
+        branchname    The branch name (or a partial name that matches uniquely against a local branch, remote branch, commit ID or tag)
+
+        options:
+        -h, --help    show this help message and exit
+        --branch, -b  Create the specified branch
+        --update, -u  If a remote branch exists, delete any local branch and check out the remote version
+        --rebase, -r  Rebase the branch onto its parent after checking it out
+        --force, -f   When using the update option, recreate the local branch even if it is owned by the current user (based on the author of the most recent commit)
+        --exact, -e   Do not use branch name matching - check out the branch as specified (if it exists)
+        --debug       Enable debug output
 
 ## git parent
 
-Attempt to determine the parent branch for the specified branch (defaulting to the current one)
+Attempt to determine the parent branch for the specified branch (defaulting to the current one).
 
 ## git update
 

{skilleter_thingy-0.0.96 → skilleter_thingy-0.0.98}/pyproject.toml

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

{skilleter_thingy-0.0.96 → skilleter_thingy-0.0.98}/skilleter_thingy/multigit.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-"""mg - MultiGit - utility for managing multiple Git repos in a hierarchical directory tree"""
+"""mg - MultiGit - utility for managing multiple Git working trees in a hierarchical directory tree"""
 
 import os
 import sys
@@ -14,29 +14,32 @@ import thingy.colour as colour
 
 ################################################################################
 
-# DONE: / Output name of each git repo 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 repo
+# 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
 # DONE: Don't save the configuration on exit if it hasn't changed
 # 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: command to categorise repos then command line filter to only act on repos in category (in addition to other filtering options) - +tag <TAG> command tags all selected repors and updates the configuration, +untag <TAG> command to remove tags in the same way
+# 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: 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 repo name and either returns full path or pops up window to autocomplete until single match found
+# 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: If run in a subdirectory, only process repos in that tree (or have an option to do so)
 # 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)
-# TODO: When specifying list of repos, if repo name doesn't contain '/' prefix it with '*'?
+# 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: Integrate completion with fzf if installed?
+# 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)
 ################################################################################
 
 DEFAULT_CONFIG_FILE = 'multigit.toml'
@@ -48,7 +51,7 @@ DEFAULT_BRANCH = 'DEFAULT'
 
 ################################################################################
 
-HELP_INFO = """usage: multigit [-h] [--verbose] [--quiet] [--config CONFIG] [--directory DIRECTORY] [--repos REPOS] [--modified] [--branched] [--tag TAGS]
+HELP_INFO = """usage: multigit [-h] [--verbose] [--quiet] [--config CONFIG] [--repos REPOS] [--modified] [--branched] [--tag TAGS]
                 {+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
@@ -59,8 +62,6 @@ options:
   --quiet, -q           Minimal console output
   --config CONFIG, -c CONFIG
                         The configuration file (defaults to multigit.toml)
-  --directory DIRECTORY, --dir DIRECTORY
-                        The top-level directory of the multigit tree (defaults to the current directory)
   --repos REPOS, -r REPOS
                         The repo names to work on (defaults to all repos and can contain shell wildcards and can be issued multiple times on the command line)
   --modified, -m        Select repos that have local modifications
@@ -85,18 +86,38 @@ Sub-commands:
 class Arguments():
     """Data class to contain command line options and parameters"""
 
+    # Command line options for output noise
+
     quiet: bool = False
     verbose: bool = False
-    configuration_file: str = DEFAULT_CONFIG_FILE
-    directory: str = '.'
+
+    # True if we continue after a git command returns an error
+
+    error_continue: bool = False
+
+    # Default and current configuration file
+
+    default_configuration_file: str = DEFAULT_CONFIG_FILE
+    configuration_file: str = None
+
+    # Command line filter options
+
     repos: list[str] = field(default_factory=list)
     tag: list[str] = field(default_factory=list)
     modified: bool = False
     branched: bool = False
+
+    # Command to run with parameters
+
     command: str = None
-    error_continue: bool = False
     parameters: list[str] = field(default_factory=list)
+
+    # True if running an internal command
+
     internal_command: bool = False
+
+    # True if the configuration data needs to be written back on completion
+
     config_modified: bool = False
 
 ################################################################################
@@ -109,21 +130,21 @@ def error(msg, status=1):
 
 ################################################################################
 
-def find_configuration(args):
+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.
        Returns configuration file path or None if the configuration file
        could not be found."""
 
-    if '/' in args.configuration_file:
-        config_file = args.configuration_file
+    if '/' in default_config_file:
+        config_file = default_config_file
     else:
         config_path = os.getcwd()
-        config_file = os.path.join(config_path, args.configuration_file)
+        config_file = os.path.join(config_path, default_config_file)
 
         while not os.path.isfile(config_file) and config_path != '/':
             config_path = os.path.dirname(config_path)
-            config_file = os.path.join(config_path, args.configuration_file)
+            config_file = os.path.join(config_path, default_config_file)
 
     return config_file if os.path.isfile(config_file) else None
 
@@ -132,18 +153,11 @@ def find_configuration(args):
 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)
+    colour.write(msg[:width-1], newline=False, cleareol=True, cr=True)
 
 ################################################################################
 
-def find_git_repos(args):
+def find_working_trees(args):
     """Locate and return a list of '.git' directory parent directories in the
        specified path.
 
@@ -250,29 +264,49 @@ def mg_init(args, config, console):
 
     if args.modified or args.branched or args.tag:
         error('The "--tag", "--modified" and "--branched" options cannot be used with the "init" subcommand')
-    elif not config:
-        error(f'Unable to location configuration file "{args.configuration_file}"')
-
-    # TODO: Update should remove or warn about repos that are no longer present
 
-    # Search for .git directories
+    # Search for .git directories and add any that aren't already in the configuration
 
-    for repo in find_git_repos(args):
+    repo_list = []
+    for repo in find_working_trees(args):
         if not args.quiet:
-            show_progress(console.columns, repo.name)
+            show_progress(console.columns, repo)
+
+        repo_list.append(repo)
 
         if repo not in config:
+            default_branch = git.branch(path=repo)
+
             config[repo] = {
-                'default branch': git.branch(path=repo)
+                'default branch': default_branch
             }
 
-        remote = git.remotes(path=repo)
+            remote = git.remotes(path=repo)
 
-        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 '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 [BOLD:{repo}] with default branch [BLUE:{default_branch}]')
+
+    if not args.quiet:
+        colour.write(cleareol=True)
+
+    # Look for configuration entries that are no longer present and delete them
+
+    removals = []
+
+    for repo in config:
+        if repo != 'DEFAULT' and repo not in repo_list:
+            removals.append(repo)
+
+    for entry in removals:
+        del config[repo]
+        colour.write(f'Removed [BOLD:{repo}] as it no longer exists')
+
+    # The configuration file needs to be updated
 
     args.config_modified = True
 
@@ -445,7 +479,7 @@ def parse_command_line():
         elif param in ('--config', '-c'):
             try:
                 i += 1
-                args.configuration_file = argv[i]
+                args.default_configuration_file = argv[i]
             except IndexError:
                 error('--config - missing configuration file parameter')
 
@@ -499,37 +533,41 @@ def parse_command_line():
 
     args.parameters = argv[i+1:]
 
-    args.configuration_file = find_configuration(args)
+    args.configuration_file = find_configuration(args.default_configuration_file)
 
     return args
 
 ################################################################################
 
+COMMANDS = {
+   'init': mg_init,
+   'dir': mg_dir,
+   'config': mg_config,
+   'tag': mg_tag,
+   'untag': mg_untag,
+}
+
 def main():
     """Main function"""
 
-    commands = {
-       'init': mg_init,
-       'dir': mg_dir,
-       'config': mg_config,
-       'tag': mg_tag,
-       'untag': mg_untag,
-    }
-
     args = parse_command_line()
 
-    if args.internal_command and args.command not in commands:
+    if args.internal_command and args.command not in COMMANDS:
         error(f'Invalid command "{args.command}"')
 
     # If the configuration file exists, read it
 
     config = configparser.ConfigParser()
 
-    if not (args.internal_command and args.command == 'init'):
-        if not args.configuration_file:
+    # If running the '+init' command without an existing configuration file
+    # use the default one (which may have been overridden on the command line)
+    # 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)
+        else:
             error('Cannot locate configuration file')
-        elif not os.path.isfile(args.configuration_file):
-            error(f'Cannot read configuration file {args.configuration_file}')
 
     if os.path.isfile(args.configuration_file):
         config.read(args.configuration_file)
@@ -548,7 +586,7 @@ def main():
     if args.internal_command:
         # Run the subcommand
 
-        commands[args.command](args, config, console)
+        COMMANDS[args.command](args, config, console)
 
         # Save the updated configuration file if it has changed (currently, only the init command will do this).
 

{skilleter_thingy-0.0.96 → skilleter_thingy-0.0.98}/skilleter_thingy/thingy/colour.py

@@ -42,6 +42,8 @@ _ANSI_BMAGENTA = '\x1b[45m'
 _ANSI_BCYAN = '\x1b[46m'
 _ANSI_BWHITE = '\x1b[47m'
 
+_ANSI_CLEAREOL = '\x1b[K'
+
 # Looking up tables for converting textual colour codes to ANSI codes
 
 ANSI_REGEXES = \
@@ -144,7 +146,7 @@ def format(txt):
 
 ################################################################################
 
-def write(txt=None, newline=True, stream=sys.stdout, indent=0, strip=False):
+def write(txt=None, newline=True, stream=sys.stdout, indent=0, strip=False, cleareol=False, cr=False):
     """ Write to the specified stream (defaulting to stdout), converting colour codes to ANSI
         txt can be None, a string or a list of strings."""
 
@@ -163,10 +165,22 @@ def write(txt=None, newline=True, stream=sys.stdout, indent=0, strip=False):
 
             stream.write(line)
 
+            if cleareol:
+                stream.write(_ANSI_CLEAREOL)
+
             if newline or n < len(txt) - 1:
                 stream.write('\n')
-    elif newline:
-        stream.write('\n')
+            elif cr:
+                stream.write('\r')
+
+    else:
+        if cleareol:
+            stream.write(_ANSI_CLEAREOL)
+
+        if newline:
+            stream.write('\n')
+        elif cr:
+            stream.write('\r')
 
 ################################################################################
 

{skilleter_thingy-0.0.96 → skilleter_thingy-0.0.98}/skilleter_thingy/thingy/git2.py

@@ -1106,10 +1106,6 @@ def default_branch():
 
     return None
 
-################################################################################
-
-    return None
-
 ################################################################################
 
 def matching_branch(branchname, case=False):

{skilleter_thingy-0.0.96 → skilleter_thingy-0.0.98/skilleter_thingy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: skilleter_thingy
-Version: 0.0.96
+Version: 0.0.98
 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
@@ -36,53 +36,59 @@ This README just contains a summary of the functionality of each command.
 
 # Git Repo Management
 
-## multigit
+## Multigit
 
-Manage a collection of related git working trees.
+Multigit is a tool for managing 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.
+This is intended for use in a situation where you have a collection of related git working trees organised in a directory hierarchy which aren't 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 and to select which working trees commands are run in.
+
+## Initialisation
 
 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.
 
+## Multigit Command Line
+
 The multigit command line format is:
 
     multigit OPTIONS COMMAND
 
-Where COMMAND is an internal multigit command if it starts with a '+' and is a git command otherwise.
+Where COMMAND is an internal multigit command if it starts with a `+` and is a git command otherwise (including the additional git commands described in this document).
 
 By default, when multigit is invoked with a git command, it runs a the command in each of the working trees selected by the command line options passed to multigit (if no options are specified then the command is run in *all* 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 REPO / -r REPO* Allows a list of working trees to be specfied, either by path, name or a wildcard matching either.
+`--repos REPO` / `-r REPO` Allows a list of working trees to be specfied, either by path, name or a wildcard matching either.
 
-*--modified / -m* Run only in working trees containing locally modified files
+`--modified` / `-m` Run only in working trees containing locally modified files
 
-*--branched / -b* Run only in working trees where the current branch that is checked out is NOT the default branch
+`--branched` / `-b` Run only in working trees where the current branch that is checked out is NOT the default branch
 
-*--tag TAG / -t TAG* Run only in working trees that are tagged with the specified tag
+`--tag TAG` / `-t TAG` Run only in working trees that are tagged with the specified tag
 
-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`.
+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.
 
+## Multigit Commands
+
 Multigit supports a small list of subcommands, each of which are prefixed with a `+` to distinguish them from Git commands:
 
-*+init* - Create or update the configuration file
+`+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.
+`+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.
 
-*+config* - Print the name and location of the multigit configuration file.
+`+config` - Print the name and location of the multigit configuration file.
 
-*+tag TAG* - If no tag specified list tags applied to the specified working trees. If a tag *is* specified, then *apply* the tag to the specified working trees.
+`+tag TAG` - If no tag specified list tags applied to the specified working trees. If a tag *is* specified, then *apply* the tag to the specified working trees.
 
-*+untag TAG* - Remove the tag from the specified working trees (do nothing if the tag is not applied in the first place).
+`+untag TAG` - Remove the tag from the specified working trees (do nothing if the tag is not applied in the first place).
 
-Any command not prefixed with '+' is run in each of the working trees (filtered by the various multigit options) as a git command.
+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.
 
-The `+dir` command can be used with shell aliases (or their equivalent in the user's shell of choice) to create an alias to run, for example, `cd (multigit +dir "$@")` (Bash) or `cd (multigit +dir $argv)` (for the Fish shell) that would cd to the top level direcory.
+The `+dir` command can be used with shell aliases (or their equivalent in the user's shell of choice) to create an alias to run, for example, `cd (multigit +dir "$@")` (Bash) or `cd (multigit +dir $argv)` (for the Fish shell) that would cd to the top level directory.
 
 # Miscellaneous Git Utilities
 
@@ -92,23 +98,96 @@ Output a string containing colour-coded shell nesting level, current directory a
 
 # Git Extensions
 
-Due to the way that the git command works, these can be run as they were additional git subcommands.
+Due to the way that the git command works, these can be run as they were additional git subcommands, although, due to a limitation in git, the only things that does not work is the `--help` option where the command has to be run with a hyphen between `git` and the subcommand - for example `git ca --help` does not work, but `git-ca --help` does.
+
+## Branch Names
+
+Where one of the git extensions takes an existing branch name as a parameter, the branch name can be abbreviated and the abbreviated form is expanded according to the following rules:
+
+* If the specified branch name exactly matches an existing branch, tag or commit ID then that is used (this includes remote branches where appropriate, if no local branches match).
+* Otherwise, the branch name is compared to existing branches (again, including remote branches where appropriate, if no local branches match) and, if the specified name uniquely partially matches an existing branch (optionally using `*` and `?` wildcard characters) that branch is used. If it matches multiple branches than an error is reported.
+
+For example, given a repo with the following branches:
+
+        origin/wombat
+        origin/platypus
+        wombat
+        emu
+        battery
+        chaos
+
+Then:
+
+* 'emu' will match 'emu'
+* 'wombat' will match 'wombat' but not 'origin/wombat' since the local branch takes precedence
+* 'at' will match both 'wombat' and 'battery' and will report an error
+* 'pus' will match 'origin/platypus'
+
+This is most useful where branches contain ticket numbers so, for instance given a branch called `feature/SKIL-103` you can check it out using `git co 103` assuming no other local branches contain `103` in their name.
+
+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 ca
 
 Improved version of 'git commit --amend'. Updates files that are already in the commit and, optionally, adds and commits additional files.
 
+        usage: git-ca [-h] [--added] [--all] [--everything] [--ignored] [--patch] [--verbose] [--dry-run] [files ...]
+
+        positional arguments:
+          files             List of files to add to the commit
+
+        options:
+          -h, --help        show this help message and exit
+          --added, -A       Update files in the current commit, including files added with `git add`
+          --all, -a         Append all locally-modified, tracked files to the current commit
+          --everything, -e  Append all modified and untracked files to the current commit (implies `~--all`)
+          --ignored, -i     Include files normally hidden by `.gitignore`
+          --patch, -p       Use the interactive patch selection interface to chose which changes to commit.
+          --verbose, -v     Verbose mode
+          --dry-run, -D     Dry-run
+
 ## git cleanup
 
 List or delete branches that have already been merged and delete tracking branches that are no longer on the remote.
 
+        git-cleanup [-h] [--delete] [--master MASTER] [--force] [--unmerged] [--yes] [--debug] [branches ...]
+
+        positional arguments:
+
+        branches              List of branches to check (default is all branches)
+
+        options:
+        -h, --help            show this help message and exit
+        --delete, -d          Delete all branches that have been merged
+        --master MASTER, -m MASTER, --main MASTER
+                              Specify the master branch (Attempts to read this from GitLab or defaults to "develop" if present or "master" or "main" otherwise
+        --force, -f           Allow protected branches (e.g. master) to be removed
+        --unmerged, -u        List branches that have NOT been merged
+        --yes, -y             Assume "yes" in response to any prompts (e.g. to delete branches)
+        --debug               Enable debug output
+
 ## git co
 
-Equivalent to 'git checkout' but with intelligent branch matching, so specifying a partial branch name will work if it uniquely matches an existing branch
+Equivalent to `git checkout` but with enhanced branch matching as described above. The command does not support the full range of options supported by the `git checkout` comamnd which should still be used where additional functionality is required.
+
+        git-co [-h] [--branch] [--update] [--rebase] [--force] [--exact] [--debug] branchname
+
+        positional arguments:
+
+        branchname    The branch name (or a partial name that matches uniquely against a local branch, remote branch, commit ID or tag)
+
+        options:
+        -h, --help    show this help message and exit
+        --branch, -b  Create the specified branch
+        --update, -u  If a remote branch exists, delete any local branch and check out the remote version
+        --rebase, -r  Rebase the branch onto its parent after checking it out
+        --force, -f   When using the update option, recreate the local branch even if it is owned by the current user (based on the author of the most recent commit)
+        --exact, -e   Do not use branch name matching - check out the branch as specified (if it exists)
+        --debug       Enable debug output
 
 ## git parent
 
-Attempt to determine the parent branch for the specified branch (defaulting to the current one)
+Attempt to determine the parent branch for the specified branch (defaulting to the current one).
 
 ## git update