gitbolt 0.0.0.dev1__tar.gz

gitbolt-0.0.0.dev1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Vaastav Technologies (OPC) Private Limited
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

gitbolt-0.0.0.dev1/PKG-INFO

@@ -0,0 +1,308 @@
+Metadata-Version: 2.4
+Name: gitbolt
+Version: 0.0.0.dev1
+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>
+License-Expression: Apache-2.0
+Project-URL: homepage, https://github.com/Vaastav-Technologies/py-gitbolt
+Project-URL: source, https://github.com/Vaastav-Technologies/py-gitbolt
+Project-URL: issues, https://github.com/Vaastav-Technologies/py-gitbolt/issues
+Keywords: git,vcs,library,version control
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Topic :: Education
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Version Control
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: vt-err-hndlr==0.0.0dev1
+Provides-Extra: pygit2
+Requires-Dist: pygit2; extra == "pygit2"
+Dynamic: license-file
+
+# 🚀 Gitbolt
+
+![PyPI - Types](https://img.shields.io/pypi/types/gitbolt)
+![GitHub License](https://img.shields.io/github/license/Vaastav-Technologies/py-gitbolt)
+[![🔧 test](https://github.com/Vaastav-Technologies/py-gitbolt/actions/workflows/test.yml/badge.svg)](https://github.com/Vaastav-Technologies/py-gitbolt/actions/workflows/test.yml)
+[![💡 typecheck](https://github.com/Vaastav-Technologies/py-gitbolt/actions/workflows/typecheck.yml/badge.svg)](https://github.com/Vaastav-Technologies/py-gitbolt/actions/workflows/typecheck.yml)
+[![🛠️ lint](https://github.com/Vaastav-Technologies/py-gitbolt/actions/workflows/lint.yml/badge.svg)](https://github.com/Vaastav-Technologies/py-gitbolt/actions/workflows/lint.yml)
+[![📊 coverage](https://codecov.io/gh/Vaastav-Technologies/py-gitbolt/branch/main/graph/badge.svg)](https://codecov.io/gh/Vaastav-Technologies/py-gitbolt)
+[![📤 Upload Python Package](https://github.com/Vaastav-Technologies/py-gitbolt/actions/workflows/python-publish.yml/badge.svg)](https://github.com/Vaastav-Technologies/py-gitbolt/actions/workflows/python-publish.yml)
+![PyPI - Version](https://img.shields.io/pypi/v/gitbolt)
+
+**Fast, flexible and type-safe Git command execution in Python using subprocess.**
+
+---
+
+## ✨ Features
+
+* 🧠 **Typed:** All commands and options are statically type-checked.
+* ⚡ **Fast:** Minimal abstractions over subprocess, runs directly on your system Git.
+* 🧩 **Composable:** Git commands and options can be passed around as objects.
+* 🔁 **Overridable:** Easily override environment variables and options in a chainable, readable manner.
+* 📦 **Lightweight:** No dependencies on heavy Git libraries or C extensions.
+* 🧰 **Extensible:** Future support for output transformers and other plugins.
+* 🚨 **Exception Handling:** Raises any error as a Python-recognisable exception.
+* 📤 **Debuggable:** Exceptions capture `stdout`, `stderr`, and the return code of the run command.
+* 💤 **Lazy Execution:** Inherently lazily processed.
+* 📄 **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.
+
+---
+
+## 📦 Installation
+
+```bash
+pip install gitbolt
+```
+
+---
+
+## 💡 Motivation
+
+Running system commands in Python can be tricky for the following reasons:
+
+1. Arguments sent to `subprocess` may not be typed correctly and result in runtime errors.
+2. Argument groups may be mutually exclusive or required conditionally — again causing runtime issues.
+3. Errors from subprocess are often unhelpful and difficult to debug.
+
+Also, using subprocess effectively means you must:
+
+* Understand and manage process setup, piping, and teardown.
+* Know your CLI command intricacies in depth.
+
+> This project exists to fix all that — with ergonomics, speed, and type-safety.
+
+---
+
+## 🎯 Project Goals
+
+### ✅ Predictable Compile-Time Behavior
+
+Type-checking ensures runtime safety.
+
+### ✅ Ergonomic APIs
+
+<details>
+<summary>Make git command interfaces as ergonomic to the user as possible.</summary>
+
+#### Provide versions of most used command combinations
+
+`git hash-object` supports taking multiple files and outputs a hash per file. But in practice, it's most often used to write a single file to the Git object database and return its hash. To match this real-world usage, Gitbolt offers a more ergonomic method that accepts one file and returns one hash — while still giving you the flexibility to access the full range of `git hash-object` capabilities when needed.
+
+#### Let subcommands be passed around as objects
+
+Gitbolt lets you pass subcommands around as typed objects. This enables highly focused, minimal APIs — you can write functions that accept only the subcommands they truly need. This leads to cleaner logic, better separation of concerns, and compile-time guarantees that help prevent misuse.
+
+```python
+import gitbolt
+from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+
+git = SimpleGitCommand()
+version_subcmd = git.version_subcmd
+add_subcmd = git.add_subcmd
+
+def method_which_only_adds_a_file(add_subcmd: gitbolt.base.Add):
+    """
+    This method only requires the `add` subcommand.
+    """
+    ...
+
+method_which_only_adds_a_file(add_subcmd)
+```
+
+</details>
+
+### ✅ Subcommands as Objects
+
+git subcommands are modeled as terminal functions that return stdout.
+
+```python
+from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+
+git = SimpleGitCommand()
+status_out = git.status_subcmd.status()
+print(status_out)
+```
+
+---
+
+## 🧠 Strong Typing Everywhere
+
+Extensive use of type-hints ensures that invalid usages fail early — at *compile-time*. Write at compile-time and be sure that commands run error-free at runtime.
+
+---
+
+<details>
+<summary>Allow users to set/unset/reset Git environment variables and main command options using typed, chainable, Pythonic methods — just before a subcommand is executed.</summary>
+
+### 🧬 Git Environment Variables
+
+#### 🔁 Override a single Git env (e.g., `GIT_TRACE`)
+
+```python
+from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+
+git = SimpleGitCommand()
+git = git.git_envs_override(GIT_TRACE=True)
+```
+
+#### 🌐 Override multiple Git envs (e.g., `GIT_TRACE`, `GIT_DIR`, `GIT_EDITOR`)
+
+```python
+from pathlib import Path
+from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+
+git = SimpleGitCommand()
+git = git.git_envs_override(GIT_TRACE=1, GIT_DIR=Path('/tmp/git-dir/'), GIT_EDITOR='vim')
+```
+
+#### 🪢 Chain multiple overrides fluently
+
+```python
+from pathlib import Path
+from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+
+git = SimpleGitCommand()
+overridden_git = git.git_envs_override(GIT_SSH=Path('/tmp/SSH')).git_envs_override(
+    GIT_TERMINAL_PROMPT=1,
+    GIT_NO_REPLACE_OBJECTS=True
+)
+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
+from vt.utils.commons.commons.core_py import UNSET
+
+git = SimpleGitCommand()
+overridden_git = git.git_envs_override(GIT_ADVICE=True, GIT_TRACE=True)
+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
+
+git = SimpleGitCommand()
+overridden_git = git.git_envs_override(GIT_TRACE=True)
+git_trace_reset_git = overridden_git.git_envs_override(GIT_TRACE=False)
+```
+</details>
+
+---
+
+<details>
+<summary>Allow users to set/unset/reset git main command options in typed and pythonic manner just before subcommand run to provide maximal flexibility.</summary>
+
+### ⚙️ Git Main Command Options
+
+#### 🔁 Override a single Git opt (e.g., `--no-replace-objects`)
+
+```python
+from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+
+git = SimpleGitCommand()
+git = git.git_opts_override(no_replace_objects=True)
+```
+
+#### 🌐 Override multiple options (e.g., `--git-dir`, `--paginate`)
+
+```python
+from pathlib import Path
+from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+
+git = SimpleGitCommand()
+git = git.git_opts_override(no_replace_objects=True, git_dir=Path(), paginate=True)
+```
+
+#### 🪢 Chain multiple option overrides fluently
+
+```python
+from pathlib import Path
+from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+
+git = SimpleGitCommand()
+overridden_git = git.git_opts_override(exec_path=Path('tmp')).git_opts_override(
+    noglob_pathspecs=True,
+    no_advice=True
+).git_opts_override(
+    config_env={'auth': 'suhas', 'comm': 'suyog'}
+)
+re_overridden_git = overridden_git.git_opts_override(glob_pathspecs=True)
+```
+
+#### ❌ Unset Git opts using a special `UNSET` marker
+
+```python
+from pathlib import Path
+from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+from vt.utils.commons.commons.core_py import UNSET
+
+git = SimpleGitCommand()
+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)
+```
+
+#### 🔄 Reset Git opts by setting new values
+
+```python
+from gitbolt.git_subprocess.impl.simple import SimpleGitCommand
+
+git = SimpleGitCommand()
+overridden_git = git.git_opts_override(no_advice=True)
+no_advice_reset_git = overridden_git.git_opts_override(no_advice=False)
+```
+
+</details>
+
+
+---
+
+## 🔍 Transparent by Default
+
+Output of git commands is returned as-is. No transformations unless explicitly requested.
+Transformers for formatting/parsing can be added later.
+
+---
+
+## ✅ Benefits Out-of-the-Box
+
+* 🔄 Composable Git commands.
+* 📤 Returns raw stdout.
+* 🚨 Exceptions with full context.
+* 💤 Lazy execution.
+* 🧠 Strong typing and compile-time guarantees.
+* 🧼 Idiomatic Python.
+* 🧪 Terminal subcommands.
+* 💣 Fail-fast on invalid usage.
+
+---
+
+## 📄 More Information
+
+- 📜 [License (Apache-2.0)](./LICENSE)
+- 🤝 [Contributing Guide](./CONTRIBUTING.md)
+
+---
+
+## 🚧 Future Goals
+
+* Support `pygit2` for direct, fast Git access.
+* Enable `porcelain` support using `pygit2` where required.