git-sanity 1.0.0__tar.gz

git-sanity-1.0.0/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 yuqiaoyu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

git-sanity-1.0.0/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.1
+Name: git-sanity
+Version: 1.0.0
+Summary: Manage multiple git repos with sanity
+Home-page: https://github.com/yuqiaoyu/gits
+Author: yuqiaoyu
+Author-email: yu_junqiang@qq.com
+License: MIT
+Keywords: git,manage multiple repositories,cui,command-line
+Platform: linux
+Platform: osx
+Platform: win32
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Topic :: Terminals
+Classifier: Topic :: Utilities
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: ~=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
+UNKNOWN
+

git-sanity-1.0.0/README.md

@@ -0,0 +1,116 @@
+# gits
+多Git仓库管理工具
+
+## gits 用法：
+```
+usage: gits [-h] [-v] {init,clone,sync,switch,branch,cherry-pick,push} ...
+
+options:
+  -h, --help            show this help message and exit
+  -v, --version         show program's version number and exit
+
+sub-commands:
+  {init,clone,sync,switch,branch,cherry-pick,push}
+                        additional help with sub-command -h
+    init                initialize the projects
+    clone               clone repo(s)
+    sync                sync source project(s)
+    switch              switch branches
+    branch              list or delete branches
+    cherry-pick         TODO:add repo(s)
+    push                update remote refs along with associated objects
+```
+
+### 一、`gits init` 用法
+```
+usage: gits init [-h] [-u URL] [-d DIRECTORY]
+
+Initialize the projects
+
+options:
+  -h, --help            show this help message and exit
+  -u URL, --url URL     the gits configuration repository
+  -d DIRECTORY, --directory DIRECTORY
+                        the path to init gits configuration repository
+```
+
+### 二、`gits clone` 用法
+```
+usage: gits clone [-h] [-g GROUP]
+
+Clone repo(s)
+
+options:
+  -h, --help            show this help message and exit
+  -g GROUP, --group GROUP
+                        group to clone, default all
+```
+
+### 三、`gits sync` 用法
+```
+usage: gits sync [-h] [-g GROUP]
+
+Sync source project(s)
+
+options:
+  -h, --help            show this help message and exit
+  -g GROUP, --group GROUP
+                        projects to sync, default all
+```
+
+### 四、`gits switch` 用法
+```
+usage: gits switch [-h] [-g GROUP] [-c NEW_BRANCH_NAME | -b BRANCH_NAME] [remote]
+
+Switch branches
+
+positional arguments:
+  remote                remote name to switch branches, default origin
+
+options:
+  -h, --help            show this help message and exit
+  -g GROUP, --group GROUP
+                        group to switch branches, default all
+  -c NEW_BRANCH_NAME, --create NEW_BRANCH_NAME
+                        create a new branch named <new-branch> base on origin/HEAD
+  -b BRANCH_NAME, --branch BRANCH_NAME
+                        branch to switch to
+```
+
+### 五、`gits branch` 用法
+```
+usage: gits branch [-h] [-g GROUP] [-d DELETE | -D FORCE_DELETE] [list]
+
+List or delete branches
+
+positional arguments:
+  list                  list branch names
+
+options:
+  -h, --help            show this help message and exit
+  -g GROUP, --group GROUP
+                        group to operate, default all
+  -d DELETE, --delete DELETE
+                        delete fully merged branch
+  -D FORCE_DELETE, --DELETE FORCE_DELETE
+                        delete branch (even if not merged)
+```
+
+### 六、`cherry-pick` 用法
+待实现
+
+### 七、`gits push` 用法
+```
+usage: gits push [-h] [-g GROUP] [-f] remote
+
+Update remote refs along with associated objects
+
+positional arguments:
+  remote                remote branch to be pushed
+
+options:
+  -h, --help            show this help message and exit
+  -g GROUP, --group GROUP
+                        group to push, default all
+  -f, --force           force updates
+```

git-sanity-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

git-sanity-1.0.0/setup.py

