gitbolt 0.0.0.dev1__tar.gz → 0.0.0.dev2__tar.gz

{gitbolt-0.0.0.dev1 → gitbolt-0.0.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitbolt
-Version: 0.0.0.dev1
+Version: 0.0.0.dev2
 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>

{gitbolt-0.0.0.dev1 → gitbolt-0.0.0.dev2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gitbolt"
-version = "0.0.0dev1"
+version = "0.0.0dev2"
 description = "Fast, flexible and type-safe Git commands in Python."
 requires-python = ">=3.12"
 readme = "README.md"
@@ -44,6 +44,7 @@ pygit2 = ['pygit2']
 
 [dependency-groups]
 # TODO: report the mypy recent version (1.16.0, 1.16.1 issue) RuntimeError: ('Not implemented', <class 'mypy.types.TypeGuardedType'>)
+#   btw, this error doesn't show in the latest developer version. So, this error will go away with 1.17.0 relase
 dev = ["mypy==1.15.0", "ruff"]
 doc = ['sphinx', 'sphinx-argparse']
 test = ['pytest', 'pytest-cov']

gitbolt-0.0.0.dev2/src/gitbolt/__init__.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python3
+# coding=utf-8
+
+"""
+Git command interfaces with default implementation using subprocess calls.
+"""
+from pathlib import Path
+
+# region imports
+# region base related imports
+from gitbolt.base import Git as Git
+from gitbolt.base import CanOverrideGitOpts as CanOverrideGitOpts
+from gitbolt.base import HasGitUnderneath as HasGitUnderneath
+from gitbolt.base import GitSubCommand as GitSubCommand
+from gitbolt.base import LsTree as LsTree
+from gitbolt.base import Version as Version
+from gitbolt.base import Add as Add
+# endregion
+# endregion
+
+
+def get_git(git_root_dir: Path = Path.cwd()) -> Git:
+    """
+    Get operational and programmatic ``Git``.
+
+    Examples:
+
+    * Get git version:
+
+    >>> import subprocess
+    >>> import gitbolt
+    >>> git = gitbolt.get_git()
+    >>> assert git.version == subprocess.run(['git', 'version'], capture_output=True, text=True).stdout.strip()
+
+    :param git_root_dir: Path to the git repo root directory. Defaults to current working directory.
+    """
+    from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+    return SimpleGitCommand(git_root_dir)

{gitbolt-0.0.0.dev1 → gitbolt-0.0.0.dev2}/src/gitbolt.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitbolt
-Version: 0.0.0.dev1
+Version: 0.0.0.dev2
 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>

gitbolt-0.0.0.dev1/src/gitbolt/__init__.py

@@ -1,18 +0,0 @@
-#!/usr/bin/env python3
-# coding=utf-8
-
-"""
-Git command interfaces with default implementation using subprocess calls.
-"""
-
-# region imports
-# region base related imports
-from gitbolt.base import Git as Git
-from gitbolt.base import CanOverrideGitOpts as CanOverrideGitOpts
-from gitbolt.base import HasGitUnderneath as HasGitUnderneath
-from gitbolt.base import GitSubCommand as GitSubCommand
-from gitbolt.base import LsTree as LsTree
-from gitbolt.base import Version as Version
-from gitbolt.base import Add as Add
-# endregion
-# endregion