GitDB
=====

GitDB allows you to access bare git repositories for reading and writing. It aims at allowing full access to loose objects as well as packs with performance and scalability in mind. It operates exclusively on streams, allowing to handle large objects with a small memory footprint.

Installation
============

.. image:: https://img.shields.io/pypi/v/gitdb.svg
    :target: https://pypi.python.org/pypi/gitdb/
    :alt: Latest Version
.. image:: https://img.shields.io/pypi/pyversions/gitdb.svg
    :target: https://pypi.python.org/pypi/gitdb/
    :alt: Supported Python versions
.. image:: https://readthedocs.org/projects/gitdb/badge/?version=latest
    :target: https://readthedocs.org/projects/gitdb/?badge=latest
    :alt: Documentation Status

From `PyPI <https://pypi.python.org/pypi/gitdb>`_::

 pip install gitdb

SPEEDUPS
========

If you want to go up to 20% faster, you can install gitdb-speedups with::

 pip install gitdb-speedups

However, please note that gitdb-speedups is not currently maintained.

REQUIREMENTS
============

* smmap - declared as a dependency, automatically installed
* pytest - for running the tests

SOURCE
======

The source is available in the GitPython repository on GitHub:

https://github.com/gitpython-developers/GitPython/tree/main/gitdb

Run the tests with::

 pytest

DEVELOPMENT
===========

.. image:: https://github.com/gitpython-developers/GitPython/actions/workflows/dependencies.yml/badge.svg
    :target: https://github.com/gitpython-developers/GitPython/actions/workflows/dependencies.yml

The library is considered mature, and not under active development. Its primary (known) use is in GitPython.

INFRASTRUCTURE
==============

* Discussions
    * https://github.com/gitpython-developers/GitPython/discussions

* Issue Tracker
    * https://github.com/gitpython-developers/GitPython/issues

LICENSE
=======

New BSD License
