diff options
| -rw-r--r-- | README | 27 |
1 files changed, 17 insertions, 10 deletions
@@ -21,28 +21,35 @@ Core functionality is being written at the moment. # requirements -* Python v2.7 +* virtualenv v1.9.x or later +* python v2.7.x * PyYAML v3.x +* nose v1.3.x +* watchdog v0.8.2 +* pycrypto v2.6.1 # platform At the moment `combox` is written and tested on a GNU/Linux based operating system. -# running tests +# setting up the environment + +From the same directory as this README file, do: + + $ virtualenv . -All the tests are at `combox/tests`. To run a test file, do: +Activate the virtual environment: - $ cd combox - $ python -m tests.test_name + $ source bin/activate -For instance, to run `combox/tests/test_crypto.py`, do: +Install dependencies by simply installing combox: - $ cd combox - $ python -m tests.test_crypto + $ python setup.py install + +# running tests -The success of the tests must be manually verified, so please read the -test file before you run them. + $ nosetests # license |