######################################################################
pygit2 - libgit2 bindings in Python
######################################################################

Bindings to the libgit2 shared library, implements Git plumbing.
Supports Python 3.6+ and PyPy3 7.2+

.. image:: https://travis-ci.org/libgit2/pygit2.svg?branch=master
   :target: http://travis-ci.org/libgit2/pygit2

.. image:: https://ci.appveyor.com/api/projects/status/edmwc0dctk5nacx0/branch/master?svg=true
   :target: https://ci.appveyor.com/project/jdavid/pygit2/branch/master

.. image:: https://github.com/libgit2/pygit2/workflows/macOS/badge.svg
   :target: https://github.com/libgit2/pygit2/actions?query=workflow%3AmacOS

Links
=====================================

- Documentation - http://www.pygit2.org/
- Install - http://www.pygit2.org/install.html
- Download - https://pypi.python.org/pypi/pygit2
- Source code and issue tracker - https://github.com/libgit2/pygit2
- Changelog - https://github.com/libgit2/pygit2/blob/master/CHANGELOG.rst
- Authors - https://github.com/libgit2/pygit2/blob/master/AUTHORS.rst


Sponsors
=====================================

- `SourceHut <https://sourcehut.org>`_

Add your name to the list, `become a sponsor <https://github.com/sponsors/jdavid>`_.


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.


Table of Contents
=====================================

.. toctree::
   :maxdepth: 1

   install
   recipes
   general

   backends
   blame
   branches
   commit_log
   config
   diff
   features
   index_file
   mailmap
   merge
   objects
   oid
   references
   remotes
   repository
   revparse
   settings
   submodule
   worktree

   development

Indices and tables
=====================================

* :ref:`genindex`
