Pygit2 is a set of Python bindings to the libgit2 shared library, libgit2 implements the core of Git. Pygit2 works with Python 2.7, 3.2, 3.3, 3.4 and pypy.

Links:

http://github.com/libgit2/pygit2 -- Source code and issue tracker
http://www.pygit2.org/ -- Documentation
http://pypi.python.org/pypi/pygit2 -- Download

How to install

Check http://www.pygit2.org/install.html

Changelog

0.22.0 (2015-01-16)

New:

Update to libgit2 v0.22 #459
Add support for libgit2 feature detection (new pygit2.features and pygit2.GIT_FEATURE_*) #475
New Repository.remotes (RemoteCollection) #447

API Changes:

Prototype of clone_repository changed, check documentation
Removed clone_into, use clone_repository with callbacks instead
Use Repository.remotes.rename(name, new_name) instead of Remote.rename(new_name)
Use Repository.remotes.delete(name) instead of Remote.delete()
Now Remote.push(...) takes a list of refspecs instead of just one
Change Patch.old_id, Patch.new_id, Note.annotated_id, RefLogEntry.oid_old and RefLogEntry.oid_new to be Oid objects instead of strings #449

Other:

Fix init_repository when passing optional parameters workdir_path, description, template_path, initial_head or origin_url #466 #471
Fix use-after-free when patch outlives diff #457 #461 #474
Documentation improvements #456 #462 #465 #472 #473
Make the GPL exception explicit in setup.py #450

0.21.4 (2014-11-04)

Fix credentials callback not set when pushing #431 #435 #437 #438
Fix Repository.diff(...) when treeish is "empty" #432
New Reference.peel(...) renders Reference.get_object() obsolete #434
New, authenticate using ssh agent #424
New Repository.merge_commits(...) #445
Make it easier to run when libgit2 not in a standard location #441
Documentation: review install chapter
Documentation: many corrections #427 #429 #439 #440 #442 #443 #444

0.21.3 (2014-09-15)

Breaking changes:

Now Repository.blame(...) returns Oid instead of string #413
New Reference.set_target(...) replaces the Reference.target setter and Reference.log_append(...) #414
New Repository.set_head(...) replaces the Repository.head setter #414
Repository.merge(...) now uses the SAFE_CREATE strategy by default #417

Other changes:

New Remote.delete() #418 #420
New Repository.write_archive(...) #421
Now Repository.checkout(...) accepts branch objects #408
Fix refcount leak in remotes #403 #404 #419
Various fixes to clone_repository(...) #399 #411 #425 #426
Fix build error in Python 3 #401
Now pip install pygit2 installs cffi first #380 #407
Add support for pypy3 #422
Documentation improvements #398 #409

0.21.2 (2014-08-09)

Fix regression with Python 2, IndexEntry.path returns str (bytes in Python 2 and unicode in Python 3)
Get back IndexEntry.oid for backwards compatibility
Config, iterate over the keys (instead of the key/value pairs) #395
Diff.find_similar supports new threshold arguments #396
Optimization, do not load the object when expanding an oid prefix #397

0.21.1 (2014-07-22)

Install fix #382
Documentation improved, including #383 #385 #388
Documentation, use the read-the-docs theme #387
Coding style improvements #392
New Repository.state_cleanup() #386
New Index.conflicts #345 #389
New checkout option to define the target directory #390

Backward incompatible changes:

Now the checkout strategy must be a keyword argument.

Change Repository.checkout(refname, strategy) to Repository.checkout(refname, strategy=strategy)

Idem for checkout_head, checkout_index and checkout_tree

0.21.0 (2014-06-27)

Highlights:

Drop official support for Python 2.6, and add support for Python 3.4 #376
Upgrade to libgit2 v0.21.0 #374
Start using cffi #360 #361

Backward incompatible changes:

Replace oid by id through the API to follow libgit2 conventions.
Merge API overhaul following changes in libgit2.
New Remote.rename(...) replaces Remote.name = ...
Now Remote.fetch() returns a TransferProgress object.
Now Config.get_multivar(...) returns an iterator instead of a list.

New features:

New Config.snapshot() and Repository.config_snapshot()
New Config methods: get_bool(...), get_int(...), parse_bool(...) and parse_int(...) #357
Blob: implement the memory buffer interface #362
New clone_into(...) function #368
Now Index can be used alone, without a repository #372
Add more options to init_repository #347
Support Repository.workdir = ... and support setting detached heads Repository.head = <Oid> #377

Other:

Fix again build with VS2008 #364
Fix Blob.diff(...) and Blob.diff_to_buffer(...) arguments passing #366
Fail gracefully when compiling against the wrong version of libgit2 #365
Several documentation improvements and updates #359 #375 #378

0.20.3 (2014-04-02)

