ordf /

Filename Size Date modified Message
docs
examples
ordf
public
77 B
1.1 KB
33.7 KB
315 B
2.2 KB
1.2 KB
1.0 KB
127 B
187 B
90 B
2.3 KB

INSTALLING

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+http://ordf.org/src#egg=ordf

That should install everything required. If you would like to use the message passing facilities, you will need to install 'carrot':

(myenv)% pip install carrot

TESTING

To run tests:

(myenv)% pip install nose
(myenv)% cd myenv/src/ordf
(myenv)% python setup.py 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 this:

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

Also make sure to install py4s from http://github.com/wwaites/py4s This requires at least version 0.8 Also see http://wiki.github.com/wwaites/py4s/installing-py4s

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.

DOCUMENTATION

To build the docs,

(myenv)% pip install sphinx (myenv)% python setup.py build_sphinx

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

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.