5a007802d0
API changes: - New Oid type - Changed signature of Repository.create_reference - Reference.oid and Reference.hex removed, use Reference.target instead - Drop "del Index[path]" from the API, use Index.remove(path) instead - Drop TreeEntry.to_object - Changed signature of Repository.checkout - Repository.create_blob_from_file removed, use instead new methods Repository.create_blob_fromworkdir and Repository.create_blob_from_disk New features: - Add len(TreeBuilder) and TreeBuilder.get - Add Repository.merge_base - Support changing the head with "Repository.head = refname" - Improved support for diff - Add support for clone - Python 2: Support hex oids as byte strings - Add Reference.get_object() - Add Remote.save - Add support for branches, new type Branch Other: - Upgraded to libgit2 0.19 - Partial documentation review Thanks to Nico von Geyso, Daniel Rodríguez Troitiño, Bernardo Heynemann, Rémi Duraffort, Andrey Devyatkin, Hervé Cauwelier, Jiunn Haur Lim, Richo Healey, Carlos Martín Nieto, David Fischer, Fraser Tweedale, Jun Omae and Xu Tao.
129 lines
3.2 KiB
ReStructuredText
129 lines
3.2 KiB
ReStructuredText
|
|
######################################################################
|
|
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.6, 2.7, 3.1, 3.2 and
|
|
3.3
|
|
|
|
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 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
|
|
==============
|
|
|
|
This is the list of authors of pygit2, sorted by number of commits (as shown by
|
|
``git shortlog -sn``):
|
|
|
|
- J David Ibáñez
|
|
- Nico von Geyso
|
|
- W Trevor King
|
|
- Dave Borowitz
|
|
- Carlos Martín Nieto
|
|
- Daniel Rodríguez Troitiño
|
|
- Richo Healey
|
|
- Christian Boos
|
|
- Julien Miotte
|
|
- Martin Lenders
|
|
- Xavier Delannoy
|
|
- Yonggang Luo
|
|
- Valentin Haenel
|
|
- Bernardo Heynemann
|
|
- John Szakmeister
|
|
- David Versmisse
|
|
- Petr Hosek
|
|
- Rémi Duraffort
|
|
- Sebastian Thiel
|
|
- Han-Wen Nienhuys
|
|
- Petr Viktorin
|
|
- Alex Chamberlain
|
|
- Amit Bakshi
|
|
- Andrey Devyatkin
|
|
- Ben Davis
|
|
- Hervé Cauwelier
|
|
- Jared Flatow
|
|
- Jiunn Haur Lim
|
|
- Sarath Lakshman
|
|
- Vicent Marti
|
|
- Zoran Zaric
|
|
- András Veres-Szentkirályi
|
|
- Benjamin Kircher
|
|
- Benjamin Pollack
|
|
- Bryan O'Sullivan
|
|
- David Fischer
|
|
- David Sanders
|
|
- Eric Davis
|
|
- Eric Schrijver
|
|
- Erik van Zijst
|
|
- Ferengee
|
|
- Fraser Tweedale
|
|
- Hugh Cole-Baker
|
|
- Josh Bleecher Snyder
|
|
- Jun Omae
|
|
- Ridge Kennedy
|
|
- Rui Abreu Ferreira
|
|
- Xu Tao
|
|
- pistacchio
|
|
|
|
|
|
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.
|