@@ -0,0 +1,39 @@
+"""
+    Setup file for gits.
+"""
+
+from setuptools import setup, find_packages
+
+setup(
+    name="git-sanity",
+    version="1.0.0",
+    package_dir={"":"src"},
+    packages=find_packages(where="src"),
+    license="MIT",
+    description="Manage multiple git repos with sanity",
+    long_description=None,
+    long_description_content_type="text/markdown",
+    url="https://github.com/yuqiaoyu/gits",
+    platforms=["linux", "osx", "win32"],
+    keywords=["git", "manage multiple repositories", "cui", "command-line"],
+    author="yuqiaoyu",
+    author_email="yu_junqiang@qq.com",
+    entry_points={"console_scripts": ["gits = gits.__main__:main"]},
+    python_requires="~=3.10",
+    install_requires=["argcomplete"],
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: POSIX",
+        "Operating System :: MacOS :: MacOS X",
+        "Operating System :: Microsoft :: Windows",
+        "Topic :: Software Development :: Version Control :: Git",
+        "Topic :: Terminals",
+        "Topic :: Utilities",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+    ],
+    include_package_data=True,
+)

git-sanity-1.0.0/src/git_sanity.egg-info/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.1
+Name: git-sanity
+Version: 1.0.0
+Summary: Manage multiple git repos with sanity
+Home-page: https://github.com/yuqiaoyu/gits
+Author: yuqiaoyu
+Author-email: yu_junqiang@qq.com
+License: MIT
+Keywords: git,manage multiple repositories,cui,command-line
+Platform: linux
+Platform: osx
+Platform: win32
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Topic :: Terminals
+Classifier: Topic :: Utilities
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: ~=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
+UNKNOWN
+

git-sanity-1.0.0/src/git_sanity.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+LICENSE.txt
+README.md
+setup.py
+src/git_sanity.egg-info/PKG-INFO
+src/git_sanity.egg-info/SOURCES.txt
+src/git_sanity.egg-info/dependency_links.txt
+src/git_sanity.egg-info/entry_points.txt
+src/git_sanity.egg-info/requires.txt
+src/git_sanity.egg-info/top_level.txt
+src/gits/__init__.py
+src/gits/__main__.py
+src/gits/gits_branch.py
+src/gits/gits_clone.py
+src/gits/gits_init.py
+src/gits/gits_push.py
+src/gits/gits_switch.py
+src/gits/gits_sync.py
+src/gits/utils.py

git-sanity-1.0.0/src/git_sanity.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

git-sanity-1.0.0/src/git_sanity.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+gits = gits.__main__:main
+

git-sanity-1.0.0/src/git_sanity.egg-info/requires.txt

@@ -0,0 +1 @@
+argcomplete

git-sanity-1.0.0/src/git_sanity.egg-info/top_level.txt

@@ -0,0 +1 @@
+gits

git-sanity-1.0.0/src/gits/__init__.py

@@ -0,0 +1,9 @@
+import logging
+
+__version__ = "1.0.0"
+__author__ = "yuqiaoyu"
+
+__gits_root_dir__ = ".gits"
+__gits_config_file_name__ = "gits_config.json"
+
+logging.basicConfig(level=logging.DEBUG, format="%(asctime)s gits %(levelname)s: %(message)s")

git-sanity-1.0.0/src/gits/__main__.py

