gitpure 0.1.0__tar.gz → 0.1.2__tar.gz

{gitpure-0.1.0 → gitpure-0.1.2}/.github/workflows/CI.yml

@@ -19,6 +19,25 @@ permissions:
   contents: read
 
 jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+      - name: Set up Python
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6
+        with:
+          python-version: '3.13'
+      - name: Set up Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+      - name: Install build tooling
+        run: |
+          python -m pip install --upgrade pip
+          pip install maturin
+      - name: Install project with test extras
+        run: pip install .[test]
+      - name: Run pytest
+        run: pytest -s
+
   linux:
     runs-on: ${{ matrix.platform.runner }}
     strategy:
@@ -37,12 +56,12 @@ jobs:
           - runner: ubuntu-22.04
             target: ppc64le
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+      - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6
         with:
           python-version: 3.x
       - name: Build wheels
-        uses: PyO3/maturin-action@v1
+        uses: PyO3/maturin-action@86b9d133d34bc1b40018696f782949dac11bd380 # v1
         with:
           target: ${{ matrix.platform.target }}
           args: --release --out dist --find-interpreter
@@ -50,7 +69,7 @@ jobs:
           # ring requires a newer version of manylinux on aarch64
           manylinux: ${{ matrix.platform.target == 'aarch64' && '2_28' || 'auto' }}
       - name: Upload wheels
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
         with:
           name: wheels-linux-${{ matrix.platform.target }}
           path: dist
@@ -69,19 +88,19 @@ jobs:
           - runner: ubuntu-22.04
             target: armv7
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+      - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6
         with:
           python-version: 3.x
       - name: Build wheels
-        uses: PyO3/maturin-action@v1
+        uses: PyO3/maturin-action@86b9d133d34bc1b40018696f782949dac11bd380 # v1
         with:
           target: ${{ matrix.platform.target }}
           args: --release --out dist --find-interpreter
           sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
           manylinux: musllinux_1_2
       - name: Upload wheels
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
         with:
           name: wheels-musllinux-${{ matrix.platform.target }}
           path: dist
@@ -96,19 +115,19 @@ jobs:
           - runner: windows-latest
             target: x86
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+      - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6
         with:
           python-version: 3.x
           architecture: ${{ matrix.platform.target }}
       - name: Build wheels
-        uses: PyO3/maturin-action@v1
+        uses: PyO3/maturin-action@86b9d133d34bc1b40018696f782949dac11bd380 # v1
         with:
           target: ${{ matrix.platform.target }}
           args: --release --out dist --find-interpreter
           sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
       - name: Upload wheels
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
         with:
           name: wheels-windows-${{ matrix.platform.target }}
           path: dist
@@ -123,33 +142,42 @@ jobs:
           - runner: macos-14
             target: aarch64
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+      - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6
         with:
           python-version: 3.x
       - name: Build wheels
-        uses: PyO3/maturin-action@v1
+        uses: PyO3/maturin-action@86b9d133d34bc1b40018696f782949dac11bd380 # v1
         with:
           target: ${{ matrix.platform.target }}
           args: --release --out dist --find-interpreter
           sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
       - name: Upload wheels
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
         with:
           name: wheels-macos-${{ matrix.platform.target }}
           path: dist
 
+  success:
+    name: Success
+    runs-on: ubuntu-latest
+    needs: [tests, linux, musllinux, windows, macos, sdist]
+    if: ${{ !cancelled() && !failure() }}
+    steps:
+      - name: Mark success
+        run: echo "All required jobs completed successfully."
+
   sdist:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
       - name: Build sdist
-        uses: PyO3/maturin-action@v1
+        uses: PyO3/maturin-action@86b9d133d34bc1b40018696f782949dac11bd380 # v1
         with:
           command: sdist
           args: --out dist
       - name: Upload sdist
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
         with:
           name: wheels-sdist
           path: dist
