shell
To install Hammurabi, run this command in your terminal:
$ pip install hammurabiThis is the preferred method to install Hammurabi, as it will always install the most recent stable release.
If you don't have pip installed, this Python installation guide can guide you through the process.
Hammurabi tries to be as tiny as its possible, hence some rules are requiring extra dependencies to be installed. Please check the documentation of the Rules to know which dependency is required to use the specific rule.
To install hammurabi with an extra package run pip install hammurabi[<EXTRA>], where <EXTRA> is the name of the extra option. To install multiple extra packages list the extra names separated by comma as described in pip's examples section point number six.
| Extra | Description |
|---|---|
| all | alias to install all the extras available |
| ini | needed for ini/cfg based rules |
| ujson | install if you need faster json manipulat |
| yaml | needed for yaml based rules |
| templating | needed for rules which are using templates |
| slack-notifications | needed for slack webhook notifications |
The sources for Hammurabi can be downloaded from the Github repo.
You can either clone the public repository:
$ git clone git://github.com/gabor-boros/hammurabiOr download the tarball:
$ curl -OL https://github.com/gabor-boros/hammurabi/tarball/masterOnce you have a copy of the source, you can install it with:
$ python setup.py install