A number of memory issues fixed #328 #348 #353 #355 #356
Compatibility fixes for PyPy (#338), Visual Studio 2008 (#343) and Python 3.3 (#351)
Make the sort mode parameter in Repository.walk(...) optional #337
New Object.peel(...) #342
New Index.add_all(...) #344
Introduce support for libgit2 options #350
More informative repr for Repository objects #352
Introduce support for credentials #354
Several documentation fixes #302 #336
Tests, remove temporary files #341

0.20.2 (2014-02-04)

Support pypy #209 #327 #333

Repository:

New Repository.default_signature #310

Oid:

New str(Oid) deprecates Oid.hex #322

Object:

New Object.id deprecates Object.oid #322
New TreeEntry.id deprecates TreeEntry.oid #322
New Blob.diff(...) and Blob.diff_to_buffer(...) #307
New Commit.tree_id and Commit.parent_ids #73 #311
New rich comparison between tree entries #305 #313
Now Tree.__contains__(key) supports paths #306 #316

Index:

Now possible to create IndexEntry(...) #325
Now IndexEntry.path, IndexEntry.oid and IndexEntry.mode are writable #325
Now Index.add(...) accepts an IndexEntry too #325
Now Index.write_tree(...) is able to write to a different repository #325
Fix memory leak in IndexEntry.path setter #335

Config:

New Config iterator replaces Config.foreach #183 #312

Remote:

New type Refspec #314
New Remote.push_url #315
New Remote.add_push and Remote.add_fetch #255 #318
New Remote.fetch_refspecs replaces Remote.get_fetch_refspecs() and Remote.set_fetch_refspecs(...) #319
New Remote.push_refspecs replaces Remote.get_push_refspecs() and Remote.set_push_refspecs(...) #319
New Remote.progress, Remote.transfer_progress and Remote.update_tips #274 #324
New type TransferProgress #274 #324
Fix refcount leak in Repository.remotes #321 #332

Other: #331

0.20.1 (2013-12-24)

New remote ref-specs API: #290
New Repository.reset(...): #292, #294
Export GIT_DIFF_MINIMAL: #293
New Repository.merge(...): #295
Fix Repository.blame argument handling: #297
Fix build error on Windows: #298
Fix typo in the README file, Blog → Blob: #301
Now Diff.patch returns None if no patch: #232, #303
New Walker.simplify_first_parent(): #304

0.20.0 (2013-11-24)

Upgrade to libgit2 v0.20.0: #288
New Repository.head_is_unborn replaces Repository.head_is_orphaned
Changed pygit2.clone_repository(...). Drop push_url, fetch_spec and push_spec parameters. Add ignore_cert_errors.
New Patch.additions and Patch.deletions: #275
New Patch.is_binary: #276
New Reference.log_append(...): #277
New Blob.is_binary: #278
New len(Diff) shows the number of patches: #281
Rewrite Repository.status(): #283
New Reference.shorthand: #284
New Repository.blame(...): #285
Now Repository.listall_references() and Repository.listall_branches() return a list, not a tuple: #289

Authors

83 developers have contributed at least 1 commit to pygit2:

J. David Ibáñez            Sebastian Thiel            András Veres-Szentkirályi
Carlos Martín Nieto        Fraser Tweedale            Ash Berlin
Nico von Geyso             Han-Wen Nienhuys           Benjamin Kircher
W. Trevor King             Leonardo Rhodes            Benjamin Pollack
Dave Borowitz              Petr Viktorin              Bryan O'Sullivan
Daniel Rodríguez Troitiño  Ron Cohen                  Daniel Bruce
Richo Healey               Thomas Kluyver             David Fischer
Christian Boos             Alex Chamberlain           David Sanders
Julien Miotte              Alexander Bayandin         Devaev Maxim
Xu Tao                     Amit Bakshi                Eric Davis
Jose Plana                 Andrey Devyatkin           Erik Meusel
Matthew Gamble             Arno van Lumig             Erik van Zijst
Martin Lenders             Ben Davis                  Ferengee
Petr Hosek                 Eric Schrijver             Gustavo Di Pietro
Victor Garcia              Hervé Cauwelier            Hugh Cole-Baker
Xavier Delannoy            Huang Huang                Jasper Lievisse Adriaanse
Yonggang Luo               Ian P. McCullough          Josh Bleecher Snyder
Valentin Haenel            Jack O'Connor              Kyriakos Oikonomakos
Michael Jones              Jared Flatow               Mathieu Bridon
Bernardo Heynemann         Jiunn Haur Lim             Óscar San José
John Szakmeister           Jun Omae                   Ridge Kennedy
Matthew Duggan             Sarath Lakshman            Rui Abreu Ferreira
Brodie Rao                 Vicent Marti               Soasme
Vlad Temian                Zoran Zaric                chengyuhang
David Versmisse            Adam Spiers                earl
Rémi Duraffort             Andrew Chin

License

GPLv2 with linking exception.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.

In addition to the permissions in the GNU General Public License, the authors give you unlimited permission to link the compiled version of this file into combinations with other programs, and to distribute those combinations without any restriction coming from the use of this file. (The General Public License restrictions do apply in other respects; for example, they cover modification of the file, and distribution when not linked into a combined executable.)

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; see the file COPYING. If not, write to the Free Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.