git-python (pynickle)

1.1.2 · active · verified Mon Apr 13

git-python by pynickle is a lightweight Python wrapper that simplifies a small subset of Git commands for personal use. It functions primarily as a command-line tool, providing simplified commands like `init`, `add`, and `commit`. It is not the widely-used `GitPython` library (note the capitalization). The current version is 1.1.2, with an irregular release cadence focused on personal utility.

Warnings

gotcha There is a significant naming collision: `git-python` (this library, by pynickle) vs. `GitPython` (a comprehensive and widely-used library for programmatic Git interaction by gitpython-developers). They are distinct projects with different APIs and functionalities.
Fix: Carefully verify which library you intend to use. For this specific library (pynickle's), install with `pip install git-python`. For the other, install with `pip install GitPython`. Ensure your imports and code match the correct library.
gotcha This `git-python` library is primarily designed as a command-line tool, not for direct programmatic imports. Its internal `GitPython` class methods (e.g., `init`, `add`) often rely on the script's execution environment or `os.path.dirname(__file__)` to determine paths, making them unsuitable for managing arbitrary Git repositories programmatically from a different script context.
Fix: The most robust way to use this library from Python is to execute its CLI commands via `subprocess.run()`, as demonstrated in the quickstart, rather than attempting direct programmatic imports and method calls.
gotcha The `git-python` library (pynickle) provides a very limited subset of Git commands, including only `init`, `add`, and `commit`. It is not intended as a full-featured Git client or wrapper.
Fix: For more extensive Git functionality, consider using the `GitPython` library (note capitalization) or other robust Git wrappers like `dulwich` or `pygit2`.

Install

pip install git-python Install latest version

Imports

GitPython
```
from gitpython.gp import GitPython
```
This library is primarily designed as a command-line tool (`gitpython gp ...`) rather than for direct programmatic import. Its internal logic often relies on `os.path.dirname(__file__)`, making it difficult to use programmatically for managing Git repositories in arbitrary directories outside of its installation path. Direct use of `subprocess` to call its CLI interface is generally more reliable.

Quickstart

This quickstart demonstrates how to interact with `git-python` using its command-line interface via `subprocess`, which is its primary intended mode of operation. It initializes a new Git repository, creates a file, adds it, and commits it within a temporary directory.

import subprocess
import os
import tempfile
import shutil

# Create a temporary directory for the Git repo
temp_dir = tempfile.mkdtemp()
print(f"Created temporary directory: {temp_dir}")
original_cwd = os.getcwd()

try:
    os.chdir(temp_dir)

    # 1. Initialize a new gitpython repository
    print("Initializing gitpython repository...")
    result = subprocess.run(["gitpython", "gp", "init"], capture_output=True, text=True, check=True)
    print(f"init stdout:\n{result.stdout}")

    # 2. Create a file
    with open("example.txt", "w") as f:
        f.write("Hello, git-python!")
    print("Created example.txt")

    # 3. Add the file
    print("Adding example.txt...")
    result = subprocess.run(["gitpython", "gp", "add", "."], capture_output=True, text=True, check=True)
    print(f"add stdout:\n{result.stdout}")

    # 4. Commit the file
    print("Committing changes...")
    result = subprocess.run(["gitpython", "gp", "commit", "-m", "Initial commit via git-python CLI"], capture_output=True, text=True, check=True)
    print(f"commit stdout:\n{result.stdout}")

    # Verify using standard git CLI (optional, but good for demo)
    print("\nVerifying with standard 'git' command:")
    result = subprocess.run(["git", "log", "--oneline"], capture_output=True, text=True, check=True)
    print(f"git log stdout:\n{result.stdout}")

except subprocess.CalledProcessError as e:
    print(f"Error during subprocess call: {e}")
    print(f"Stdout: {e.stdout}")
    print(f"Stderr: {e.stderr}")
except Exception as e:
    print(f"An unexpected error occurred: {e}")
finally:
    os.chdir(original_cwd)
    # Clean up the temporary directory
    print(f"Cleaning up temporary directory: {temp_dir}")
    shutil.rmtree(temp_dir)

view raw JSON →