https://github.com/jelmer/dulwich

Pure-Python Git implementation
https://github.com/jelmer/dulwich

cpython dulwich git pypy python python-3 version-control

Last synced: 21 days ago
JSON representation

Pure-Python Git implementation

• Host: GitHub
• URL: https://github.com/jelmer/dulwich
• Owner: jelmer
• License: other
• Created: 2009-03-22T05:09:18.000Z (over 15 years ago)
• Default Branch: master
• Last Pushed: 2024-05-16T09:45:50.000Z (6 months ago)
• Last Synced: 2024-05-21T12:56:55.342Z (6 months ago)
• Topics: cpython, dulwich, git, pypy, python, python-3, version-control
• Language: Python
• Homepage: https://www.dulwich.io/
• Size: 16.1 MB
• Stars: 2,003
• Watchers: 51
• Forks: 381
• Open Issues: 95
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • Funding: .github/FUNDING.yml
  • License: COPYING
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
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 Rust

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.