gitbolt 0.0.0.dev8__py3-none-any.whl → 0.0.0.dev9__py3-none-any.whl

gitbolt/base.py

@@ -154,6 +154,8 @@ class Add(GitSubCommand, RootDirOp, Protocol):
     Interface for ``git add`` command.
     """
 
+    # TODO: `pathspec: str` -> `pathspec_or_path: str | Path`.
+    #  This will make a convenience method for python use.
     @overload
     @abstractmethod
     def add(

gitbolt/git_subprocess/base.py

@@ -459,6 +459,10 @@ class UncheckedSubcmd(GitSubcmdCommand, RootDirOp, Protocol):
     def _subcmd_from_git(self, git: "Git") -> Self:
         return self
 
+    # TODO: the static type-safety of `run()` is not correct.
+    #  `run([..], text=True, _input=b'<some-str>')` is incorrect
+    #  as this should raise static-type check safety issue because text=True and _input is bytes. Similarly
+    #  `run([..], text=False, _input='<some-bytes>')` does not raise issue as well.
     @overload
     def run(
         self,

gitbolt/models.py

@@ -368,6 +368,17 @@ class GitLogEnvVars(TypedDict, total=False):
     """
 
 
+class GitGPGEnvVars(TypedDict, total=False):
+    """
+    Environment variables related to GPG and git.
+    """
+
+    GNUPGHOME: Path
+    """
+    GPG will use this path for operations.
+    """
+
+
 class GitEnvVars(
     GitCommitEnvVars,
     GitEditorEnvVars,
@@ -377,6 +388,7 @@ class GitEnvVars(
     GitRepoEnvVars,
     GitNetworkEnvVars,
     GitSysEnvVars,
+    GitGPGEnvVars,
 ):
     """
     Environment variables that control Git's runtime behavior.

{gitbolt-0.0.0.dev8.dist-info → gitbolt-0.0.0.dev9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitbolt
-Version: 0.0.0.dev8
+Version: 0.0.0.dev9
 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>
@@ -26,7 +26,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: vt-err-hndlr==0.0.0dev1
+Requires-Dist: vt-err-hndlr>=0.0.0dev1
 Provides-Extra: pygit2
 Requires-Dist: pygit2; extra == "pygit2"
 Provides-Extra: test
@@ -62,6 +62,7 @@ Dynamic: license-file
 * 📄 **Transparent Output:** Returns a Git command's `stdout` as-is.
 * 🧪 **Terminal Functions:** Git subcommands are terminal functions.
 * 🧼 **Idiomatic Python:** Write commands in idiomatic Python at compile-time and be confident they’ll execute smoothly at runtime.
+* 🎀 **Add-ons:** Special features provided to ease programming with git. These can be added if required.
 
 ---
 
@@ -140,6 +141,53 @@ status_out = git.status_subcmd.status()
 print(status_out)
 ```
 
+### 🪼 Modular Architecture
+
+#### 🧑‍💻 Modular at the programmatic level
+
+Commands are designed to be passed around as objects. This makes them modular and thus users can opt to use only 
+particular commands.
+
+```python
+from gitbolt import get_git
+
+git = get_git() # get git object for the current working directory
+add_subcmd = git.add_subcmd
+ls_tree_subcmd = git.ls_tree_subcmd
+
+# now, functions can be written to accept only the required subcommands and nothing more than that.
+```
+
+#### 📽️ Modular at project level
+
+Only required commands and hence their implementations can be installed as per user requirement.
+
+e.g.
+
+- To install only the `git add` command related logic:
+  - ```shell
+    pip install gitbolt[add]
+    ```
+- To install command logic related to `git add` and `git rm` commands:
+  - ```shell
+    pip install gitbolt[add,rm]
+    ```
+- Install all porcelain related commands:
+  - ```shell
+    pip install gitbolt[porcelain]
+    ```
+- Install high performance `pygit2` implementations:
+  - ```shell
+    pip install gitbolt[pygit2]
+    ```
+  - ```shell
+    pip install gitbolt[add,pygit2,rm]
+    ```
+- At last, install every command's implementation:
+  - ```shell
+    pip install gitbolt[all]
+    ```
+
 ---
 
 ## 🧠 Strong Typing Everywhere
@@ -325,3 +373,4 @@ Transformers for formatting/parsing can be added later.
 
 * Support `pygit2` for direct, fast Git access.
 * Enable `porcelain` support using `pygit2` where required.
+  > `pygit2` usage will automatically make all commands return in porcelain mode.

{gitbolt-0.0.0.dev8.dist-info → gitbolt-0.0.0.dev9.dist-info}/RECORD

@@ -1,18 +1,18 @@
 gitbolt/__init__.py,sha256=SyV-PMv4Ul_k8sh7Y76Y4hUku1N5s-4ViyDpVbfRDOI,1176
 gitbolt/_internal_init.py,sha256=alSsIMgBWHmOdUo7P1ewftR12xPv8vb3ZgECuVsRMwk,485
 gitbolt/add.py,sha256=F16d0SQfLrjbpUzJIjKFwGU4KLSjqtYLOA9oZ5gdNS0,31731
-gitbolt/base.py,sha256=Vhd4GkTu3OscngXRJVfUMxVDY5Ilu6WVZvuhNw4dgFA,9649
+gitbolt/base.py,sha256=KIWqAVaTUzKfcsfiWY5NXGrZ-WSeBkGvo_pk86mpWEs,9771
 gitbolt/constants.py,sha256=DTdG44PiJ-2XbScPcvvUOMGVDjddH-j7pORO42fjgiE,206
 gitbolt/exceptions.py,sha256=7YvR7whZYM1hlWZk4GxHbeNgJ0KJXElg5VFA1Vi-fiA,989
 gitbolt/ls_tree.py,sha256=PrDSoh4Pnqh6g4AfX8kwgez_zHYaH4yqknULbFbisUY,6269
-gitbolt/models.py,sha256=iwIO-ugHYiKS57I_LPo3uDFEQlAtu2mnn5AjZHHQg04,18828
+gitbolt/models.py,sha256=ExIYraiqD_WlwouUady0UtnZ8Vi9FlkzOZkWoCmOMz4,19040
 gitbolt/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 gitbolt/pytest_plugin.py,sha256=Gto30Ofmfz8kJ_AuBrEhqENmWoDlpMnsrpQWzHDmUi4,833
 gitbolt/utils.py,sha256=XftX3LIKtfzjQaUZUF3QYaFJFM-QdFjc05ZrZSMSdeM,6315
 gitbolt/git_subprocess/__init__.py,sha256=yEyJKH_iXFBkdgQMwE8vnHnhVTrjs2RkQUjUCF25SzU,590
 gitbolt/git_subprocess/_internal_init.py,sha256=C6jfsbjXhIFHaDH9GE-wLPAN9WMlUU57rRLWvfpZuAs,255
 gitbolt/git_subprocess/add.py,sha256=1PA9XonqFi2O941eBwIPMobSNgEJ0tgFYxlkVXSe1K4,17277
-gitbolt/git_subprocess/base.py,sha256=iAL_aFiywqbZGuPHTqY03ve5O0bYkdyLzmdzc30mM4E,17756
+gitbolt/git_subprocess/base.py,sha256=1tXy5kgmY_2e6jofuqEFY0y-yXTSgGD5SF7hwoMr4xU,18075
 gitbolt/git_subprocess/constants.py,sha256=3qHXbNjPf_DOhTPNHi3_bcvIpvtqvgFtpGoTJLYmTWk,250
 gitbolt/git_subprocess/exceptions.py,sha256=cx4YKzxeBRSRKoF-oakZLpFUGrAHiGj1FtMIsiK5oHc,4063
 gitbolt/git_subprocess/ls_tree.py,sha256=MmM3qh-kvkD_tGQG9yliLx-reY_5TIVEArvAXJN6rP4,13200
@@ -22,9 +22,9 @@ gitbolt/git_subprocess/impl/simple.py,sha256=sjdby07SlLfdKpGlLedN9nYEAWxkGqy-rlJ
 gitbolt/git_subprocess/runner/__init__.py,sha256=LPxbj3AwKLXyDxxCLwAVtl5b5SKjaNDj99lkKz6VSOU,177
 gitbolt/git_subprocess/runner/base.py,sha256=Sof2WaNyYULiObRF7WjaGs7-yGrdyeHUXchE2tg1820,1562
 gitbolt/git_subprocess/runner/simple_impl.py,sha256=JvKCQ_MITguuMn3f3hVQwfAukymkIqFdli5f2fxin54,2524
-gitbolt-0.0.0.dev8.dist-info/licenses/LICENSE,sha256=pOzr5bMWS6mHi3vro8d5vw0qW1i14rVq2XFrDuystVY,11372
-gitbolt-0.0.0.dev8.dist-info/METADATA,sha256=sioQ-E59oXr5auqJiY0iOJNrI_1rBiSBtHDQ4_ZtGmE,11287
-gitbolt-0.0.0.dev8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-gitbolt-0.0.0.dev8.dist-info/entry_points.txt,sha256=Q078Wjss4skreUs8hzAEJ8sUcH4Rhjc9emZ4jRXCiBM,52
-gitbolt-0.0.0.dev8.dist-info/top_level.txt,sha256=QCXclkzSPZjgamcwB6XuKJexaJ1as_TLUUSGdIDA7VY,8
-gitbolt-0.0.0.dev8.dist-info/RECORD,,
+gitbolt-0.0.0.dev9.dist-info/licenses/LICENSE,sha256=pOzr5bMWS6mHi3vro8d5vw0qW1i14rVq2XFrDuystVY,11372
+gitbolt-0.0.0.dev9.dist-info/METADATA,sha256=_XD_9kFZ2UrJT6apE-rKe_CUnbi6HAmZB0vEp3jdv94,12710
+gitbolt-0.0.0.dev9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+gitbolt-0.0.0.dev9.dist-info/entry_points.txt,sha256=Q078Wjss4skreUs8hzAEJ8sUcH4Rhjc9emZ4jRXCiBM,52
+gitbolt-0.0.0.dev9.dist-info/top_level.txt,sha256=QCXclkzSPZjgamcwB6XuKJexaJ1as_TLUUSGdIDA7VY,8
+gitbolt-0.0.0.dev9.dist-info/RECORD,,