Source

hg-importfs / DEVELOPMENT

Full commit
.. -*- restructuredtext -*-

How to set up an development environment for importfs
*****************************************************

If you havn't created a clone of the importfs repository yet do it now::

  $ hg clone https://mts.lantiq.com/~admhg/repo/importfs

Setup a virtualenv
==================

The best way to do the development is to use a virtualenv_. So first create
one using virtualenvwrapper_::

  $ mkvirtualenv --no-site-packages --distribute importfs

Then install all packages needed for development into the virtualenv using pip_::

  (importfs)$ cd importfs
  (importfs)$ pip install -r requirements-dev.txt

You also need a clone of the hg-stable repository::

  (importfs)$ cd ..
  (importfs)$ hg clone https://mts.lantiq.com/~admhg/repo/hg-stable

Update to your desired version (if you don't want to use *tip*) and build for
local use::

  (importfs)$ cd hg-stable
  (importfs)$ hg up VERSION
  (importfs)$ make local

After creating the clone create a few symlinks in your importfs repository::

  (importfs)$ cd ../importfs
  (importfs)$ ln -s ../hg-stable/contrib/pylintrc
  (importfs)$ ln -s ../hg-stable/tests/hghave
  (importfs)$ ln -s ../hg-stable/tests/run-tests.py

At least add hg-stable to your virtualenv::

  (importfs)$ add2virtualenv ../hg-stable

Run the tests
=============

To run all tests you can now execute the following command::

  (importfs)$ ./run-tests.py

Create a new source distribution package
========================================

A new Python source distribution package can be created using this command::

  (importfs)$ python setup.py sdist

.. _virtualenv: http://pypi.python.org/pypi/virtualenv
.. _virtualenvwrapper: http://pypi.python.org/pypi/virtualenvwrapper
.. _pip: http://pypi.python.org/pypi/pip