Sin descripción

Jelmer Vernooij cc93029c25 Re-add dulwich.tests.utils and dulwich.tests.test_object_store for use with e.g. breezy hace 7 meses
.github 245331a60d Move tests to root. Fixes #1024 hace 7 meses
bin 23a986ac9b Sort Python import definitions with isort hace 1 año
crates df4d874b93 Bump pyo3 version hace 7 meses
devscripts 1b8231acc6 Add script for updating preamble. hace 8 años
docs e3ca1cb5ce Reformat and add reformat make target hace 1 año
dulwich cc93029c25 Re-add dulwich.tests.utils and dulwich.tests.test_object_store for use with e.g. breezy hace 7 meses
examples 3317eef581 Reformat with ruff hace 7 meses
testdata c1738f5fe1 Move testdata out of code directory. hace 2 años
tests cc93029c25 Re-add dulwich.tests.utils and dulwich.tests.test_object_store for use with e.g. breezy hace 7 meses
.codespellrc e3333e0301 Add codespell target hace 1 año
.coveragerc 95d44cdfa1 Set source in coveragerc rather than passing on command-line. hace 6 años
.deepsource.toml d6fc2e465e chore: refactor code quality issues hace 3 años
.gitignore d20889374a Move objects to crates/ hace 9 meses
.mailmap 4c5c2752fa Update mailmap. hace 6 años
.readthedocs.yaml 39e1ff4db4 rename .readthedocs.yml -> .readthedocs.yaml hace 1 año
.stestr.conf 245331a60d Move tests to root. Fixes #1024 hace 7 meses
.testr.conf 245331a60d Move tests to root. Fixes #1024 hace 7 meses
AUTHORS 493658afb1 Update NEWS, AUTHORS. hace 3 años
CODE_OF_CONDUCT.md 11bddcfc87 Prettify md/yaml files hace 2 años
CONTRIBUTING.rst ff64fa9e44 Migrate from flake8 to ruff (#1231) hace 1 año
COPYING 7098611ac3 As agreed by all contributors, change the license from: hace 8 años
Cargo.lock df4d874b93 Bump pyo3 version hace 7 meses
Cargo.toml df4d874b93 Bump pyo3 version hace 7 meses
MANIFEST.in 72377321d3 Drop removed files from MANIFEST.in. hace 2 años
Makefile 245331a60d Move tests to root. Fixes #1024 hace 7 meses
NEWS 245331a60d Move tests to root. Fixes #1024 hace 7 meses
README.rst 9a77f96474 Convert diff-tree to rust hace 9 meses
SECURITY.md 940ab2ec78 Update security policy now that 0.21.X is out. hace 1 año
TODO 1282de4286 Update TODO. hace 6 años
disperse.conf 7e648a1a00 Disable twine upload in disperse; this is now done on GitHub hace 11 meses
dulwich.cfg 13fced2e1d Change homepage to www.dulwich.io. hace 9 años
pyproject.toml 245331a60d Move tests to root. Fixes #1024 hace 7 meses
requirements.txt 5505a96d28 removed urllib3[secure] hace 2 años
setup.py 3317eef581 Reformat with ruff hace 7 meses
status.yaml 11bddcfc87 Prettify md/yaml files hace 2 años
tox.ini 02705b344d Simplify tox setup (#1086) hace 2 años

README.rst

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 Rust bindings, specify the --pure argument to setup.py::

$ python setup.py --pure install

or if you are installing from pip::

$ pip install --no-binary dulwich dulwich --config-settings "--build-option=--pure"

Note that you can also specify --build-option in a
`requirements.txt `_
file, e.g. like this::

dulwich --config-settings "--build-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.