Git Wrapper

The Simple Python Git Wrapper

This library is a simple git wrapper which let you perform many operations on any git repository in a powerful and simple way.

Requirements

This library has been tested python >= 3.7, 3.8 and you need to have installed Git > 2.22.0

Getting Started

The library is pretty simple, you only need to indicate where your repository is or create a new one.

from python_git_wrapper import Repository

repository = Repository('.') # Path of your git repository. It could be relative to your project or absolute

Or if the repository doesn't exist yet

repository = Repository('.', create=True)

Adding files:

repository.add_files('path to any file')

Committing changes:

repository.commit('commit message')

Finally, pushing them:

repository.push()

Components

The library is divided in 3 main components.

• Git Service: Object which contains all the data to communicate with the git process properly.

  • NOTE: If you don't have configured the path of the git binary in your path. Execute the next command: GitService.singleton('git path'')

• Repository: It will be your entry point, which you will interact to provide an retrieve all the information. It is a reference to the repository you want to work on.

• Git Elements:

  • Commit: Containing all the relevant information about any commit

  • Branch: Contains the name of the branch

  • Status: Object which structure all the changes in your working directory

API Overview

Small overview about the capabilities of this library. All this methods and attributes are accesible by the repository object.

Detailed API Specification Here.