gitoxide-py 0.87.0__tar.gz → 0.87.1__tar.gz

gitoxide_py-0.87.1/.github/github-automations.yml

@@ -0,0 +1,7 @@
+version: 1
+
+automerge:
+  label: automerge
+  base_branches: [main]
+  merge_method: squash
+  delete_branch: true

{gitoxide_py-0.87.0 → gitoxide_py-0.87.1}/.github/workflows/ci.yml

@@ -77,6 +77,34 @@ jobs:
       - name: pytest
         run: uv run --no-sync pytest -v
 
+      # The checked-in stub snapshot lets Griffe compare the Python API across
+      # refs without rebuilding the base revision. Keep only structural
+      # findings: default-expression changes are intentionally noisy here.
+      - name: Check Python API surface
+        if: github.event_name == 'pull_request'
+        run: |
+          base_sha="${{ github.event.pull_request.base.sha }}"
+          if ! git cat-file -e "$base_sha:stubs/gitoxide_py/__init__.pyi"; then
+            echo "Griffe API check skipped: the base ref predates the tracked stub."
+            exit 0
+          fi
+
+          set -o pipefail
+          if ! output="$(uv tool run --from griffe griffe check gitoxide_py \
+            --search stubs \
+            --find-stubs-packages \
+            --against "$base_sha" \
+            --base-ref "${{ github.event.pull_request.head.sha }}" \
+            --format github 2>&1)"; then
+            echo "::warning::Griffe API check could not load the API snapshot"
+            echo "$output"
+            exit 0
+          fi
+          echo "$output" | grep -E \
+            'Public object was removed|Parameter was removed|Parameter was added as required|Positional parameter was moved|Public object points to a different kind of object' \
+            || true
+
+
       # `cargo llvm-cov show-env` prints the RUSTC_WRAPPER/LLVM_PROFILE_FILE/etc
       # that make a `cargo build` instrumented and its profile data land where
       # `cargo llvm-cov report` expects it. The Rust code here is only ever

{gitoxide_py-0.87.0 → gitoxide_py-0.87.1}/.github/workflows/release.yml

@@ -1,8 +1,8 @@
 name: Release
 
 # Distributions are built for every push to main so a broken build surfaces
-# then, not at tag time. Publishing happens only for a tag, which is also
-# where the version comes from.
+# then, not at tag time. Publishing to PyPI happens only for a tag, which is
+# also where the version comes from; main builds go to the tailnet dev index.
 on:
   push:
     branches: [main]
@@ -253,11 +253,39 @@ jobs:
       - name: Upload
         run: uv run --no-project python scripts/publish.py https://pypi.org /dist
 
