| single |
Dulwich
=======
This is the Dulwich project.
It aims to provide an interface to git repos (both local and remote) that
doesn't call out to git directly but instead uses pure Python.
**Main website**:
**License**: Apache License, version 2 or GNU General Public License,
version 2 or later.
The project is named after the part of London that Mr. and Mrs. Git live in
in the particular Monty Python sketch.
Installation
------------
By default, Dulwich' setup.py will attempt to build and install the
optional C
extensions. The reason for this is that they significantly improve the
performance
since some low-level operations that are executed often are much slower in
CPython.
If you don't want to install the C bindings, specify the --pure argument to
setup.py::
$ python setup.py --pure install
or if you are installing from pip::
$ pip install dulwich --global-option="--pure"
Note that you can also specify --global-option in a
`requirements.txt
`_
file, e.g. like this::
dulwich --global-option=--pure
Getting started
---------------
Dulwich comes with both a lower-level API and higher-level plumbing
("porcelain").
For example, to use the lower level API to access the commit message of the
last commit::
>>> from dulwich.repo import Repo
>>> r = Repo('.')
>>> r.head()
'57fbe010446356833a6ad1600059d80b1e731e15'
>>> c = r[r.head()]
>>> c
>>> c.message
'Add note about encoding.\n'
And to print it using porcelain::
>>> from dulwich import porcelain
>>> porcelain.log('.', max_entries=1)
--------------------------------------------------
commit: 57fbe010446356833a6ad1600059d80b1e731e15
Author: Jelmer Vernooij
Date: Sat Apr 29 2017 23:57:34 +0000
Add note about encoding.
Further documentation
---------------------
The dulwich documentation can be found in docs/ and built by running make
doc. It can also be found [on the web].
Help
----
There is a *#dulwich* IRC channel on the [OFTC], and
a `dulwich-discuss
`_
mailing list.
Contributing
------------
For a full list of contributors, see the git logs or [AUTHORS].
If you'd like to contribute to Dulwich, see the [CONTRIBUTING]
file and [list of open issues].
Supported versions of Python
----------------------------
At the moment, Dulwich supports (and is tested on) CPython 3.6 and later
and
Pypy.
|