System wide (administrator privilege required)

pip install lairucrem

User space (no specific privilege required)

pip install --user lairucrem

Environment

You may want to use virtualenv to create an isolated Python environment.

virtualenv /path/to/envs/lairucremenv
source /path/to/envs/lairucremenv/bin/activate

Clone the repository:

hg clone http://bitbucket.org/aleufroy/lairucrem
cd lairucrem

Install dev dependencies and lairucrem (in development mode):

pip install -r dev-requirements.txt -e .

Testsuite and checks

py.test --doctest-modules --pylint -q

py.test --doctest-modules --cov=lairucrem --cov-report term-missing

pip install docutils
python setup.py --long-description | rst2html --strict -

Pull request

Please check the followings before sending your pull request:

• Add yourself to the CONSTRIBUTORS.txt file.

• Check the new feature/fix by add new tests or by adapting existing tests (test coverage is useful here). If your change does not need test change, tell it in the commit message.

• Check that tests are all green, including the –doctest-modules and –pylint options. Note that you can disable falsy warnings from pylint (with caution) by adding a comment like:

  #pylint: disable=signature-differs

• Help me understand your patch with a few lines of description in the commit message (but do not translate your code to english :P). This makes the patch integration easier and quicker than it could be without it. You can also refer to an existing issue from the tracker – I’m not a github/bitbucket addict, so let the commit message self sufficient.

In the meantime, you can send me a message on twitter (alainleufroy) or on the #mercurial IRC channel (aleufroy).