git-orm 0.1a0

-=} Git ORM {=-
Git Object-Relational Mapper


Git-orm provides a django model like interface for storing objects in a git
repository.


INSTALLATION:

Compile libgit2[1] from source or install it via your distributions package
manager. Currently git-orm is tested with libgit2 version 0.17.0.
Afterwards execute the setup script (root permissions might be needed):

$ ./setup.py install


HACKING:

PEP 8[2] should be followed for every new code.
An exception to this rule is when creating custom exceptions (no pun intended).
The pass keyword should appear on the same line as the class keyword when no
methods are overwritten in the subclass. So multiple custom exceptions may be
declared without wasting screen space.
e.g.:

class FrobnicationNotPossible(Exception): pass
class IDontWantToDoThis(Exception): pass

Automatic style checking and detection of common errors is possible with pep8
and pyflakes. Both tools are available on pypi.

When hacking on git-orm you can install it in development mode.

$ ./setup.py develop

Development mode allows to change the source code without reinstalling the
package.

Please run the test suite before opening a pull request or committing in the
master branch.

$ ./setup.py nosetests

Every non-trivial code should have according tests.


AUTHORS & CONTRIBUTORS:

Martin Natano <natano@natano.net>
Andreas Kopecky <andreas.kopecky@gmail.com>


[1] https://github.com/libgit2/libgit2
[2] http://www.python.org/dev/peps/pep-0008/