+  # Every main build's wheels go to the tailnet devpi's volatile dev index, so
+  # consumers can pin an unreleased main before a tag. The index prunes old
+  # builds; pin a PyPI release before merging. Same index and account as the
+  # Ninot dev wheels.
+  publish-dev:
+    name: Publish to the tailnet dev index
+    needs: [build, windows-check]
+    if: github.ref == 'refs/heads/main'
+    runs-on: [self-hosted, feguitv]
+    timeout-minutes: 20
+    container:
+      image: localhost:5000/python-ci:latest
+      volumes:
+        - /var/tmp/gitoxide-py-release/${{ github.run_id }}:/dist
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Upload
+        env:
+          DEVPI_UPLOAD_PASSWORD: ${{ secrets.DEVPI_UPLOAD_PASSWORD }}
+          INDEX: https://pypi.tailee1e3e.ts.net/infra/ninot-dev
+        run: |
+          test -n "${DEVPI_UPLOAD_PASSWORD:?DEVPI_UPLOAD_PASSWORD is required}"
+          # --check-url skips files the index already has, so a rerun passes.
+          uv publish --check-url "$INDEX/+simple/" --publish-url "$INDEX/" \
+            --username infra --password "$DEVPI_UPLOAD_PASSWORD" /dist/*.whl
+
   # The shared directory lives on the runner, outside any workspace, so
   # nothing else reclaims it.
   cleanup:
     name: Clean up
-    needs: [build, windows-check, publish, publish-testpypi]
+    needs: [build, windows-check, publish, publish-testpypi, publish-dev]
     if: always()
     runs-on: [self-hosted, feguitv]
     timeout-minutes: 10

gitoxide_py-0.87.1/.gitmodules

@@ -0,0 +1,4 @@
+[submodule "tools/rulesets"]
+	path = tools/rulesets
+	url = git@github.com:feliupol/rulesets.git
+	branch = main

{gitoxide_py-0.87.0 → gitoxide_py-0.87.1}/Cargo.lock

@@ -291,7 +291,7 @@ dependencies = [
 
 [[package]]
 name = "gitoxide-py"
-version = "0.87.0"
+version = "0.87.1"
 dependencies = [
  "gix",
  "pyo3",
@@ -305,6 +305,7 @@ checksum = "fdefc1465d8631807deaf504dacdeff628b978de515653b47976ca7c28ab2a7a"
 dependencies = [
  "gix-actor",
  "gix-attributes",
+ "gix-blame",
  "gix-command",
  "gix-commitgraph",
  "gix-config",
@@ -389,6 +390,26 @@ dependencies = [
  "gix-error",
 ]
 
+[[package]]
+name = "gix-blame"
+version = "0.17.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "54fe27f8037c58cb4b6d60fe0aacf7ee2c998633cedf4e989351c07d9a3a575d"
+dependencies = [
+ "gix-commitgraph",
+ "gix-date",
+ "gix-diff",
+ "gix-error",
+ "gix-hash",
+ "gix-object",
+ "gix-revwalk",
+ "gix-trace",
+ "gix-traverse",
+ "gix-worktree",
+ "smallvec",
+ "thiserror",
+]
+
 [[package]]
 name = "gix-chunk"
 version = "0.8.0"

{gitoxide_py-0.87.0 → gitoxide_py-0.87.1}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "gitoxide-py"
-version = "0.87.0"
+version = "0.87.1"
 edition = "2021"
 description = "Typed Python bindings to the gix (gitoxide) engine that release the GIL for every call"
 license = "MIT"
@@ -17,7 +17,7 @@ crate-type = ["cdylib"]
 # rev-parse / commit traversal; `sha1` is the portable (non-C) SHA1 backend.
 # `status` is the umbrella feature for the working-tree-aware half of gix: it
 # pulls in `index`, `blob-diff`, `dirwalk`, `excludes` and `attributes`, all of
-# which are pure Rust too.
+# which are pure Rust too. `blame` adds `gix-blame` for `Repository.blame_file`.
 # None of this makes `gix::Repository` itself `Sync` — see the `Repository`
 # pyclass doc comment in src/lib.rs for why it's backed by
 # `gix::ThreadSafeRepository` instead.
@@ -26,6 +26,7 @@ gix = { version = "0.87", default-features = false, features = [
     "revision",
     "sha1",
     "status",
+    "blame",
 ] }
 
 [dependencies.pyo3]

gitoxide_py-0.87.1/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: gitoxide-py
+Version: 0.87.1
+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
+Classifier: Typing :: Typed
+License-File: LICENSE
+Summary: Typed Python bindings to the gix (gitoxide) engine that release the GIL for every call
+Keywords: git,gitoxide,gix,vcs,version-control,pyo3
+Author: Pol Feliu
+License-Expression: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/feliupol/gitoxide-py
+Project-URL: Repository, https://github.com/feliupol/gitoxide-py
+Project-URL: gix (Rust crate), https://github.com/GitoxideLabs/gitoxide
+
+# gitoxide-py
+
+<p align="center">
+  <strong>Fast, typed Python access to local Git repositories.</strong>
+</p>
+
+<p align="center">
+  <a href="https://github.com/feliupol/gitoxide-py/actions/workflows/ci.yml">
+    <img src="https://github.com/feliupol/gitoxide-py/actions/workflows/ci.yml/badge.svg?branch=main" alt="Build status">
+  </a>
+  <a href="https://www.python.org/">
+    <img src="https://img.shields.io/badge/python-3.9%2B-3776AB?logo=python&amp;logoColor=white" alt="Python 3.9 or later">
+  </a>
+</p>
+
+Explore repositories, inspect history and working-tree state, and manage refs
+from Python without blocking other threads.
+
+## Quick start
+
+Build from a checkout of this repository:
+
+```bash
+uv sync
+uv run maturin develop --release --generate-stubs
+```
+
+```python
+import gitoxide_py as gix
+
+repo = gix.discover(".")
+
+print(repo.git_dir)
+print(repo.head_name)
+print(repo.head_commit().summary)
+
+for commit in repo.commits(max_count=10):
+    print(commit.short_id, commit.author.name, commit.summary)
+
+print(repo.branches())
+print(repo.tags())
+print(repo.read_blob("HEAD:README.md").decode())
+```
+
+The generated API snapshot used by the Griffe CI check lives in
+`stubs/gitoxide_py/__init__.pyi`. Regenerate it after changing the PyO3 API by
+building a wheel with `uv run maturin build --generate-stubs`, then replace the
+tracked stub with the wheel's `gitoxide_py/__init__.pyi`.
+
+## What it covers
+
+- **Repository and history:** HEAD and branch state, revisions, commit walks,
+  merge bases, ahead/behind counts, ancestry, references, branches, tags, and
+  reflogs.
+- **Content inspection:** object kinds, tree entries, blob reads,
+  tree-to-tree diffs with line hunks, and blame.
+- **Working repository state:** remotes, linked worktrees, submodules, local
+  configuration, index entries and conflicts, and working-tree status.
+- **Focused changes:** create or delete branches and tags, and update local
+  configuration. These operations do not modify the working tree.
+- **Python-friendly:** every Git operation releases the GIL, and generated
+  type information is available to mypy and pyright.
+
+Network operations (`clone`, `fetch`, and `push`) and changes to commits,
+index entries, or working-tree files are not part of the API.
+
+## Development
+
+```bash
+uv run pytest -v
+uv run maturin build --generate-stubs
+```
+

gitoxide_py-0.87.1/README.md

@@ -0,0 +1,72 @@
+# gitoxide-py
+
+<p align="center">
+  <strong>Fast, typed Python access to local Git repositories.</strong>
+</p>
+
+<p align="center">
+  <a href="https://github.com/feliupol/gitoxide-py/actions/workflows/ci.yml">
+    <img src="https://github.com/feliupol/gitoxide-py/actions/workflows/ci.yml/badge.svg?branch=main" alt="Build status">
+  </a>
+  <a href="https://www.python.org/">
+    <img src="https://img.shields.io/badge/python-3.9%2B-3776AB?logo=python&amp;logoColor=white" alt="Python 3.9 or later">
+  </a>
+</p>
+
+Explore repositories, inspect history and working-tree state, and manage refs
+from Python without blocking other threads.
+
+## Quick start
+
+Build from a checkout of this repository:
+
+```bash
+uv sync
+uv run maturin develop --release --generate-stubs
+```
+
+```python
+import gitoxide_py as gix
+
+repo = gix.discover(".")
+
+print(repo.git_dir)
+print(repo.head_name)
+print(repo.head_commit().summary)
+
+for commit in repo.commits(max_count=10):
+    print(commit.short_id, commit.author.name, commit.summary)
+
+print(repo.branches())
+print(repo.tags())
+print(repo.read_blob("HEAD:README.md").decode())
+```
+
+The generated API snapshot used by the Griffe CI check lives in
+`stubs/gitoxide_py/__init__.pyi`. Regenerate it after changing the PyO3 API by
+building a wheel with `uv run maturin build --generate-stubs`, then replace the
+tracked stub with the wheel's `gitoxide_py/__init__.pyi`.
+
+## What it covers
+
+- **Repository and history:** HEAD and branch state, revisions, commit walks,
+  merge bases, ahead/behind counts, ancestry, references, branches, tags, and
+  reflogs.
+- **Content inspection:** object kinds, tree entries, blob reads,
+  tree-to-tree diffs with line hunks, and blame.
+- **Working repository state:** remotes, linked worktrees, submodules, local
+  configuration, index entries and conflicts, and working-tree status.
+- **Focused changes:** create or delete branches and tags, and update local
+  configuration. These operations do not modify the working tree.
+- **Python-friendly:** every Git operation releases the GIL, and generated
+  type information is available to mypy and pyright.
+
+Network operations (`clone`, `fetch`, and `push`) and changes to commits,
+index entries, or working-tree files are not part of the API.
+
+## Development
+
+```bash
+uv run pytest -v
+uv run maturin build --generate-stubs
+```

{gitoxide_py-0.87.0 → gitoxide_py-0.87.1}/RELEASING.md

@@ -2,6 +2,13 @@
 
 Wheels build on every push to `main`; a tag is what publishes them.
 
+Each `main` build also uploads its wheels (`0.87.0.post4+ef3c505`-style
+versions) to the tailnet devpi's volatile dev index,
+`https://pypi.tailee1e3e.ts.net/infra/ninot-dev/+simple/`, for consumers that
+need an unreleased change. That index prunes old builds, so pin a PyPI release
+before merging. The upload needs the `DEVPI_UPLOAD_PASSWORD` Actions secret
+(the devpi `infra` password).
+
 ## One-time setup
 
 PyPI publishes through [Trusted Publishing](https://docs.pypi.org/trusted-publishers/),

{gitoxide_py-0.87.0 → gitoxide_py-0.87.1}/pyproject.toml

@@ -38,3 +38,25 @@ dev = ["maturin>=1.7,<2.0", "pytest>=7.0"]
 
 [tool.maturin]
 features = ["pyo3/extension-module"]
+
+[tool.ruff]
+extend = "tools/rulesets/ruff/ruff.toml"
+extend-exclude = ["tools/rulesets"]
+# The shared base sets no target-version; the package supports Python 3.9.
+target-version = "py39"
+
+[tool.ruff.lint]
+ignore = [
+    # TODO(rulesets): add `match=` to the 12 broad `pytest.raises(ValueError)` calls.
+    "pytest-raises-too-broad",
+    # TODO(rulesets): add `from __future__ import annotations` to tests/conftest.py.
+    "future-required-type-annotation",
+    # TODO(rulesets): pass `check=` to subprocess.run in tests/conftest.py.
+    "subprocess-run-without-check",
+    # TODO(rulesets): use or drop the unused fixture argument in tests/test_repository.py.
+    "unused-function-argument",
+]
+
+[tool.ruff.lint.per-file-ignores]
+# The binding mirrors the builtin name with a module-level `open`.
+"stubs/gitoxide_py/__init__.pyi" = ["builtin-variable-shadowing"]

{gitoxide_py-0.87.0 → gitoxide_py-0.87.1}/scripts/publish.py

@@ -24,7 +24,6 @@ import urllib.error
 import urllib.request
 from pathlib import Path
 
-
 # PyPI serves uploads from a different host than its web and OIDC endpoints;
 # TestPyPI serves both from one. Deriving the upload URL from the index base is
 # therefore correct for TestPyPI and wrong for PyPI, which is exactly the kind

{gitoxide_py-0.87.0 → gitoxide_py-0.87.1}/src/lib.rs

@@ -1,5 +1,6 @@
 use pyo3::prelude::*;
 
+mod lines;
 mod repository;
 mod types;
 mod util;
@@ -38,8 +39,9 @@ mod gitoxide_py {
 
     #[pymodule_export]
     use crate::types::{
-        Branch, Commit, FileChange, IndexConflict, IndexEntry, Reference, ReflogEntry, Remote,
-        Signature, StatusEntry, Submodule, SubmoduleStatus, TreeEntry, Worktree,
+        BlameHunk, Branch, Commit, FileChange, FileDiff, IndexConflict, IndexEntry, LineHunk,
+        Reference, ReflogEntry, Remote, Signature, StatusEntry, Submodule, SubmoduleStatus,
+        TreeEntry, Worktree,
     };
 
     use pyo3::prelude::*;