@@ -0,0 +1,70 @@
+import argparse
+import logging
+import os
+from gits import __version__
+from gits.gits_init import gits_init_impl
+from gits.gits_clone import gits_clone_impl
+from gits.gits_sync import gits_sync_impl
+from gits.gits_switch import gits_switch_impl
+from gits.gits_branch import gits_branch_impl
+from gits.gits_push import gits_push_impl
+
+def main():
+    logging.info("New Run ==================================================")
+
+    gits = argparse.ArgumentParser(
+        prog="gits", formatter_class=argparse.RawTextHelpFormatter, description=__doc__
+    )
+    gits.add_argument(
+        "-v", "--version", action="version", version=f"%(prog)s {__version__}"
+    )
+
+    subparsers = gits.add_subparsers(
+        title="sub-commands", help="additional help with sub-command -h"
+    )
+    gits_init = subparsers.add_parser("init", description="Initialize the projects", help="initialize the projects")
+    gits_init.add_argument("-u", "--url", dest="url", help="the gits configuration repository")
+    gits_init.add_argument("-d", "--directory", dest="directory", default=".", help="the path to init gits configuration repository")
+    gits_init.set_defaults(func=gits_init_impl)
+
+    gits_clone = subparsers.add_parser("clone", description="Clone repo(s)", help="clone repo(s)")
+    gits_clone.add_argument("-g", "--group", dest="group", default="all", help="group to clone, default all")
+    gits_clone.set_defaults(func=gits_clone_impl)
+
+    gits_sync = subparsers.add_parser("sync", description="Sync source project(s) ", help="sync source project(s)")
+    gits_sync.add_argument("-g", "--group", dest="group", default="all", help="projects to sync, default all")
+    gits_sync.set_defaults(func=gits_sync_impl)
+
+    gits_switch = subparsers.add_parser("switch", description="Switch branches", help="switch branches")
+    gits_switch.add_argument("remote", nargs='?', default="origin", help="remote name to switch branches, default origin")
+    gits_switch.add_argument("-g", "--group", dest="group", default="all", help="group to switch branches, default all")
+    gits_switch_meg = gits_switch.add_mutually_exclusive_group()
+    gits_switch_meg.add_argument("-c", "--create", dest="new_branch_name", help="create a new branch named <new-branch> base on origin/HEAD")
+    gits_switch_meg.add_argument("-b", "--branch", dest="branch_name", help="branch to switch to")
+    gits_switch.set_defaults(func=gits_switch_impl)
+
+    gits_branch = subparsers.add_parser("branch", description="List or delete branches", help="list or delete branches")
+    gits_branch.add_argument("list", nargs='?', default="list", help="list branch names")
+    gits_branch.add_argument("-g", "--group", dest="group", default="all", help="group to operate, default all")
+    gits_branch_meg = gits_branch.add_mutually_exclusive_group()
+    gits_branch_meg.add_argument("-d", "--delete", dest="delete", help="delete fully merged branch")
+    gits_branch_meg.add_argument("-D", "--DELETE", dest="force_delete", help="delete branch (even if not merged)")
+    gits_branch.set_defaults(func=gits_branch_impl)
+
+    gits_cherry_pick = subparsers.add_parser("cherry-pick", description="TODO:add repo(s)", help="TODO:add repo(s)")
+
+    gits_push = subparsers.add_parser("push", description="Update remote refs along with associated objects", help="update remote refs along with associated objects")
+    gits_push.add_argument("remote", default="remote", help="remote branch to be pushed")
+    gits_push.add_argument("-g", "--group", dest="group", default="all", help="group to push, default all")
+    gits_push.add_argument("-f", "--force", dest="force", action='store_true', help="force updates")
+    gits_push.set_defaults(func=gits_push_impl)
+
+    args = gits.parse_args()
+    logging.debug("command args={}".format(args))
+    if "func" in args:
+        args.func(args)
+    else:
+        gits.print_help()
+
+if __name__ == "__main__":
+    main()

git-sanity-1.0.0/src/gits/gits_branch.py

