Home Original page

update README to reflect the status quo on `git` command usage · gitpython-developers/GitPython@6fc11e6

@@ -22,12 +22,8 @@ implementation of 'git' in [Rust](https://www.rust-lang.org).

2222

GitPython is a python library used to interact with git repositories, high-level like git-porcelain,

2323

or low-level like git-plumbing.

242425-

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

26-

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

27-

or the faster, but more resource intensive _git command_ implementation.

28-29-

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

30-

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

25+

It provides abstractions of git objects for easy access of repository data often backed by calling the `git`

26+

command-line program.

31273228

### DEVELOPMENT STATUS

3329

@@ -41,8 +37,7 @@ The project is open to contributions of all kinds, as well as new maintainers.

41374238

### REQUIREMENTS

433944-

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

45-

in your `PATH` for most operations.

40+

GitPython needs the `git` executable to be installed on the system and available in your `PATH` for most operations.

4641

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

4742

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

4843