gitoxide 0.1.0__cp39-abi3-win_amd64.whl

gitoxide/__init__.py

@@ -0,0 +1,50 @@
+"""gitoxide — fast, safe, pure-Rust Git for Python.
+
+This package provides Python bindings to the `gitoxide <https://github.com/GitoxideLabs/gitoxide>`_
+engine (the ``gix`` crate), the pure-Rust Git implementation created by Byron,
+the original author of GitPython.
+
+It aims to be a modern alternative to GitPython:
+
+* **Fast** — no subprocess spawning like GitPython; work happens in-process in Rust.
+* **Portable** — no dependency on a system ``libgit2`` like pygit2; ships as
+  self-contained wheels.
+* **Safe** — memory-safe Rust under the hood.
+
+Quick start
+-----------
+
+>>> import gitoxide
+>>> repo = gitoxide.open(".")
+>>> head = repo.head_commit()
+>>> print(head.short_id, head.summary)
+>>> for commit in repo.commits(max_count=10):
+...     print(commit.short_id, commit.author.name, commit.summary)
+"""
+
+from ._gitoxide import (
+    Commit,
+    GitoxideError,
+    Reference,
+    Repository,
+    Signature,
+    discover,
+    gix_version,
+    init,
+    open,
+)
+
+__all__ = [
+    "Commit",
+    "GitoxideError",
+    "Reference",
+    "Repository",
+    "Signature",
+    "discover",
+    "gix_version",
+    "init",
+    "open",
+    "__version__",
+]
+
+__version__ = "0.1.0"

gitoxide/_gitoxide.pyi

@@ -0,0 +1,72 @@
+"""Type stubs for the native ``gitoxide._gitoxide`` extension module."""
+
+from pathlib import Path
+from typing import List, Optional, Union
+
+StrPath = Union[str, Path]
+
+class GitoxideError(Exception):
+    """Base error raised for failed gitoxide operations."""
+
+class Signature:
+    """Authorship information (name, email, timestamp) attached to a commit."""
+
+    name: str
+    email: str
+    time: int
+    """Seconds since the Unix epoch."""
+    offset: int
+    """UTC offset in seconds (east of UTC is positive)."""
+
+class Commit:
+    """A fully-decoded, owned view of a git commit."""
+
+    id: str
+    tree_id: str
+    message: str
+    author: Signature
+    committer: Signature
+    parents: List[str]
+    summary: str
+    """The first line of the commit message."""
+    short_id: str
+    """Abbreviated (7-char) commit id."""
+
+class Reference:
+    """A git reference (branch, tag, ...) and the object it points at."""
+
+    name: str
+    shorthand: str
+    target: Optional[str]
+
+class Repository:
+    """A handle to a git repository."""
+
+    @staticmethod
+    def open(path: StrPath) -> "Repository": ...
+    @staticmethod
+    def discover(path: StrPath) -> "Repository": ...
+    @staticmethod
+    def init(path: StrPath, bare: bool = False) -> "Repository": ...
+    git_dir: Path
+    workdir: Optional[Path]
+    is_bare: bool
+    is_shallow: bool
+    head_id: Optional[str]
+    head_name: Optional[str]
+    head_is_detached: bool
+    def head_commit(self) -> Commit: ...
+    def rev_parse(self, spec: str) -> str: ...
+    def commit(self, rev: str) -> Commit: ...
+    def commits(
+        self, rev: Optional[str] = None, max_count: Optional[int] = None
+    ) -> List[Commit]: ...
+    def references(self) -> List[Reference]: ...
+    def branches(self) -> List[str]: ...
+    def tags(self) -> List[str]: ...
+    def read_blob(self, rev: str) -> bytes: ...
+
+def open(path: StrPath) -> Repository: ...
+def discover(path: StrPath) -> Repository: ...
+def init(path: StrPath, bare: bool = False) -> Repository: ...
+def gix_version() -> str: ...

