Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

A OO-based Git Database

Project Description

Because doing stupid things with git is surprisingly fun.

OGitM is an ORM, but where the relational database that underlies the entire mapping has been replaced by an awful attempt at replicating a stupidly basic key-value document store in git. This software should never be used by anyone ever. Please, for the good of humanity.

Um… What?

Git is useful, because it stores both data, and the history of that data. This might be a useful property for a database to have. Writing a whole database based on git is boring, I should try writing an ORM to wrap around it. Well, it wouldn’t so much be an ORM, more an O… git M?

How do I use this?

Import the module, declare your model, and go!

>>> import tempfile; db_directory = tempfile.TemporaryDirectory()
>>> import ogitm
>>> class MyModel(ogitm.Model,
...     name = ogitm.fields.String()
...     age = ogitm.fields.Integer(min=0)
>>> instance = MyModel(name="Bob", age=172)
>>> instance_id =
>>> MyModel.find(name="Bob", age=172).first() == instance
>>> instance.age = -5
Traceback (most recent call last):
ValueError: Disallowed value -5 ...

Can I get at the underlying database?

Yes. Meet the gitdb module, which provides direct access to a document-based database. Initialise it with a directory that it can use as a git bare repository, and start inserting and getting.

>>> import tempfile; db_directory = tempfile.TemporaryDirectory()
>>> from ogitm import gitdb
>>> db = gitdb.GitDB(
>>> doc_id = db.insert({'name': 'Jimmy', 'age': 45, 'car': False})
>>> db.get(doc_id) == {'name': 'Jimmy', 'age': 45, 'car': False}

More than that, you can also search for documents previously inserted. These queries accept simple scalar arguments, which return all documents which have the same values as the query, and more complex dictionary arguments which can test for existence, compare etc.

>>> doc_id = db.insert({'name': 'Bobbie', 'car': True})
>>> doc_id = db.insert({'name': 'Bertie', 'age': 26, 'car': False})
>>> {'name': 'Bobbie', 'car': True} in db.find_items({'car': True})
>>> doc_id = db.insert({'name': 'Jimmy'})
>>> db.find_items({'car': {'exists': False}}) == [{'name': 'Jimmy'}]


  • Documentation. (docstrings & manual)
  • PyPI
  • Relationships? (U f*cking wot m8?)
  • Python 2
  • Better way of accessing git (May be needed for Py2, is needed for pypy, will make it easier for anyone to install it from PyPI) (See Dulwich)
  • Begin versioning sometime fairly soon

Release History

This version
History Node


History Node


Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
(11.5 kB) Copy SHA256 Hash SHA256
Wheel py3 Mar 26, 2015
(13.3 kB) Copy SHA256 Hash SHA256
Source None Mar 26, 2015

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers