###################################################################### pygit2 - libgit2 bindings in Python ###################################################################### .. image:: https://secure.travis-ci.org/libgit2/pygit2.png :target: http://travis-ci.org/libgit2/pygit2 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. It is likely to work with Python 2.6 and 3.1, but these versions are not officially supported. Pygit2 links: - http://github.com/libgit2/pygit2 -- Source code and issue tracker - http://www.pygit2.org/ -- Documentation - http://pypi.python.org/pypi/pygit2 -- Download Quick install guide =================== 1. Checkout the libgit2 stable branch:: $ git clone git://github.com/libgit2/libgit2.git -b master 2. Build and install libgit2 https://github.com/libgit2/libgit2/#building-libgit2---using-cmake 3. Install pygit2 with *pip*:: $ pip install cffi $ pip install pygit2 For detailed instructions check the documentation, http://www.pygit2.org/install.html Contributing ============ Fork libgit2/pygit2 on GitHub, make it awesomer (preferably in a branch named for the topic), send a pull request. Authors ============== 66 developers have contributed at least 1 commit to pygit2:: J. David Ibáñez Rémi Duraffort Adam Spiers Nico von Geyso Sebastian Thiel Alexander Bayandin Carlos Martín Nieto Fraser Tweedale Andrew Chin W. Trevor King Han-Wen Nienhuys András Veres-Szentkirályi Dave Borowitz Leonardo Rhodes Benjamin Kircher Daniel Rodríguez Troitiño Petr Viktorin Benjamin Pollack Richo Healey Thomas Kluyver Bryan O'Sullivan Christian Boos Alex Chamberlain Daniel Bruce Julien Miotte Amit Bakshi David Fischer Xu Tao Andrey Devyatkin David Sanders Jose Plana Ben Davis Devaev Maxim Martin Lenders Eric Schrijver Eric Davis Petr Hosek Hervé Cauwelier Erik Meusel Victor Garcia Huang Huang Erik van Zijst Xavier Delannoy Ian P. McCullough Ferengee Yonggang Luo Jack O'Connor Gustavo Di Pietro Valentin Haenel Jared Flatow Hugh Cole-Baker Michael Jones Jiunn Haur Lim Josh Bleecher Snyder Bernardo Heynemann Jun Omae Óscar San José John Szakmeister Sarath Lakshman Ridge Kennedy Brodie Rao Vicent Marti Rui Abreu Ferreira David Versmisse Zoran Zaric earl Changelog ============== 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 = `` `#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 `_ 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.