ordf / README.txt

Full commit

Stable releases can be installed with pip and using
virtualenv is recommended::

	% virtualenv myenv
	% . ./myenv/bin/activate
	(myenv)% pip install ordf

Development branch, do instead::

	(myenv)% pip install mercurial
	(myenv)% pip install -e hg+


To run tests::

	(myenv)% pip install nose
	(myenv)% cd myenv/src/ordf
	(myenv)% python nosetests --verbosity=2 -s

*NOTE*: to run the fourstore tests you need to have a
4store instance serving a kb called ordf_test. To do

	% 4s-backend-setup ordf_test
	% 4s-backend ordf_test

Also make sure to install py4s from
This requires at least version 0.8
Also see

*NOTE*: to run the rabbitmq tests, rabbitmq-server needs to
be running with an exchange ordf_test that can be accessed
by the user guest/guest.


To build the docs,

	(myenv)% pip install sphinx
	(myenv)% python build_sphinx

and the documentation will be in */build/sphinx/html/index.html*