INSTALL.rst

Versions

We recommend you to use the stable version unless you want to contribute.

Stable version

kwalitee is on PyPI so all you need is:

$ pip install --user kwalitee

Development version

$ git clone https://github.com/inveniosoftware/kwalitee
$ cd kwalitee
$ pip install --user -r requirements.txt

Installation of the command-line interface

Kwalitee can be used as a :ref:`cli`, which has some handy features like the :ref:`githooks` and the :ref:`messages` checks.

By default the messages checks will try to use GitPython but we are recommending you to install and use pygit2. As, it has not stable version yet, the installation requires some work.

Ubuntu

$ sudo apt-add-repository ppa:dennis/python
$ sudo apt-get update
$ sudo apt-get install python-dev libffi-dev libgit2
$ pip install cffi pygit2

If you don't find a suitable version using ppa:dennis/python, you can always install it manually via cmake.

OSX

The important detail here is to use the same version for libgit2 and pygit2. Homebrew is a way to get it working.

$ brew update
$ brew install libgit2 # currently 0.21.0 (2014-07-28)
$ pip install pygit2