Commits

William Waites  committed c984521

housekeeping, packaging

  • Participants
  • Parent commits 101ddbc
  • Tags 0.6

Comments (0)

Files changed (4)

 INSTALLING
 ==========
 
-The usual installation procedure should be sufficient
+Stable releases can be installed with pip and using
+virtualenv is recommended::
 
-    python setup.py install
+	% 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
 
 TESTING
 =======
 
-To run tests,
+To run tests::
 
-    python setup.py nosetests --verbosity=2 -s
+	(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
+*NOTE*: to run the fourstore tests you need to have a
 4store instance serving a kb called ordf_test. To do
-this,
+this::
 
-    4s-backend-setup ordf_test
-    4s-backend ordf_test
+	% 4s-backend-setup ordf_test
+	% 4s-backend ordf_test
 
-Also make sure to install py4s from
+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
 
-    http://github.com/wwaites/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.
 
-This requires at least version 0.8
-
-Also see
-
-    http://wiki.github.com/wwaites/py4s/installing-py4s
-
-NOTE: to run the queueing tests you need rabbitmq 
-running
 
 DOCUMENTATION
 =============
 
 To build the docs,
 
-    python setup.py build_sphinx
+	(myenv)% pip install sphinx
+	(myenv)% python setup.py build_sphinx
 
-and the documentation will be in
-
-    ${ordf_root}/build/sphinx/html/index.html
+and the documentation will be in */build/sphinx/html/index.html*

File ordf/tests/test_queue.py

         for ctx in store.contexts():
             print "recv graph", ctx.identifier
 
-receiver = RabbitHandler(hostname="localhost", userid="guest", password="guest")
+receiver = RabbitHandler(hostname="localhost", userid="guest", password="guest", exchange="ordf_test")
 receiver.register_writer(LoggingHandler())
 
-sender = Handler()
+sender = Handler(exchange="ordf_test")
 
 class TestClassRabbit(object):
     def test_01_connect_sender(self):

File pip-requirements.txt

-setuptools
-FuXi
-rdflib==2.4.2
+# FuXi needs 2.4.2 for now, just use rdflib if no inferencing
+# is needed
+#FuXi
+#rdflib==2.4.2
+rdflib
 carrot
 -e git+http://github.com/benosteen/pairtree.git#egg=Pairtree
-mercurial
+setuptools
+Paste
 from setuptools import setup, find_packages
 import sys, os
 
-version = '0.5'
+version = '0.6'
 
 try:
     from mercurial import ui, hg, error
     include_package_data=True,
     zip_safe=False,
     install_requires=[
+        "Paste",
         "setuptools",
         "rdflib",
         "carrot",