@@ -0,0 +1,38 @@
+import logging
+import os
+from gits.utils import run
+from gits.utils import get_gits_dir
+from gits.utils import load_user_config
+from gits.utils import get_user_config
+from gits.utils import get_projects_by_group
+
+def gits_branch_impl(args):
+    """
+    Implementation for managing Git branches across multiple projects.
+    
+    Args:
+        args: Command-line arguments containing:
+            - group (str): Group name to filter projects
+            - delete (str): Branch name to delete (non-force)
+            - force_delete (str): Branch name to force delete
+    
+    Returns:
+        None
+    """
+    user_config = load_user_config()
+    for project in get_projects_by_group(user_config, args.group):
+        project_name = get_user_config(project, "name")
+        logging.info("Processing branches for {}...".format(get_user_config(project, "name")))
+        logging.debug("Processing project={}".format(project))
+
+        repo_path = os.path.join(get_gits_dir(), get_user_config(project, "local_path", "."), project_name)
+        if not os.path.isdir(repo_path):
+            logging.error("the remote {} project branch hasn't been pulled locally yet.".format(project_name))
+            exit(1)
+
+        branch_cmd = ["git", "branch"]
+        if args.delete is not None:
+            branch_cmd.extend(["-d", args.delete])
+        elif args.force_delete is not None:
+            branch_cmd.extend(["-D", args.force_delete])
+        run(branch_cmd, workspace=repo_path)

git-sanity-1.0.0/src/gits/gits_clone.py

@@ -0,0 +1,39 @@
+import logging
+import os
+from gits.utils import run
+from gits.utils import get_gits_dir
+from gits.utils import load_user_config
+from gits.utils import get_user_config
+from gits.utils import get_projects_by_group
+
+def gits_clone_impl(args):
+    """
+    Implements the gits clone operation for multiple projects based on user configuration
+    
+    This function:
+    1. Loads user configuration from arguments
+    2. Retrieves all projects belonging to the specified group
+    3. Clones each project using git clone with configured parameters
+    4. Handles optional forward_to_git parameters
+    5. Uses configured workspace or current directory as default
+    
+    Args:
+        args: Command-line arguments containing group name and other configuration
+        
+    Returns:
+        None (performs side effects by cloning repositories)
+    """
+    user_config = load_user_config()
+    for project in get_projects_by_group(user_config, args.group):
+        logging.info("Cloning {}...".format(get_user_config(project, "name")))
+        logging.debug("Cloning project={}".format(project))
+
+        clone_cmd = ["git", "clone", get_user_config(project, "url"), "-b", get_user_config(project, "branch")]
+        clone_cmd.extend(get_user_config(project, "forward_to_git.clone", []))
+
+        workspace = os.path.join(get_gits_dir(), get_user_config(project, "local_path", "."))
+        result = run(clone_cmd, workspace=workspace)
+        if result.returncode == 0:
+            for remote in get_user_config(project, "additional_remote", []):
+                for remote_name, remote_url in remote.items():
+                    run(["git", "remote", "add", remote_name, remote_url], workspace=os.path.join(workspace, get_user_config(project, "name")))

git-sanity-1.0.0/src/gits/gits_init.py

@@ -0,0 +1,68 @@
+import json
+import logging
+import os
+from gits import __gits_root_dir__
+from gits import __gits_config_file_name__
+from gits.utils import run
+
+default_config = {
+    "this_is_a_comment_example": "<!--JSON-style comment markers (similar to HTML comments)-->",
+    "working_branch": "<!--change via the `gits switch` command, default=None-->",
+    "projects": [
+        {
+            "name": "<!--project's name-->",
+            "url": "<!--project's repo url>",
+            "branch": "<!--branch's name-->",
+            "local_path": "<!--local path to clone repo, default=.>",
+            "additional_remote": [
+                {"<!--remote's name-->": "<!--remote's url-->"}
+            ],
+            "forward_to_git": {
+                "clone": ["<!--command args of git clone, eg:--depth=1-->"]
+            }
+        }
+    ],
+    "groups": [
+        {
+            "group_name": "all",
+            "projects": [
+                "<!--project_name, default=[]-->"
+            ]
+        }
+    ]
+}
+
+def gits_init_impl(args):
+    """
+    Initialize a gits repository with optional URL or local configuration
+    
+    Parameters:
+    - args: Command-line arguments object containing:
+        * directory: Target directory for repository
+        * URL: Optional remote repository URL for cloning
+        
+    Returns:
+    - None (exits with status code 0 on success, 1 on failure)
+    """
+    if not os.path.isdir(args.directory):
+        logging.error("the value of -d/--directory is not a valid path: {}".format(args.directory))
+        exit(1)
+
+    gits_repo_path = os.path.join(args.directory, __gits_root_dir__)
+    if os.path.isdir(gits_repo_path):
+        logging.error("reinitialized existing gits repository in {}".format(args.directory))
+        exit(0)
+
+    os.mkdir(gits_repo_path)
+    if args.url and run(["wget", args.url], workspace=gits_repo_path, capture_output=True).returncode == 0:
+        exit(0)
+    elif args.url:
+        os.rmdir(gits_repo_path)
+        logging.error("failed to initialize gits with {}".format(args.url))
+        exit(1)
+    else:
+        gits_config_file_path = os.path.join(gits_repo_path, __gits_config_file_name__)
+        with open(gits_config_file_path, "w", encoding="utf-8") as f:
+            json.dump(default_config, f, indent=4, ensure_ascii=False)
+        logging.warn("default config file created at {}. Customize as needed.".format(gits_config_file_path))
+        exit(0)

