https://github.com/gitpython-developers/gitdb

IO of git-style object databases
https://github.com/gitpython-developers/gitdb

Last synced: 7 months ago
JSON representation

IO of git-style object databases

• Host: GitHub
• URL: https://github.com/gitpython-developers/gitdb
• Owner: gitpython-developers
• License: other
• Created: 2010-11-30T17:36:17.000Z (about 15 years ago)
• Default Branch: master
• Last Pushed: 2025-01-27T08:35:16.000Z (11 months ago)
• Last Synced: 2025-05-11T12:38:47.253Z (7 months ago)
• Language: Python
• Homepage: http://gitdb.readthedocs.org
• Size: 1.57 MB
• Stars: 221
• Watchers: 20
• Forks: 66
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Security: SECURITY.md
  • Authors: AUTHORS

Awesome Lists containing this project

• awesome-github-star - gitdb - style object databases | gitpython-developers | 189 | (Python)

README

          
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 `_::

 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 a git repository on GitHub:

https://github.com/gitpython-developers/gitdb

Once the clone is complete, please be sure to initialize the submodule using::

 cd gitdb

 git submodule update --init

Run the tests with::

 pytest

DEVELOPMENT

===========

.. image:: https://github.com/gitpython-developers/gitdb/workflows/Python%20package/badge.svg

    :target: https://github.com/gitpython-developers/gitdb/actions

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/gitdb/issues

LICENSE

=======

New BSD License