4 Summary: Python Git Library
5 Home-page: https://www.dulwich.io/
6 Author: Jelmer Vernooij
7 Author-email: jelmer@jelmer.uk
8 License: Apachev2 or later or GPLv2
9 Project-URL: Bug Tracker, https://github.com/dulwich/dulwich/issues
10 Project-URL: GitHub, https://github.com/dulwich/dulwich
11 Project-URL: Repository, https://www.dulwich.io/code/
12 Description: .. image:: https://travis-ci.org/dulwich/dulwich.png?branch=master
14 :target: https://travis-ci.org/dulwich/dulwich
16 .. image:: https://ci.appveyor.com/api/projects/status/mob7g4vnrfvvoweb?svg=true
17 :alt: Windows Build Status
18 :target: https://ci.appveyor.com/project/jelmer/dulwich/branch/master
20 This is the Dulwich project.
22 It aims to provide an interface to git repos (both local and remote) that
23 doesn't call out to git directly but instead uses pure Python.
25 **Main website**: <https://www.dulwich.io/>
27 **License**: Apache License, version 2 or GNU General Public License, version 2 or later.
29 The project is named after the part of London that Mr. and Mrs. Git live in
30 in the particular Monty Python sketch.
35 By default, Dulwich' setup.py will attempt to build and install the optional C
36 extensions. The reason for this is that they significantly improve the performance
37 since some low-level operations that are executed often are much slower in CPython.
39 If you don't want to install the C bindings, specify the --pure argument to setup.py::
41 $ python setup.py --pure install
43 or if you are installing from pip::
45 $ pip install dulwich --global-option="--pure"
47 Note that you can also specify --global-option in a
48 `requirements.txt <https://pip.pypa.io/en/stable/reference/pip_install/#requirement-specifiers>`_
49 file, e.g. like this::
51 dulwich --global-option=--pure
56 Dulwich comes with both a lower-level API and higher-level plumbing ("porcelain").
58 For example, to use the lower level API to access the commit message of the
61 >>> from dulwich.repo import Repo
64 '57fbe010446356833a6ad1600059d80b1e731e15'
67 <Commit 015fc1267258458901a94d228e39f0a378370466>
69 'Add note about encoding.\n'
71 And to print it using porcelain::
73 >>> from dulwich import porcelain
74 >>> porcelain.log('.', max_entries=1)
75 --------------------------------------------------
76 commit: 57fbe010446356833a6ad1600059d80b1e731e15
77 Author: Jelmer Vernooij <jelmer@jelmer.uk>
78 Date: Sat Apr 29 2017 23:57:34 +0000
80 Add note about encoding.
85 The dulwich documentation can be found in docs/ and
86 `on the web <https://www.dulwich.io/docs/>`_.
88 The API reference can be generated using pydoctor, by running "make pydoctor",
89 or `on the web <https://www.dulwich.io/apidocs>`_.
94 There is a *#dulwich* IRC channel on the `Freenode <https://www.freenode.net/>`_, and
95 `dulwich-announce <https://groups.google.com/forum/#!forum/dulwich-announce>`_
96 and `dulwich-discuss <https://groups.google.com/forum/#!forum/dulwich-discuss>`_
102 For a full list of contributors, see the git logs or `AUTHORS <AUTHORS>`_.
104 If you'd like to contribute to Dulwich, see the `CONTRIBUTING <CONTRIBUTING.rst>`_
105 file and `list of open issues <https://github.com/dulwich/dulwich/issues>`_.
107 Supported versions of Python
108 ----------------------------
110 At the moment, Dulwich supports (and is tested on) CPython 2.7, 3.4, 3.5, 3.6 and Pypy.
114 Classifier: Development Status :: 4 - Beta
115 Classifier: License :: OSI Approved :: Apache Software License
116 Classifier: Programming Language :: Python :: 2.7
117 Classifier: Programming Language :: Python :: 3.4
118 Classifier: Programming Language :: Python :: 3.5
119 Classifier: Programming Language :: Python :: 3.6
120 Classifier: Programming Language :: Python :: Implementation :: CPython
121 Classifier: Programming Language :: Python :: Implementation :: PyPy
122 Classifier: Operating System :: POSIX
123 Classifier: Operating System :: Microsoft :: Windows
124 Classifier: Topic :: Software Development :: Version Control
125 Provides-Extra: fastimport
126 Provides-Extra: https