git-sanity-1.0.0/src/gits/gits_push.py

@@ -0,0 +1,45 @@
+import logging
+import os
+from gits.utils import run
+from gits.utils import get_gits_dir
+from gits.utils import load_user_config
+from gits.utils import get_user_config
+from gits.utils import get_projects_by_group
+
+def gits_push_impl(args):
+    user_config = load_user_config()
+    working_branch = get_user_config(user_config, "working_branch")
+    if not working_branch:
+        logging.error("working_branch is not set. Please set it via `gits switch` command.")
+        exit(1)
+
+    for project in get_projects_by_group(user_config, args.group):
+        project_name = get_user_config(project, "name")
+        logging.info("Pushing {}...".format(get_user_config(project, "name")))
+        logging.debug("Pushing project={}".format(project))
+
+        repo_path = os.path.join(get_gits_dir(), get_user_config(project, "local_path", "."), project_name)
+        if not os.path.isdir(repo_path):
+            logging.error("the remote {} project branch hasn't been pulled locally yet.".format(project_name))
+            exit(1)
+
+        current_branch = run(["git", "branch", "--show-current"], workspace=repo_path, capture_output=True).stdout.strip()
+        if not current_branch:
+            logging.error("failed to get current branch for repo at {}".format(repo_path))
+            exit(1)
+        elif current_branch != working_branch:
+            continue
+
+        check_result = run(["git", "log", "origin/{}..HEAD".format(get_user_config(project, "branch"))], workspace=repo_path, capture_output=True)
+        if check_result.returncode != 0 or check_result.stderr.strip():
+            logging.error("failed to check for commits to push for repo at {}".format(repo_path))
+            exit(1)
+        elif not check_result.stdout.strip():
+            continue
+
+        push_cmd = ["git", "push", args.remote, current_branch]
+        if args.force:
+            push_cmd.append("--force")
+        result = run(push_cmd, workspace=repo_path)
+        if result.returncode != 0:
+            exit(1)

git-sanity-1.0.0/src/gits/gits_switch.py

@@ -0,0 +1,49 @@
+import logging
+import os
+from gits.utils import run
+from gits.utils import get_gits_dir
+from gits.utils import load_user_config
+from gits.utils import get_user_config
+from gits.utils import get_projects_by_group
+from gits.utils import update_user_config
+
+def gits_switch_impl(args):
+    """
+    Implements the branch switching functionality for multiple projects based on group configuration.
+
+    Parameters:
+    - args: Command-line arguments containing:
+        - group: Name of the group to switch branches for
+        - new_branch_name: Optional name for the new branch to create (if provided)
+        - branch_name: Optional name of the existing branch to switch to (if provided)
+
+    Returns:
+    - None (exits with error code 1 on failure)
+    """
+    user_config = load_user_config()
+    projects_of_group = get_projects_by_group(user_config, args.group)
+    if not projects_of_group:
+        return
+
+    for project in projects_of_group:
+        project_name = get_user_config(project, "name")
+        logging.info("Switching branch for {}...".format(project_name))
+        logging.debug("Switching project={}".format(project))
+
+        if args.new_branch_name is not None:
+            switch_cmd = ["git", "switch", "-c", args.new_branch_name, "origin/{}".format(get_user_config(project, "branch"))]
+        elif args.branch_name is not None:
+            switch_cmd = ["git", "switch", "{}".format(args.branch_name)]
+        else:
+            logging.error("No branch name provided to switch for {}.".format(project_name))
+            exit(1)
+
+        repo_path = os.path.join(get_gits_dir(), get_user_config(project, "local_path", "."), project_name)
+        if not os.path.isdir(repo_path):
+            logging.error("the remote {} project branch hasn't been pulled locally yet.".format(project_name))
+            exit(1)
+        if run(switch_cmd, workspace=repo_path).returncode != 0:
+            exit(1)
+    else:
+        update_user_config("working_branch", args.new_branch_name if args.new_branch_name is not None else args.branch_name)
+        return

