runs-on:ubuntu-latest

strategy:

matrix:

python-version:[3.6, 3.7, 3.8, 3.9, "3.10.0-beta.4"]

python-version:[3.7, 3.8, 3.9, "3.10.0-beta.4"]

steps:

-uses:actions/checkout@v2

It provides abstractions of git objects for easy access of repository data, and additionally

allows you to access the git repository more directly using either a pure python implementation,

or the faster, but more resource intensive*git command* implementation.

or the faster, but more resource intensive_git command_ implementation.

The object database implementation is optimized for handling large quantities of objects and large datasets,

which is achieved by using low-level structures and data streaming.

This project is in**maintenance mode**, which means that

* …there will be no feature development, unless these are contributed

* …there will be no bug fixes, unless they are relevant to the safety of users, or contributed

* …issues will be responded to with waiting times of up to a month

- …there will be no feature development, unless these are contributed

- …there will be no bug fixes, unless they are relevant to the safety of users, or contributed

- …issues will be responded to with waiting times of up to a month

The project is open to contributions of all kinds, as well as new maintainers.

GitPython needs the`git` executable to be installed on the system and available

in your`PATH` for most operations.

If it is not in your`PATH`, you can help GitPython find it by setting

the`GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.

* Git (1.7.x or newer)

* Python >= 3.6

- Git (1.7.x or newer)

- Python >= 3.7

The list of dependencies are listed in`./requirements.txt` and`./test-requirements.txt`.

The installer takes care of installing them for you.

*Important*: Right after cloning this repository, please be sure to have executed

_Important_: Right after cloning this repository, please be sure to have executed

the`./init-tests-after-clone.sh` script in the repository root. Otherwise

you will encounter test failures.

On*Windows*, make sure you have`git-daemon` in your PATH. For MINGW-git, the`git-daemon.exe`

On_Windows_, make sure you have`git-daemon` in your PATH. For MINGW-git, the`git-daemon.exe`

exists in`Git\mingw64\libexec\git-core\`; CYGWIN has no daemon, but should get along fine

with MINGW's.

Ensure testing libraries are installed.

In the root directory, run:`pip install -r test-requirements.txt`

Ensure testing libraries are installed.

In the root directory, run:`pip install -r test-requirements.txt`

To lint, run:`flake8`

To typecheck, run:`mypy -p git`

To typecheck, run:`mypy -p git`

To test, run:`pytest`

Configuration for flake8 is in the ./.flake8 file.

Configurations for mypy, pytest and coverage.py are in ./pyproject.toml.

The same linting and testing will also be performed against different supported python versions

The same linting and testing will also be performed against different supported python versions

upon submitting a pull request (or on each push if you have a fork with a "main" branch and actions enabled).

Please have a look at the[contributions file][contributing].

*[User Documentation](http://gitpython.readthedocs.org)

*[Questions and Answers](http://stackexchange.com/filters/167317/gitpython)

* Please post on stackoverflow and use the`gitpython` tag

*[Issue Tracker](https://github.com/gitpython-developers/GitPython/issues)

* Post reproducible bugs and feature requests as a new issue.

-[User Documentation](http://gitpython.readthedocs.org)

-[Questions and Answers](http://stackexchange.com/filters/167317/gitpython)

- Please post on stackoverflow and use the`gitpython` tag

-[Issue Tracker](https://github.com/gitpython-developers/GitPython/issues)

- Post reproducible bugs and feature requests as a new issue.

Please be sure to provide the following information if posting bugs:

* GitPython version (e.g.`import git; git.__version__`)

* Python version (e.g.`python --version`)

* The encountered stack-trace, if applicable

* Enough information to allow reproducing the issue

- GitPython version (e.g.`import git; git.__version__`)

- Python version (e.g.`python --version`)

- The encountered stack-trace, if applicable

- Enough information to allow reproducing the issue

* Update/verify the**version** in the`VERSION` file

* Update/verify that the`doc/source/changes.rst` changelog file was updated

* Commit everything

* Run`git tag -s <version>` to tag the version in Git

* Run`make release`

* Close the milestone mentioned in the_changelog_ and create a new one._Do not reuse milestones by renaming them_.

* set the upcoming version in the`VERSION` file, usually be

- Update/verify the**version** in the`VERSION` file

- Update/verify that the`doc/source/changes.rst` changelog file was updated

- Commit everything

- Run`git tag -s <version>` to tag the version in Git

- Run`make release`

- Close the milestone mentioned in the_changelog_ and create a new one._Do not reuse milestones by renaming them_.

- set the upcoming version in the`VERSION` file, usually be

incrementing the patch level, and possibly by appending`-dev`. Probably you

want to`git push` once more.

*[PyDriller](https://github.com/ishepard/pydriller)

*[Kivy Designer](https://github.com/kivy/kivy-designer)

*[Prowl](https://github.com/nettitude/Prowl)

*[Python Taint](https://github.com/python-security/pyt)

*[Buster](https://github.com/axitkhurana/buster)

*[git-ftp](https://github.com/ezyang/git-ftp)

*[Git-Pandas](https://github.com/wdm0006/git-pandas)

*[PyGitUp](https://github.com/msiemens/PyGitUp)

*[PyJFuzz](https://github.com/mseclab/PyJFuzz)

*[Loki](https://github.com/Neo23x0/Loki)

*[Omniwallet](https://github.com/OmniLayer/omniwallet)

*[GitViper](https://github.com/BeayemX/GitViper)

*[Git Gud](https://github.com/bthayer2365/git-gud)

-[PyDriller](https://github.com/ishepard/pydriller)

-[Kivy Designer](https://github.com/kivy/kivy-designer)

-[Prowl](https://github.com/nettitude/Prowl)

-[Python Taint](https://github.com/python-security/pyt)

-[Buster](https://github.com/axitkhurana/buster)

-[git-ftp](https://github.com/ezyang/git-ftp)

-[Git-Pandas](https://github.com/wdm0006/git-pandas)

-[PyGitUp](https://github.com/msiemens/PyGitUp)

-[PyJFuzz](https://github.com/mseclab/PyJFuzz)

-[Loki](https://github.com/Neo23x0/Loki)

-[Omniwallet](https://github.com/OmniLayer/omniwallet)

-[GitViper](https://github.com/BeayemX/GitViper)

-[Git Gud](https://github.com/bthayer2365/git-gud)

New BSD License.See the LICENSE file.

New BSD License. See the LICENSE file.

[contributing]:https://github.com/gitpython-developers/GitPython/blob/master/CONTRIBUTING.md

Requirements

* `Python`_ >= 3.6

* `Python`_ >= 3.7

* `Git`_ 1.7.0 or newer

It should also work with older versions, but it may be that some operations

involving remotes will not work as expected.

* `GitDB`_ - a pure python git database implementation

* `typing_extensions`_ >= 3.7.3.4 (if python < 3.10)

.. _Python:https://www.python.org

.. _Git:https://git-scm.com/

.. _GitDB:https://pypi.python.org/pypi/gitdb

.. _typing_extensions:https://pypi.org/project/typing-extensions/

Installing GitPython

GitPython is not suited for long-running processes (like daemons) as it tends to

leak system resources. It was written in a time where destructors (as implemented

leak system resources. It was written in a time where destructors (as implemented

in the `__del__` method) still ran deterministically.

In case you still want to use it in such a context, you will want to search the

fromtypingimport (Any,AnyStr,BinaryIO,Callable,Dict,IO,Iterator,List,Mapping,

Sequence,TYPE_CHECKING,TextIO,Tuple,Union,cast,overload)

fromgit.typesimportPathLike,Literal

fromgit.typesimportPathLike,Literal,TBD

ifTYPE_CHECKING:

fromgit.repo.baseimportRepo

defhandle_process_output(process:subprocess.Popen,

defhandle_process_output(process:Union[subprocess.Popen,'Git.AutoInterrupt'],

stdout_handler:Union[None,

Callable[[AnyStr],None],

Callable[[List[AnyStr]],None],

Callable[[AnyStr],None],

Callable[[List[AnyStr]],None]],

finalizer:Union[None,

Callable[[subprocess.Popen],None]]=None,

Callable[[Union[subprocess.Popen,'Git.AutoInterrupt']],None]]=None,

decode_streams:bool=True)->None:

PROC_CREATIONFLAGS= (CREATE_NO_WINDOW|subprocess.CREATE_NEW_PROCESS_GROUP# type: ignore[attr-defined]

ifis_winelse0)

ifis_winelse0)# mypy error if not windows

classGit(LazyMixin):

returngetattr(self.proc,attr)

defwait(self,stderr:Union[None,bytes]=b'')->int:

defwait(self,stderr:Union[None,str,bytes]=b'')->int:

ifstderrisNone:

stderr=force_bytes(data=stderr,encoding='utf-8')

stderr_b=force_bytes(data=stderr,encoding='utf-8')

ifself.procisnotNone:

status=self.proc.wait()

defread_all_from_possibly_closed_stream(stream:Union[IO[bytes],None])->bytes:

ifstream:

try:

returnstderr+force_bytes(stream.read())

returnstderr_b+force_bytes(stream.read())

exceptValueError:

else:

ifstatus!=0:

errstr=read_all_from_possibly_closed_stream(self.proc.stderr)

self._environment:Dict[str,str]= {}

self.cat_file_header=None

self.cat_file_all=None

self.cat_file_header:Union[None,TBD]=None

self.cat_file_all:Union[None,TBD]=None

def__getattr__(self,name:str)->Any:

def__unpack_args(cls,arg_list:Sequence[str])->List[str]:

ifnotisinstance(arg_list, (list,tuple)):

return [str(arg_list)]

outlist= []

forarginarg_list:

ifisinstance(arg_list, (list,tuple)):

ifisinstance(arg_list, (list,tuple)):

forarginarg_list:

outlist.extend(cls.__unpack_args(arg))

else:

outlist.append(str(arg))

else:

outlist.append(str(arg_list))

def__call__(self,**kwargs:Any)->'Git':

Union,

overload,

)

fromgit.typesimportTBD

elifsisnotNone:

raiseTypeError('Expected bytes or text, but got %r'% (s,))

defwith_metaclass(meta:Type[Any],*bases:Any)->TBD:

classmetaclass(meta):# type: ignore

__call__=type.__call__

__init__=type.__init__# type: ignore

def__new__(cls,name:str,nbases:Optional[Tuple[int, ...]],d:Dict[str,Any])->TBD:

ifnbasesisNone:

returntype.__new__(cls,name, (),d)

returnmeta(name,bases,d)

returnmetaclass(meta.__name__+'Helper',None, {})# type: ignore