gitoxide-0.1.0.dist-info/METADATA

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: gitoxide
+Version: 0.1.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Dist: pytest>=7.0 ; extra == 'test'
+Provides-Extra: test
+License-File: LICENSE-MIT
+License-File: LICENSE-APACHE
+Summary: Fast, safe, pure-Rust Git for Python — bindings to the gitoxide engine and a modern alternative to GitPython
+Keywords: git,gitoxide,gix,vcs,version-control,gitpython
+Author-email: Xianpeng Shen <xianpeng.shen@gmail.com>
+License-Expression: MIT OR Apache-2.0
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/shenxianpeng/gitoxide
+Project-URL: Repository, https://github.com/shenxianpeng/gitoxide
+Project-URL: gitoxide (Rust), https://github.com/GitoxideLabs/gitoxide
+
+# gitoxide-python
+
+[![CI](https://github.com/shenxianpeng/gitoxide/actions/workflows/CI.yml/badge.svg)](https://github.com/shenxianpeng/gitoxide/actions/workflows/CI.yml)
+
+**Fast, safe, pure-Rust Git for Python — bindings to the [gitoxide](https://github.com/GitoxideLabs/gitoxide) engine, and a modern alternative to GitPython.**
+
+`gitoxide` (the `gix` crate) is a next-generation, pure-Rust implementation of
+Git.
+
+This project exposes that engine to Python through [PyO3](https://pyo3.rs) and
+ships as pre-built wheels via [maturin](https://www.maturin.rs), so you get:
+
+| | GitPython | pygit2 | **gitoxide-python** |
+|---|---|---|---|
+| Backend | shells out to the `git` CLI | C `libgit2` | pure-Rust `gix` |
+| Speed | slow (spawns a subprocess per call) | fast | fast (in-process, no subprocess) |
+| Install | needs `git` on `PATH` | needs a C toolchain / system `libgit2` | `pip install`, self-contained wheels |
+| Memory safety | n/a (subprocess) | C | Rust |
+
+> **Status: alpha.** The binding surface is small but real and growing. It
+> currently covers read-oriented workflows (open/discover, HEAD, history walk,
+> refs, branches, tags, blob reads) — the operations DevOps tooling reaches for
+> most. See [Roadmap](#roadmap).
+
+## Installation
+
+```bash
+pip install gitoxide
+```
+
+Pre-built wheels are published for Linux (manylinux, x86_64 + aarch64), macOS
+(x86_64 + Apple Silicon), and Windows — no Rust toolchain or system `libgit2`
+required.
+
+### From source
+
+Building from a checkout (or from the sdist on an unsupported platform) requires
+a [Rust toolchain](https://rustup.rs):
+
+```bash
+pip install maturin
+maturin develop            # build + install into the active virtualenv
+# or build a wheel:
+maturin build --release
+```
+
+## Quick start
+
+```python
+import gitoxide
+
+repo = gitoxide.open(".")            # or gitoxide.discover(".")
+
+print(repo.git_dir)                  # .../my-project/.git
+print(repo.workdir)                  # .../my-project  (None if bare)
+print(repo.is_bare)                  # False
+print(repo.head_name)                # 'main'  (None if detached)
+
+# The commit at HEAD
+head = repo.head_commit()
+print(head.short_id, head.summary)
+print(head.author.name, head.author.email, head.author.time)
+
+# Walk history (reverse-chronological), like `git log`
+for commit in repo.commits(max_count=10):
+    print(commit.short_id, commit.author.name, commit.summary)
+
+# Resolve a revspec to an object id
+print(repo.rev_parse("HEAD~2"))
+print(repo.rev_parse("main"))
+
+# Branches, tags, and all references
+print(repo.branches())               # ['main', 'dev', ...]
+print(repo.tags())                   # ['v1.0.0', ...]
+for ref in repo.references():
+    print(ref.name, "->", ref.target)
+
+# Read a file's content at a revision
+readme = repo.read_blob("HEAD:README.md")
+print(readme.decode())
+```
+
+## Migrating from GitPython
+
+Common operations, side by side:
+
+| GitPython | gitoxide-python |
+|---|---|
+| `from git import Repo` | `import gitoxide` |
+| `repo = Repo(path)` | `repo = gitoxide.open(path)` |
+| `Repo(path, search_parent_directories=True)` | `gitoxide.discover(path)` |
+| `repo.head.commit` | `repo.head_commit()` |
+| `repo.active_branch.name` | `repo.head_name` |
+| `repo.iter_commits("main", max_count=10)` | `repo.commits("main", max_count=10)` |
+| `repo.commit("HEAD~2")` | `repo.commit("HEAD~2")` |
+| `repo.rev_parse("main").hexsha` | `repo.rev_parse("main")` |
+| `[b.name for b in repo.branches]` | `repo.branches()` |
+| `[t.name for t in repo.tags]` | `repo.tags()` |
+| `c.hexsha`, `c.summary`, `c.author.name` | `c.id`, `c.summary`, `c.author.name` |
+
+The key difference is what happens underneath: GitPython's `iter_commits` spawns
+a `git rev-list` subprocess; gitoxide-python walks the object database
+in-process in Rust.
+
+## API
+
+### Module functions
+
+- `gitoxide.open(path) -> Repository`
+- `gitoxide.discover(path) -> Repository` — search `path` and its parents
+- `gitoxide.init(path, bare=False) -> Repository`
+- `gitoxide.gix_version() -> str`
+
+### `Repository`
+
+Properties: `git_dir`, `workdir`, `is_bare`, `is_shallow`, `head_id`,
+`head_name`, `head_is_detached`.
+
+> **Note:** `head_name` and `head_is_detached` access the `HEAD` reference
+> and may raise `GitoxideError` if it is inaccessible (e.g., corrupted
+> repository). Other properties never raise.
+
+Methods: `head_commit()`, `rev_parse(spec)`, `commit(rev)`,
+`commits(rev=None, max_count=None)`, `references()`, `branches()`, `tags()`,
+`read_blob(rev)`.
+
+### `Commit`
+
+`id`, `short_id`, `tree_id`, `message`, `summary`, `author`, `committer`,
+`parents`.
+
+### `Signature`
+
+`name`, `email`, `time` (Unix seconds), `offset` (UTC offset seconds).
+
+### `Reference`
+
+`name`, `shorthand`, `target`.
+
+All errors (from any function or method) are raised as
+`gitoxide.GitoxideError`.
+
+## Roadmap
+
+- Diffing and status
+- Tree traversal / listing entries
+- Writing commits, staging (index), tag/branch creation
+- Blame
+- Cloning and remote operations (fetch/push)
+- Lazy commit iterators instead of eager lists for very large histories
+
+Contributions welcome — the binding layer lives in a single [`src/lib.rs`](src/lib.rs)
+and maps cleanly onto the `gix` API.
+
+## Development
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install maturin pytest
+
+maturin develop          # build the extension into the venv
+pytest -q                # run the test suite
+
+cargo fmt --all          # format Rust
+cargo clippy --all-targets -- -D warnings
+```
+
+The tests generate a throwaway git repository on the fly (see
+[`tests/conftest.py`](tests/conftest.py)), so they need `git` on `PATH` but
+touch nothing outside a temp directory.
+
+## License
+
+Licensed under either of Apache License 2.0 or MIT license at your option, to
+match the upstream gitoxide project.
+

gitoxide-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+gitoxide/__init__.py,sha256=pLUc5wDLV7O_DoPvqTtf82UJvxglHkDrP6R4haHCtk4,1229
+gitoxide/_gitoxide.pyd,sha256=M7y2pyqEYPjnrCLqz5ydzKg0FWeFEbO2u-7gvTmQADw,3540480
+gitoxide/_gitoxide.pyi,sha256=cGfk0YvdnJU6twiGZAlSC7EWMywb14SCrAKtizLEaiE,2117
+gitoxide/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gitoxide-0.1.0.dist-info/METADATA,sha256=ZyETjeglrS_PUhM_ml0nZTY_3xJegOw6xl0CMKcsSFw,7308
+gitoxide-0.1.0.dist-info/WHEEL,sha256=_rgZdQc9sLFEqt2IemX7qyxsGt5fFRnBDATxGzerdmg,95
+gitoxide-0.1.0.dist-info/licenses/LICENSE-APACHE,sha256=Pd-b5cKP4n2tFDpdx27qJSIq0d1ok0oEcGTlbtL6QMU,11560
+gitoxide-0.1.0.dist-info/licenses/LICENSE-MIT,sha256=x2Vs-GAj2EXAfmCUt9zlEtuHdNzEBfN3oEjaWLR7Vqg,1090
+gitoxide-0.1.0.dist-info/sboms/gitoxide-python.cyclonedx.json,sha256=8N5auZ5UbOdwHdSZvNEkJ6iuKDVzo_xolc5CmftpkDI,164459
+gitoxide-0.1.0.dist-info/RECORD,,

gitoxide-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.14.1)
+Root-Is-Purelib: false
+Tag: cp39-abi3-win_amd64

gitoxide-0.1.0.dist-info/licenses/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

gitoxide-0.1.0.dist-info/licenses/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 shenxianpeng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.