git-sanity-1.0.0/src/gits/gits_sync.py

@@ -0,0 +1,29 @@
+import logging
+import os
+from gits.utils import run
+from gits.utils import get_gits_dir
+from gits.utils import load_user_config
+from gits.utils import get_user_config
+from gits.utils import get_projects_by_group
+
+def gits_sync_impl(args):
+    user_config = load_user_config()
+    for project in get_projects_by_group(user_config, args.group):
+        project_name = get_user_config(project, "name")
+        logging.info("Syncing source for {}...".format(get_user_config(project, "name")))
+        logging.debug("Syncing project={}".format(project))
+
+        repo_path = os.path.join(get_gits_dir(), get_user_config(project, "local_path", "."), project_name)
+        if not os.path.isdir(repo_path):
+            logging.error("the remote {} project branch hasn't been pulled locally yet.".format(project_name))
+            exit(1)
+
+        fetch_cmd = ["git", "fetch", "origin"]
+        if run(["git", "rev-parse", "--is-shallow-repository"], workspace=repo_path, capture_output=True).stdout == "True":
+            fetch_cmd.append("--unshallow")
+        if run(fetch_cmd, workspace=repo_path).returncode != 0:
+            exit(1)
+
+        rebase_cmd = ["git", "rebase", "origin/{}".format(get_user_config(project, "branch"))]
+        if run(rebase_cmd, workspace=repo_path).returncode != 0:
+            exit(1)

git-sanity-1.0.0/src/gits/utils.py

