gitbolt 0.0.0.dev14__tar.gz → 0.0.0.dev15__tar.gz

{gitbolt-0.0.0.dev14 → gitbolt-0.0.0.dev15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitbolt
-Version: 0.0.0.dev14
+Version: 0.0.0.dev15
 Summary: Fast, flexible and type-safe Git commands in Python.
 Author-email: Suhas Krishna Srivastava <suhas.srivastava@vaastav.tech>
 Maintainer-email: Suhas Krishna Srivastava <suhas.srivastava@vaastav.tech>
@@ -114,9 +114,8 @@ Gitbolt lets you pass subcommands around as typed objects. This enables highly f
 
 ```python
 import gitbolt
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 version_subcmd = git.version_subcmd
 add_subcmd = git.add_subcmd
 
@@ -136,11 +135,11 @@ method_which_only_adds_a_file(add_subcmd)
 git subcommands are modeled as terminal functions that return stdout.
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
-status_out = git.status_subcmd.status()
-print(status_out)
+git = gitbolt.get_git()
+version_stdout = git.version_subcmd.version().version()
+print(version_stdout)
 ```
 
 ### 🪼 Modular Architecture
@@ -206,9 +205,9 @@ Extensive use of type-hints ensures that invalid usages fail early — at *compi
 #### 🔁 Override a single Git env (e.g., `GIT_TRACE`)
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 git = git.git_envs_override(GIT_TRACE=True)
 ```
 
@@ -216,9 +215,9 @@ git = git.git_envs_override(GIT_TRACE=True)
 
 ```python
 from pathlib import Path
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 git = git.git_envs_override(GIT_TRACE=1, GIT_DIR=Path('/tmp/git-dir/'), GIT_EDITOR='vim')
 ```
 
@@ -226,9 +225,9 @@ git = git.git_envs_override(GIT_TRACE=1, GIT_DIR=Path('/tmp/git-dir/'), GIT_EDIT
 
 ```python
 from pathlib import Path
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_envs_override(GIT_SSH=Path('/tmp/SSH')).git_envs_override(
     GIT_TERMINAL_PROMPT=1,
     GIT_NO_REPLACE_OBJECTS=True
@@ -239,10 +238,10 @@ re_overridden_git = overridden_git.git_envs_override(GIT_TRACE=True)
 #### ❌ Unset Git envs using a special `UNSET` marker
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 from vt.utils.commons.commons.core_py import UNSET
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_envs_override(GIT_ADVICE=True, GIT_TRACE=True)
 no_advice_unset_git = overridden_git.git_envs_override(GIT_TRACE=UNSET)
 ```
@@ -250,9 +249,9 @@ no_advice_unset_git = overridden_git.git_envs_override(GIT_TRACE=UNSET)
 #### 🔄 Reset Git envs by setting new values
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_envs_override(GIT_TRACE=True)
 git_trace_reset_git = overridden_git.git_envs_override(GIT_TRACE=False)
 ```
@@ -268,9 +267,9 @@ git_trace_reset_git = overridden_git.git_envs_override(GIT_TRACE=False)
 #### 🔁 Override a single Git opt (e.g., `--no-replace-objects`)
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 git = git.git_opts_override(no_replace_objects=True)
 ```
 
@@ -278,7 +277,7 @@ git = git.git_opts_override(no_replace_objects=True)
 
 ```python
 from pathlib import Path
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+from gitbolt.subprocess.impl.simple import SimpleGitCommand
 
 git = SimpleGitCommand()
 git = git.git_opts_override(no_replace_objects=True, git_dir=Path(), paginate=True)
@@ -287,10 +286,10 @@ git = git.git_opts_override(no_replace_objects=True, git_dir=Path(), paginate=Tr
 #### 🪢 Chain multiple option overrides fluently
 
 ```python
+import gitbolt
 from pathlib import Path
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_opts_override(exec_path=Path('tmp')).git_opts_override(
     noglob_pathspecs=True,
     no_advice=True
@@ -303,11 +302,11 @@ re_overridden_git = overridden_git.git_opts_override(glob_pathspecs=True)
 #### ❌ Unset Git opts using a special `UNSET` marker
 
 ```python
+import gitbolt
 from pathlib import Path
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
 from vt.utils.commons.commons.core_py import UNSET
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_opts_override(exec_path=Path('tmp'), no_advice=True)
 no_advice_unset_git = overridden_git.git_opts_override(no_advice=UNSET)
 ```
@@ -315,9 +314,9 @@ no_advice_unset_git = overridden_git.git_opts_override(no_advice=UNSET)
 #### 🔄 Reset Git opts by setting new values
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_opts_override(no_advice=True)
 no_advice_reset_git = overridden_git.git_opts_override(no_advice=False)
 ```
@@ -333,9 +332,9 @@ Introduced in `0.0.0dev4` to
 - have consistent interfaced commands run until all subcommands are provided by the library.
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git_command()
 git = git.git_opts_override(no_advice=True)
 git.subcmd_unchecked.run(['--version']) # run the version option for git.
 git.subcmd_unchecked.run(['version']) # run the version subcommand.
@@ -350,11 +349,11 @@ would be to make a system that receives CLI commands and does certain modificati
 actually running them. An example:
 
 ```python
-from gitbolt.git_subprocess.impl.simple import CLISimpleGitCommand
+import gitbolt
 
-opts = ["--no-pager", "--namespace", "n1"]   # options received from outside your program.
-envs = dict(GIT_AUTHOR_NAME="ss")   # env-vars received form outside your program.
-git = CLISimpleGitCommand(opts=opts, envs=envs)
+opts = ["--no-pager", "--namespace", "n1"]  # options received from outside your program.
+envs = dict(GIT_AUTHOR_NAME="ss")  # env-vars received form outside your program.
+git = gitbolt.get_git_command(opts=opts, envs=envs)
 
 # these can later be overridden
 git = git.git_opts_override(namespace="n2")

{gitbolt-0.0.0.dev14 → gitbolt-0.0.0.dev15}/README.md

@@ -78,9 +78,8 @@ Gitbolt lets you pass subcommands around as typed objects. This enables highly f
 
 ```python
 import gitbolt
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 version_subcmd = git.version_subcmd
 add_subcmd = git.add_subcmd
 
@@ -100,11 +99,11 @@ method_which_only_adds_a_file(add_subcmd)
 git subcommands are modeled as terminal functions that return stdout.
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
-status_out = git.status_subcmd.status()
-print(status_out)
+git = gitbolt.get_git()
+version_stdout = git.version_subcmd.version().version()
+print(version_stdout)
 ```
 
 ### 🪼 Modular Architecture
@@ -170,9 +169,9 @@ Extensive use of type-hints ensures that invalid usages fail early — at *compi
 #### 🔁 Override a single Git env (e.g., `GIT_TRACE`)
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 git = git.git_envs_override(GIT_TRACE=True)
 ```
 
@@ -180,9 +179,9 @@ git = git.git_envs_override(GIT_TRACE=True)
 
 ```python
 from pathlib import Path
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 git = git.git_envs_override(GIT_TRACE=1, GIT_DIR=Path('/tmp/git-dir/'), GIT_EDITOR='vim')
 ```
 
@@ -190,9 +189,9 @@ git = git.git_envs_override(GIT_TRACE=1, GIT_DIR=Path('/tmp/git-dir/'), GIT_EDIT
 
 ```python
 from pathlib import Path
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_envs_override(GIT_SSH=Path('/tmp/SSH')).git_envs_override(
     GIT_TERMINAL_PROMPT=1,
     GIT_NO_REPLACE_OBJECTS=True
@@ -203,10 +202,10 @@ re_overridden_git = overridden_git.git_envs_override(GIT_TRACE=True)
 #### ❌ Unset Git envs using a special `UNSET` marker
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 from vt.utils.commons.commons.core_py import UNSET
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_envs_override(GIT_ADVICE=True, GIT_TRACE=True)
 no_advice_unset_git = overridden_git.git_envs_override(GIT_TRACE=UNSET)
 ```
@@ -214,9 +213,9 @@ no_advice_unset_git = overridden_git.git_envs_override(GIT_TRACE=UNSET)
 #### 🔄 Reset Git envs by setting new values
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_envs_override(GIT_TRACE=True)
 git_trace_reset_git = overridden_git.git_envs_override(GIT_TRACE=False)
 ```
@@ -232,9 +231,9 @@ git_trace_reset_git = overridden_git.git_envs_override(GIT_TRACE=False)
 #### 🔁 Override a single Git opt (e.g., `--no-replace-objects`)
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 git = git.git_opts_override(no_replace_objects=True)
 ```
 
@@ -242,7 +241,7 @@ git = git.git_opts_override(no_replace_objects=True)
 
 ```python
 from pathlib import Path
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+from gitbolt.subprocess.impl.simple import SimpleGitCommand
 
 git = SimpleGitCommand()
 git = git.git_opts_override(no_replace_objects=True, git_dir=Path(), paginate=True)
@@ -251,10 +250,10 @@ git = git.git_opts_override(no_replace_objects=True, git_dir=Path(), paginate=Tr
 #### 🪢 Chain multiple option overrides fluently
 
 ```python
+import gitbolt
 from pathlib import Path
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_opts_override(exec_path=Path('tmp')).git_opts_override(
     noglob_pathspecs=True,
     no_advice=True
@@ -267,11 +266,11 @@ re_overridden_git = overridden_git.git_opts_override(glob_pathspecs=True)
 #### ❌ Unset Git opts using a special `UNSET` marker
 
 ```python
+import gitbolt
 from pathlib import Path
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
 from vt.utils.commons.commons.core_py import UNSET
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_opts_override(exec_path=Path('tmp'), no_advice=True)
 no_advice_unset_git = overridden_git.git_opts_override(no_advice=UNSET)
 ```
@@ -279,9 +278,9 @@ no_advice_unset_git = overridden_git.git_opts_override(no_advice=UNSET)
 #### 🔄 Reset Git opts by setting new values
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_opts_override(no_advice=True)
 no_advice_reset_git = overridden_git.git_opts_override(no_advice=False)
 ```
@@ -297,9 +296,9 @@ Introduced in `0.0.0dev4` to
 - have consistent interfaced commands run until all subcommands are provided by the library.
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git_command()
 git = git.git_opts_override(no_advice=True)
 git.subcmd_unchecked.run(['--version']) # run the version option for git.
 git.subcmd_unchecked.run(['version']) # run the version subcommand.
@@ -314,11 +313,11 @@ would be to make a system that receives CLI commands and does certain modificati
 actually running them. An example:
 
 ```python
-from gitbolt.git_subprocess.impl.simple import CLISimpleGitCommand
+import gitbolt
 
-opts = ["--no-pager", "--namespace", "n1"]   # options received from outside your program.
-envs = dict(GIT_AUTHOR_NAME="ss")   # env-vars received form outside your program.
-git = CLISimpleGitCommand(opts=opts, envs=envs)
+opts = ["--no-pager", "--namespace", "n1"]  # options received from outside your program.
+envs = dict(GIT_AUTHOR_NAME="ss")  # env-vars received form outside your program.
+git = gitbolt.get_git_command(opts=opts, envs=envs)
 
 # these can later be overridden
 git = git.git_opts_override(namespace="n2")

{gitbolt-0.0.0.dev14 → gitbolt-0.0.0.dev15}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gitbolt"
-version = "0.0.0dev14"
+version = "0.0.0dev15"
 description = "Fast, flexible and type-safe Git commands in Python."
 requires-python = ">=3.12"
 readme = "README.md"

{gitbolt-0.0.0.dev14 → gitbolt-0.0.0.dev15}/src/gitbolt/__init__.py

@@ -52,8 +52,8 @@ def get_git_command(
     git_root_dir: Path = Path.cwd(),
     *,
     git_prog: str | Path = GIT_CMD,
-    main_cmd_opts: list[str] | None = None,
-    main_cmd_envs: dict[str, str] | None = None,
+    opts: list[str] | None = None,
+    envs: dict[str, str] | None = None,
     prefer_cli: bool = False,
 ) -> GitCommand:
     """
@@ -75,8 +75,8 @@ def get_git_command(
     :param git_root_dir: Path to the git repo root directory. Defaults to current working directory.
     :param git_prog: git program name/location. Useful when user wants to run a separate git version/git emulator.
     :param opts: main git cli options. The main git command options like ``--no-replace-objects``, ``--no-pager``, ``-C`` etc are git main command args.
-    :param envs: main git cli env vars. Not supplying any env vars (default behavior: ``None``) simply supplies all
-        the env vars to the underlying runner.
+    :param envs: main git cli environment variables (env vars). Not supplying any env vars (default behavior: ``None``)
+        simply supplies all the env vars to the underlying runner.
     :param prefer_cli: cli opts and envs will be given priority over programmatically set opts and envs. Setting
         this param to ``True`` will make cli opts and envs appear later in the opts and envs strings which will
         make them override previously programmatically set opts and envs.
@@ -84,13 +84,13 @@ def get_git_command(
         separate runner in subprocess.
     """
     runner = _SimpleGitCR(git_prog)
-    if main_cmd_opts is None:
+    if opts is None:
         return _SimpleGitCommand(git_root_dir, runner)
     else:
         return _CLISimpleGitCommand(
             git_root_dir,
             runner,
-            opts=main_cmd_opts,
-            envs=main_cmd_envs,
+            opts=opts,
+            envs=envs,
             prefer_cli=prefer_cli,
         )

{gitbolt-0.0.0.dev14 → gitbolt-0.0.0.dev15}/src/gitbolt/base.py

@@ -20,29 +20,21 @@ from gitbolt.ls_tree import LsTreeArgsValidator, UtilLsTreeArgsValidator
 from gitbolt.add import AddArgsValidator, UtilAddArgsValidator
 
 
-class ForGit(Protocol):
-    """
-    Marker interface to mark an operation for git.
-    """
-
-    pass
-
-
-class HasGitUnderneath[G: "Git"](ForGit, Protocol):
+class HasGitUnderneath[G: "Git"](Protocol):
     """
     Stores a reference to main git instance.
     """
 
     @property
     @abstractmethod
-    def underlying_git(self) -> G:
+    def git(self) -> G:
         """
-        :return: stored git instance reference.
+        :return: stored underlying git instance reference.
         """
         ...
 
 
-class CanOverrideGitOpts(ForGit, Protocol):
+class CanOverrideGitOpts(Protocol):
     """
     Can override main git command options.
 
@@ -65,7 +57,7 @@ class CanOverrideGitOpts(ForGit, Protocol):
         ...
 
 
-class CanOverrideGitEnvs(ForGit, Protocol):
+class CanOverrideGitEnvs(Protocol):
     """
     Can override main git command environment variables.
 

{gitbolt-0.0.0.dev14 → gitbolt-0.0.0.dev15}/src/gitbolt/subprocess/base.py

@@ -306,13 +306,13 @@ class GitSubcmdCommand(GitSubCommand, HasGitUnderneath["GitCommand"], Protocol):
 
     @override
     def git_opts_override(self, **overrides: Unpack[GitOpts]) -> Self:
-        overridden_git = self.underlying_git.git_opts_override(**overrides)
+        overridden_git = self.git.git_opts_override(**overrides)
         self._set_underlying_git(overridden_git)
         return self
 
     @override
     def git_envs_override(self, **overrides: Unpack[GitEnvVars]) -> Self:
-        overridden_git = self.underlying_git.git_envs_override(**overrides)
+        overridden_git = self.git.git_envs_override(**overrides)
         self._set_underlying_git(overridden_git)
         return self
 
@@ -403,11 +403,11 @@ class LsTreeCommand(LsTree, GitSubcmdCommand, Protocol):
     def ls_tree(self, tree_ish: str, **ls_tree_opts: Unpack[GitLsTreeOpts]) -> str:
         self.args_validator.validate(tree_ish, **ls_tree_opts)
         sub_cmd_args = self.cli_args_builder.build(tree_ish, **ls_tree_opts)
-        main_cmd_args = self.underlying_git.build_main_cmd_args()
-        env_vars = self.underlying_git.build_git_envs()
+        main_cmd_args = self.git.build_main_cmd_args()
+        env_vars = self.git.build_git_envs()
 
         # Run the git command
-        result = self.underlying_git.runner.run_git_command(
+        result = self.git.runner.run_git_command(
             main_cmd_args,
             sub_cmd_args,
             check=True,
@@ -485,11 +485,11 @@ class AddCommand(Add, GitSubcmdCommand, Protocol):
             pathspec_file_nul=pathspec_file_nul,
             **add_opts,
         )
-        main_cmd_args = self.underlying_git.build_main_cmd_args()
-        env_vars = self.underlying_git.build_git_envs()
+        main_cmd_args = self.git.build_main_cmd_args()
+        env_vars = self.git.build_git_envs()
 
         # Run the git command
-        result = self.underlying_git.runner.run_git_command(
+        result = self.git.runner.run_git_command(
             main_cmd_args,
             sub_cmd_args,
             _input=pathspec_stdin,
@@ -584,8 +584,8 @@ class UncheckedSubcmd(GitSubcmdCommand, RootDirOp, Protocol):
 
         :return: ``CompletedProcess`` capturing all the required stdout, stderr, return-code etc.
         """
-        main_cmd_args = self.underlying_git.build_main_cmd_args()
-        envs_vars = self.underlying_git.build_git_envs()
+        main_cmd_args = self.git.build_main_cmd_args()
+        envs_vars = self.git.build_git_envs()
         another_supplied_env = subprocess_run_kwargs.pop("env", None)
         if another_supplied_env:
             if envs_vars is not None:
@@ -594,7 +594,7 @@ class UncheckedSubcmd(GitSubcmdCommand, RootDirOp, Protocol):
         capture_output = subprocess_run_kwargs.pop("capture_output", True)
         check = subprocess_run_kwargs.pop("check", True)
         # Run the git command
-        result = self.underlying_git.runner.run_git_command(
+        result = self.git.runner.run_git_command(
             main_cmd_args,
             subcommand_args,
             *subprocess_run_args,

{gitbolt-0.0.0.dev14 → gitbolt-0.0.0.dev15}/src/gitbolt/subprocess/impl/simple.py

@@ -36,7 +36,7 @@ class GitSubcmdCommandImpl(GitSubcmdCommand, ABC):
         self._underlying_git = git
 
     @property
-    def underlying_git(self) -> GitCommand:
+    def git(self) -> GitCommand:
         return self._underlying_git
 
     def _set_underlying_git(self, git: "GitCommand") -> None:
@@ -55,14 +55,14 @@ class VersionCommandImpl(VersionCommand, GitSubcmdCommandImpl):
         self, build_options: Literal[True, False] = False
     ) -> Version.VersionInfo | Version.VersionWithBuildInfo:
         self._require_valid_args(build_options)
-        main_cmd_args = self.underlying_git.build_main_cmd_args()
+        main_cmd_args = self.git.build_main_cmd_args()
         sub_cmd_args = [VERSION_CMD]
-        env_vars = self.underlying_git.build_git_envs()
+        env_vars = self.git.build_git_envs()
         if build_options:
             sub_cmd_args.append("--build-options")
 
         def rosetta_supplier():
-            return self.underlying_git.runner.run_git_command(
+            return self.git.runner.run_git_command(
                 main_cmd_args,
                 sub_cmd_args,
                 check=True,
@@ -76,7 +76,7 @@ class VersionCommandImpl(VersionCommand, GitSubcmdCommandImpl):
         return VersionCommand.VersionInfoForCmd(rosetta_supplier)
 
     def clone(self) -> "VersionCommandImpl":
-        return VersionCommandImpl(self.underlying_git)
+        return VersionCommandImpl(self.git)
 
 
 class LsTreeCommandImpl(LsTreeCommand, GitSubcmdCommandImpl):
@@ -117,7 +117,7 @@ class LsTreeCommandImpl(LsTreeCommand, GitSubcmdCommandImpl):
         return self._cli_args_builder
 
     def clone(self) -> "LsTreeCommandImpl":
-        return LsTreeCommandImpl(self.root_dir, self.underlying_git)
+        return LsTreeCommandImpl(self.root_dir, self.git)
 
 
 class AddCommandImpl(AddCommand, GitSubcmdCommandImpl):
@@ -150,7 +150,7 @@ class AddCommandImpl(AddCommand, GitSubcmdCommandImpl):
         return self._cli_args_builder
 
     def clone(self) -> "AddCommandImpl":
-        return AddCommandImpl(self.root_dir, self.underlying_git)
+        return AddCommandImpl(self.root_dir, self.git)
 
 
 class UncheckedSubcmdImpl(UncheckedSubcmd, GitSubcmdCommandImpl):
@@ -164,7 +164,7 @@ class UncheckedSubcmdImpl(UncheckedSubcmd, GitSubcmdCommandImpl):
         return self._root_dir
 
     def clone(self) -> "UncheckedSubcmdImpl":
-        return UncheckedSubcmdImpl(self.root_dir, self.underlying_git)
+        return UncheckedSubcmdImpl(self.root_dir, self.git)
 
 
 class SimpleGitCommand(GitCommand, RootDirOp):
@@ -266,8 +266,8 @@ class CLISimpleGitCommand(SimpleGitCommand):
     ):
         """
         :param opts: main git cli options.
-        :param envs: main git cli env vars. Not supplying any env vars (default behavior: ``None``) simply supplies all
-            the env vars to the underlying runner.
+        :param envs: main git cli environment variables (env vars). Not supplying any env
+            vars (default behavior: ``None``) simply supplies all the env vars to the underlying runner.
         :param prefer_cli: cli opts and envs will be given priority over programmatically set opts and envs. Setting
             this param to ``True`` will make cli opts and envs appear later in the opts and envs strings which will
             make them override previously programmatically set opts and envs.

{gitbolt-0.0.0.dev14 → gitbolt-0.0.0.dev15}/src/gitbolt.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitbolt
-Version: 0.0.0.dev14
+Version: 0.0.0.dev15
 Summary: Fast, flexible and type-safe Git commands in Python.
 Author-email: Suhas Krishna Srivastava <suhas.srivastava@vaastav.tech>
 Maintainer-email: Suhas Krishna Srivastava <suhas.srivastava@vaastav.tech>
@@ -114,9 +114,8 @@ Gitbolt lets you pass subcommands around as typed objects. This enables highly f
 
 ```python
 import gitbolt
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 version_subcmd = git.version_subcmd
 add_subcmd = git.add_subcmd
 
@@ -136,11 +135,11 @@ method_which_only_adds_a_file(add_subcmd)
 git subcommands are modeled as terminal functions that return stdout.
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
-status_out = git.status_subcmd.status()
-print(status_out)
+git = gitbolt.get_git()
+version_stdout = git.version_subcmd.version().version()
+print(version_stdout)
 ```
 
 ### 🪼 Modular Architecture
@@ -206,9 +205,9 @@ Extensive use of type-hints ensures that invalid usages fail early — at *compi
 #### 🔁 Override a single Git env (e.g., `GIT_TRACE`)
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 git = git.git_envs_override(GIT_TRACE=True)
 ```
 
@@ -216,9 +215,9 @@ git = git.git_envs_override(GIT_TRACE=True)
 
 ```python
 from pathlib import Path
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 git = git.git_envs_override(GIT_TRACE=1, GIT_DIR=Path('/tmp/git-dir/'), GIT_EDITOR='vim')
 ```
 
@@ -226,9 +225,9 @@ git = git.git_envs_override(GIT_TRACE=1, GIT_DIR=Path('/tmp/git-dir/'), GIT_EDIT
 
 ```python
 from pathlib import Path
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_envs_override(GIT_SSH=Path('/tmp/SSH')).git_envs_override(
     GIT_TERMINAL_PROMPT=1,
     GIT_NO_REPLACE_OBJECTS=True
@@ -239,10 +238,10 @@ re_overridden_git = overridden_git.git_envs_override(GIT_TRACE=True)
 #### ❌ Unset Git envs using a special `UNSET` marker
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 from vt.utils.commons.commons.core_py import UNSET
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_envs_override(GIT_ADVICE=True, GIT_TRACE=True)
 no_advice_unset_git = overridden_git.git_envs_override(GIT_TRACE=UNSET)
 ```
@@ -250,9 +249,9 @@ no_advice_unset_git = overridden_git.git_envs_override(GIT_TRACE=UNSET)
 #### 🔄 Reset Git envs by setting new values
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_envs_override(GIT_TRACE=True)
 git_trace_reset_git = overridden_git.git_envs_override(GIT_TRACE=False)
 ```
@@ -268,9 +267,9 @@ git_trace_reset_git = overridden_git.git_envs_override(GIT_TRACE=False)
 #### 🔁 Override a single Git opt (e.g., `--no-replace-objects`)
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 git = git.git_opts_override(no_replace_objects=True)
 ```
 
@@ -278,7 +277,7 @@ git = git.git_opts_override(no_replace_objects=True)
 
 ```python
 from pathlib import Path
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+from gitbolt.subprocess.impl.simple import SimpleGitCommand
 
 git = SimpleGitCommand()
 git = git.git_opts_override(no_replace_objects=True, git_dir=Path(), paginate=True)
@@ -287,10 +286,10 @@ git = git.git_opts_override(no_replace_objects=True, git_dir=Path(), paginate=Tr
 #### 🪢 Chain multiple option overrides fluently
 
 ```python
+import gitbolt
 from pathlib import Path
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_opts_override(exec_path=Path('tmp')).git_opts_override(
     noglob_pathspecs=True,
     no_advice=True
@@ -303,11 +302,11 @@ re_overridden_git = overridden_git.git_opts_override(glob_pathspecs=True)
 #### ❌ Unset Git opts using a special `UNSET` marker
 
 ```python
+import gitbolt
 from pathlib import Path
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
 from vt.utils.commons.commons.core_py import UNSET
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_opts_override(exec_path=Path('tmp'), no_advice=True)
 no_advice_unset_git = overridden_git.git_opts_override(no_advice=UNSET)
 ```
@@ -315,9 +314,9 @@ no_advice_unset_git = overridden_git.git_opts_override(no_advice=UNSET)
 #### 🔄 Reset Git opts by setting new values
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git()
 overridden_git = git.git_opts_override(no_advice=True)
 no_advice_reset_git = overridden_git.git_opts_override(no_advice=False)
 ```
@@ -333,9 +332,9 @@ Introduced in `0.0.0dev4` to
 - have consistent interfaced commands run until all subcommands are provided by the library.
 
 ```python
-from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+import gitbolt
 
-git = SimpleGitCommand()
+git = gitbolt.get_git_command()
 git = git.git_opts_override(no_advice=True)
 git.subcmd_unchecked.run(['--version']) # run the version option for git.
 git.subcmd_unchecked.run(['version']) # run the version subcommand.
@@ -350,11 +349,11 @@ would be to make a system that receives CLI commands and does certain modificati
 actually running them. An example:
 
 ```python
-from gitbolt.git_subprocess.impl.simple import CLISimpleGitCommand
+import gitbolt
 
-opts = ["--no-pager", "--namespace", "n1"]   # options received from outside your program.
-envs = dict(GIT_AUTHOR_NAME="ss")   # env-vars received form outside your program.
-git = CLISimpleGitCommand(opts=opts, envs=envs)
+opts = ["--no-pager", "--namespace", "n1"]  # options received from outside your program.
+envs = dict(GIT_AUTHOR_NAME="ss")  # env-vars received form outside your program.
+git = gitbolt.get_git_command(opts=opts, envs=envs)
 
 # these can later be overridden
 git = git.git_opts_override(namespace="n2")