gitbolt 0.0.0.dev8__tar.gz → 0.0.0.dev9__tar.gz

{gitbolt-0.0.0.dev8 → gitbolt-0.0.0.dev9}/PKG-INFO

@@ -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 → gitbolt-0.0.0.dev9}/README.md

@@ -27,6 +27,7 @@
 * 📄 **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.
 
 ---
 
@@ -105,6 +106,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
@@ -290,3 +338,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 → gitbolt-0.0.0.dev9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gitbolt"
-version = "0.0.0dev8"
+version = "0.0.0dev9"
 description = "Fast, flexible and type-safe Git commands in Python."
 requires-python = ">=3.12"
 readme = "README.md"
@@ -36,7 +36,7 @@ classifiers = [
   "Typing :: Typed"
 ]
 dependencies = [
-  "vt-err-hndlr == 0.0.0dev1"
+  "vt-err-hndlr >= 0.0.0dev1"
 ]
 
 [project.optional-dependencies]

{gitbolt-0.0.0.dev8 → gitbolt-0.0.0.dev9}/src/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-0.0.0.dev8 → gitbolt-0.0.0.dev9}/src/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-0.0.0.dev8 → gitbolt-0.0.0.dev9}/src/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 → gitbolt-0.0.0.dev9}/src/gitbolt.egg-info/PKG-INFO

@@ -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 → gitbolt-0.0.0.dev9}/src/gitbolt.egg-info/requires.txt

@@ -1,4 +1,4 @@
-vt-err-hndlr==0.0.0dev1
+vt-err-hndlr>=0.0.0dev1
 
 [pygit2]
 pygit2