@@ -0,0 +1,168 @@
+import json
+import logging
+import os
+import subprocess
+from gits import __gits_root_dir__
+from gits import __gits_config_file_name__
+
+def run(command, workspace="./", env=os.environ, capture_output=False):
+    """
+    Execute an external command and return its execution result
+    
+    This function uses subprocess.run() to execute the specified command, 
+    supporting execution in a specified working directory and environment,
+    with the ability to capture command output and error messages.
+    
+    Args:
+        command (str/list): Command string or command list to execute (e.g., ["ls", "-l"])
+        workspace (str): Working directory path for command execution, defaults to current directory(".")
+        env (dict): Environment variables dictionary, defaults to os.environ (current process environment)
+        capture_output (bool): Whether to capture command's standard output and error output, defaults to False
+    
+    Returns:
+        - When capture_output is True, returns tuple: (stdout_str, stderr_str)
+        - When capture_output is False, returns boolean: whether command executed successfully (returncode == 0)
+    
+    Examples:
+        >>> run(["ls", "-l"], capture_output=True)
+        ('total 8\n-rw-r--r-- 1 user group 1234 Jan 1 12:34 file.txt', '')
+        
+        >>> run("ls -l", capture_output=False)
+        True
+    """
+    logging.debug("gits (cwd:{}) Running: {}".format(workspace, command))
+    result = subprocess.run(
+        command,
+        cwd=workspace,
+        env=env,
+        text=True,
+        capture_output=capture_output
+    )
+    logging.debug("gits result: {}".format(result))
+    return result
+
+
+def get_gits_dir(start_path=None):
+    if start_path is None:
+        start_path = os.getcwd()
+
+    current_path = os.path.abspath(os.path.expanduser(start_path))
+    while True:
+        gits_path = os.path.join(current_path, __gits_root_dir__)
+        if os.path.isdir(gits_path):
+            return current_path
+        
+        parent_path = os.path.dirname(current_path)
+        if parent_path == current_path:
+            break
+        current_path = parent_path
+    return None
+
+
+def load_user_config():
+    gits_dir = get_gits_dir()
+    if gits_dir is None:
+        logging.error("cannot find gits repository from current path: {}".format(os.getcwd()))
+        exit(1)
+
+    gits_config_file_path = os.path.join(gits_dir, __gits_root_dir__, __gits_config_file_name__)
+    if os.path.exists(gits_config_file_path):
+        with open(gits_config_file_path, "r", encoding="utf-8") as f:
+            user_config = json.load(f)
+        return user_config
+    else:
+        logging.error("{} does not exist.".format(gits_config_file_path))
+        exit(1)
+
+
+# JSON-style comment markers (similar to HTML comments)
+json_comment_prefix = "<!--"
+json_comment_suffix = "-->"
+def get_user_config(user_config, field_path, default=None):
+    """
+    Safely retrieves a nested configuration value from a dictionary using dot notation,
+    with support for commented-out values.
+    
+    Args:
+        user_config (dict): Configuration dictionary to search through
+        field_path (str): Dot-separated path to the desired field (e.g. 'parent.child')
+        default: Default value to return if path doesn't exist or is commented
+    
+    Returns:
+        The found value if path exists and isn't commented, otherwise returns default.
+        Returns None if no default is specified.
+    """
+    keys = field_path.split('.')
+    current = user_config
+    for key in keys:
+        if isinstance(current, dict) and key in current:
+            current = current[key]
+        elif default is None:
+            logging.error("there is no key({}) in user_config({})".format(field_path, user_config))
+        else:
+            return default
+
+    if isinstance(current, str) and current.startswith(json_comment_prefix) and current.endswith(json_comment_suffix):
+        if default is None:
+            logging.error("there is no value of key({}) in user_config({})".format(field_path, user_config))
+        else:
+            return default
+    else:
+        return current
+
+
+def get_projects_by_group(user_config, group_name):
+    """
+    Retrieve all projects belonging to a specified group from user configuration
+    
+    Args:
+        user_config (dict): Dictionary containing user configuration with 'projects' and 'groups'
+        group_name (str): Name of the group to filter projects by
+    
+    Returns:
+        list: List of project dictionaries that belong to the specified group.
+              Returns all projects if group_name is "all"
+    """
+    all_projects = get_user_config(user_config, "projects", default=[])
+    if group_name == "all":
+        return all_projects
+    
+    result_projects = []
+    for group in get_user_config(user_config, "groups", default=[]):
+        if get_user_config(group, "group_name") != group_name:
+            continue
+
+        target_projects = get_user_config(group, "projects", default=[])
+        for project in all_projects:
+            if get_user_config(project, "name", default="") in target_projects:
+                result_projects.append(project)
+
+    return result_projects
+
+
+def update_user_config(key_path, new_value):
+    if isinstance(key_path, str):
+        keys = key_path.split('.')
+    else:
+        keys = key_path
+
+    user_config = load_user_config()
+    current = user_config
+    for key in keys[:-1]:
+        if isinstance(current, dict) and key in current:
+            current = current[key]
+        else:
+            logging.error("key_path({}) does not exist".format(key_path))
+            return False
+
+    final_key = keys[-1]
+    if isinstance(current, dict) and final_key in current:
+        current[final_key] = new_value
+    else:
+        logging.error("key_path({}) does not exist".format(key_path))
+        return False
+
+    gits_config_file_path = os.path.join(get_gits_dir(), __gits_root_dir__, __gits_config_file_name__)
+    with open(gits_config_file_path, "w", encoding="utf-8") as f:
+        json.dump(user_config, f, indent=4, ensure_ascii=False)
+    return True