Skip to content

Commit b04326d

Browse files
codexByron
authored andcommitted
docs(gix): document release setup and native conversion gaps
Add installation, validation and coverage guidance for the official `GixPython==0.1.0` release, using existing Python interpreters and separate CLI/native environments. Record GixPython/Gitoxide follow-ups with evidence, reproduction details and the API or behavior needed upstream. Document the Gix-only boundary: adapters may format native results and select fallback, but cannot independently implement missing Git semantics. Keep reference-format queries on Git (`GIX-1`), reflog cleanup on Git (`GIX-10`), and command-specific committer resolution on Git (`GIX-21`). Native counters must not label Python substitutes as Gix operations. Preserve the earlier published-wheel and local-artifact validation records, including the historical 757.85-second full suite and the future state/fixture optimization analysis, with their original revisions and scope. These are historical observations rather than validation of later rewritten trees. Validation for this documentation correction: checked the capability table against the amended adapters and passed `git diff --check`. The corresponding code changes already passed their focused Gix tests followed by CLI tests. This documentation change reduces CLI calls by zero.
1 parent d993213 commit b04326d

3 files changed

Lines changed: 325 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,10 @@ probably the skills to scratch that itch of mine: implement `git` in a way that
1717
If you like the idea and want to learn more, please head over to [gitoxide](https://github.com/Byron/gitoxide), an
1818
implementation of 'git' in [Rust](https://www.rust-lang.org).
1919

20-
*(Please note that `gitoxide` is not currently available for use in Python, and that Rust is required.)*
20+
The experimental `GitPython[gix]` extra uses the local GixPython bindings for
21+
supported operations, with automatic Git CLI fallback. See the
22+
[local installation, test commands, and conversion ledger](doc/gix-backend.md).
23+
GixPython is not yet available on PyPI.
2124

2225
## GitPython
2326

0 commit comments

Comments
 (0)