@@ -158,7 +186,7 @@ jobs:
     name: Release
     runs-on: ubuntu-latest
     if: ${{ startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch' }}
-    needs: [linux, musllinux, windows, macos, sdist]
+    needs: [tests, linux, musllinux, windows, macos, sdist]
     permissions:
       # Use to sign the release artifacts
       id-token: write
@@ -170,14 +198,14 @@ jobs:
       name: pypi
       url: https://pypi.org/p/gitpure      
     steps:
-      - uses: actions/download-artifact@v4
+      - uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5
       - name: Generate artifact attestation
-        uses: actions/attest-build-provenance@v2
+        uses: actions/attest-build-provenance@977bb373ede98d70efdf65b84cb5f73e068dcc2a # v3
         with:
           subject-path: 'wheels-*/*'
       - name: Publish to PyPI
         if: ${{ startsWith(github.ref, 'refs/tags/') }}
-        uses: PyO3/maturin-action@v1
+        uses: PyO3/maturin-action@86b9d133d34bc1b40018696f782949dac11bd380 # v1
         with:
           command: upload
           args: --non-interactive --skip-existing wheels-*/*

{gitpure-0.1.0 → gitpure-0.1.2}/Cargo.lock

@@ -406,7 +406,7 @@ checksum = "e629b9b98ef3dd8afe6ca2bd0f89306cec16d43d907889945bc5d6687f2f13c7"
 
 [[package]]
 name = "gitpure"
-version = "0.1.0"
+version = "0.1.2"
 dependencies = [
  "gix",
  "pyo3",
@@ -1814,9 +1814,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3"
-version = "0.25.1"
+version = "0.26.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8970a78afe0628a3e3430376fc5fd76b6b45c4d43360ffd6cdd40bdde72b682a"
+checksum = "7ba0117f4212101ee6544044dae45abe1083d30ce7b29c4b5cbdfa2354e07383"
 dependencies = [
  "indoc",
  "libc",
@@ -1831,19 +1831,18 @@ dependencies = [
 
 [[package]]
 name = "pyo3-build-config"
-version = "0.25.1"
+version = "0.26.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "458eb0c55e7ece017adeba38f2248ff3ac615e53660d7c71a238d7d2a01c7598"
+checksum = "4fc6ddaf24947d12a9aa31ac65431fb1b851b8f4365426e182901eabfb87df5f"
 dependencies = [
- "once_cell",
  "target-lexicon",
 ]
 
 [[package]]
 name = "pyo3-ffi"
-version = "0.25.1"
+version = "0.26.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7114fe5457c61b276ab77c5055f206295b812608083644a5c5b2640c3102565c"
+checksum = "025474d3928738efb38ac36d4744a74a400c901c7596199e20e45d98eb194105"
 dependencies = [
  "libc",
  "pyo3-build-config",
@@ -1851,9 +1850,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-macros"
-version = "0.25.1"
+version = "0.26.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a8725c0a622b374d6cb051d11a0983786448f7785336139c3c94f5aa6bef7e50"
+checksum = "2e64eb489f22fe1c95911b77c44cc41e7c19f3082fc81cce90f657cdc42ffded"
 dependencies = [
  "proc-macro2",
  "pyo3-macros-backend",
@@ -1863,9 +1862,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-macros-backend"
-version = "0.25.1"
+version = "0.26.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4109984c22491085343c05b0dbc54ddc405c3cf7b4374fc533f5c3313a572ccc"
+checksum = "100246c0ecf400b475341b8455a9213344569af29a3c841d29270e53102e0fcf"
 dependencies = [
  "heck",
  "proc-macro2",

gitpure-0.1.2/Cargo.toml

@@ -0,0 +1,29 @@
+[package]
+name = "gitpure"
+version = "0.1.2"
+edition = "2024"
+authors = ["Max Dymond <cmeister2@gmail.com>"]
+license = "MIT"
+description = "A Python git library implemented in Rust using gitoxide"
+readme = "README.md"
+homepage = "https://github.com/cmeister2/gitpure"
+repository = "https://github.com/cmeister2/gitpure"
+documentation = "https://github.com/cmeister2/gitpure"
+keywords = ["git", "python", "rust", "gitoxide", "version-control"]
+categories = ["development-tools", "api-bindings"]
+
+[lib]
+name = "gitpure"
+crate-type = ["cdylib"]
+
+[dependencies]
+pyo3 = "0.26.0"
+
+[dependencies.gix]
+version = "0.73.0"
+default-features = false
+features = [
+    "blocking-http-transport-reqwest-rust-tls",
+    "parallel",
+    "worktree-mutation"
+]

gitpure-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Max Dymond
+
+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.

gitpure-0.1.2/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: gitpure
+Version: 0.1.2
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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 :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Version Control
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Typing :: Typed
+Requires-Dist: pytest ; extra == 'test'
+Requires-Dist: gitpython>=3.1 ; extra == 'test'
+Provides-Extra: test
+License-File: LICENSE
+Summary: A Python git library implemented in Rust using gitoxide
+Keywords: git,python,rust,gitoxide,version-control
+Home-Page: https://github.com/cmeister2/gitpure
+Author-email: Max Dymond <cmeister2@gmail.com>
+Maintainer-email: Max Dymond <cmeister2@gmail.com>
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/cmeister2/gitpure
+Project-URL: Documentation, https://github.com/cmeister2/gitpure
+Project-URL: Repository, https://github.com/cmeister2/gitpure
+Project-URL: Bug Reports, https://github.com/cmeister2/gitpure/issues
+Project-URL: Source Code, https://github.com/cmeister2/gitpure
+
+# gitpure
+
+[![CI](https://github.com/cmeister2/gitpure/actions/workflows/CI.yml/badge.svg)](https://github.com/cmeister2/gitpure/actions/workflows/CI.yml)
+[![PyPI version](https://badge.fury.io/py/gitpure.svg)](https://badge.fury.io/py/gitpure)
+[![Python versions](https://img.shields.io/pypi/pyversions/gitpure.svg)](https://pypi.org/project/gitpure/)
+
+A pure git Python library implemented in Rust using [gitoxide](https://github.com/Byron/gitoxide). This library provides fast and memory-efficient git operations through Python bindings.
+
+## Features
+
+- **Fast**: Built with Rust and gitoxide for optimal performance
+- **Memory efficient**: Leverages Rust's memory management
+- **Cross-platform**: Works on Linux, macOS, and Windows
+- **Pure Python interface**: Easy to use Python API
+- **Safe**: Thread-safe operations with Rust's ownership model
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install gitpure
+```
+
+## Quick Start
+
+```python
+import gitpure
+
+# Clone a repository (with worktree)
+repo = gitpure.Repo.clone_from("https://github.com/user/repo.git", "/path/to/local/repo")
+
+# Clone a bare repository
+bare_repo = gitpure.Repo.clone_from("https://github.com/user/repo.git", "/path/to/bare/repo", bare=True)
+
+# Get the git directory path
+git_dir = repo.git_dir
+print(f"Git directory: {git_dir}")
+```
+
+## Development
+
+### Prerequisites
+
+- Python 3.8+
+- Rust 1.70+
+- maturin
+
+### Building from Source
+
+```bash
+# Clone the repository
+git clone https://github.com/cmeister2/gitpure.git
+cd gitpure
+
+# Create a virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install maturin
+pip install maturin
+
+# Build and install in development mode
+maturin develop
+
+# Or build wheel
+maturin build --release
+```
+
+### Running Tests
+
+```bash
+# Install test dependencies
+pip install pytest
+
+# Run tests
+pytest tests/
+```
+
+## Architecture
+
+gitpure is built on top of:
+
+- **[gitoxide](https://github.com/Byron/gitoxide)**: A pure Rust implementation of git
+- **[PyO3](https://github.com/PyO3/pyo3)**: Python bindings for Rust
+- **[maturin](https://github.com/PyO3/maturin)**: Build tool for Python extensions written in Rust
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+### Development Setup
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Make your changes
+4. Add tests for your changes
+5. Ensure all tests pass (`pytest`)
+6. Commit your changes (`git commit -m 'Add some amazing feature'`)
+7. Push to the branch (`git push origin feature/amazing-feature`)
+8. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+

gitpure-0.1.2/README.md

@@ -0,0 +1,105 @@
+# gitpure
+
+[![CI](https://github.com/cmeister2/gitpure/actions/workflows/CI.yml/badge.svg)](https://github.com/cmeister2/gitpure/actions/workflows/CI.yml)
+[![PyPI version](https://badge.fury.io/py/gitpure.svg)](https://badge.fury.io/py/gitpure)
+[![Python versions](https://img.shields.io/pypi/pyversions/gitpure.svg)](https://pypi.org/project/gitpure/)
+
+A pure git Python library implemented in Rust using [gitoxide](https://github.com/Byron/gitoxide). This library provides fast and memory-efficient git operations through Python bindings.
+
+## Features
+
+- **Fast**: Built with Rust and gitoxide for optimal performance
+- **Memory efficient**: Leverages Rust's memory management
+- **Cross-platform**: Works on Linux, macOS, and Windows
+- **Pure Python interface**: Easy to use Python API
+- **Safe**: Thread-safe operations with Rust's ownership model
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install gitpure
+```
+
+## Quick Start
+
+```python
+import gitpure
+
+# Clone a repository (with worktree)
+repo = gitpure.Repo.clone_from("https://github.com/user/repo.git", "/path/to/local/repo")
+
+# Clone a bare repository
+bare_repo = gitpure.Repo.clone_from("https://github.com/user/repo.git", "/path/to/bare/repo", bare=True)
+
+# Get the git directory path
+git_dir = repo.git_dir
+print(f"Git directory: {git_dir}")
+```
+
+## Development
+
+### Prerequisites
+
+- Python 3.8+
+- Rust 1.70+
+- maturin
+
+### Building from Source
+
+```bash
+# Clone the repository
+git clone https://github.com/cmeister2/gitpure.git
+cd gitpure
+
+# Create a virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install maturin
+pip install maturin
+
+# Build and install in development mode
+maturin develop
+
+# Or build wheel
+maturin build --release
+```
+
+### Running Tests
+
+```bash
+# Install test dependencies
+pip install pytest
+
+# Run tests
+pytest tests/
+```
+
+## Architecture
+
+gitpure is built on top of:
+
+- **[gitoxide](https://github.com/Byron/gitoxide)**: A pure Rust implementation of git
+- **[PyO3](https://github.com/PyO3/pyo3)**: Python bindings for Rust
+- **[maturin](https://github.com/PyO3/maturin)**: Build tool for Python extensions written in Rust
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+### Development Setup
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Make your changes
+4. Add tests for your changes
+5. Ensure all tests pass (`pytest`)
+6. Commit your changes (`git commit -m 'Add some amazing feature'`)
+7. Push to the branch (`git push origin feature/amazing-feature`)
+8. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

gitpure-0.1.2/gitpure.pyi

@@ -0,0 +1,108 @@
+"""
+Type stubs for gitpure - A pure git Python module implemented in Rust.
+"""
+
+from pathlib import Path
+from typing import Type
+
+
+class Commit:
+    """Lightweight representation of a git commit."""
+
+    @property
+    def hexsha(self) -> str:
+        """Hexadecimal object id of the commit."""
+        ...
+
+
+class Head:
+    """A named reference to a commit, mirroring GitPython's Head."""
+
+    @property
+    def name(self) -> str:
+        """The short name of the head (branch)."""
+        ...
+
+    @property
+    def commit(self) -> Commit | None:
+        """The commit the head points to, if available."""
+        ...
+
+
+class Tag:
+    """A tag reference with optional peeled commit."""
+
+    @property
+    def name(self) -> str:
+        """The short name of the tag."""
+        ...
+
+    @property
+    def commit(self) -> Commit | None:
+        """The commit the tag ultimately refers to, if available."""
+        ...
+
+class Repo:
+    """A git repository wrapper using gix (gitoxide)."""
+    
+    @property
+    def git_dir(self) -> Path:
+        """
+        Path to the .git directory of the repository.
+        
+        Returns:
+            The absolute path to the .git directory as a pathlib.Path object
+        """
+        ...
+
+    def branches(self) -> list[str]:
+        """Return the names of all local branches in the repository."""
+        ...
+
+    @property
+    def working_tree_dir(self) -> Path | None:
+        """Return the working tree directory of the repository, if it exists."""
+        ...
+
+    @property
+    def is_bare(self) -> bool:
+        """Whether the repository is bare (has no working tree)."""
+        ...
+
+    @property
+    def active_branch(self) -> Head | None:
+        """Current active branch as a Head object, if available."""
+        ...
+
+    @property
+    def head(self) -> Head | None:
+        """HEAD reference as a Head object, if available."""
+        ...
+
+    @property
+    def heads(self) -> list[Head]:
+        """Return all local heads (branches) in the repository."""
+        ...
+
+    @property
+    def tags(self) -> list[Tag]:
+        """Return all tags in the repository."""
+        ...
+    
+    @classmethod
+    def clone_from(cls: Type["Repo"], url: str, to_path: str, bare: bool = False) -> "Repo":
+        """
+        Clone a repository from a URL to a local path.
+        
+        Args:
+            url: The URL of the repository to clone
+            to_path: The local path where the repository should be cloned
+            bare: Whether to create a bare repository (default: False)
+            
+        Returns:
+            A new Repo instance representing the cloned repository
+            
+        Raises:
+            RuntimeError: If the clone operation fails
+        """
+        ...