From 94b6c0ecc70334cee56a8e7bbaee02be6603fa51 Mon Sep 17 00:00:00 2001
From: Nikolay Stanchev <ns17@it-innovation.soton.ac.uk>
Date: Tue, 15 May 2018 10:35:29 +0100
Subject: [PATCH] Updated README based on restructuring and tox automation
support
---
README.md | 24 +++++++++++++++++++++---
src/clmcservice/setup.py | 2 +-
2 files changed, 22 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 11270fb..78fa4cb 100644
--- a/README.md
+++ b/README.md
@@ -129,8 +129,26 @@ When created, you should already be set to use the new virtual environment, but
workon CLMC
```
-Now, any installed libraries will be specificly installed in this environment only. To install and use the CLMC service
-locally, the easiest thing to do is to use **pip** (make sure you are in the root folder of the project - ***flame-clmc***):
+Now, any installed libraries will be specifically installed in this environment only.
+
+To install and use the CLMC service locally, the easiest thing to do is to use **pip**. Navigate to the clmcservice root folder:
+```
+cd src/clmcservice
+```
+
+Test the CLMC service using **tox** along with the ***tox.ini*** configuration file. If tox is not installed run:
+
+```
+pip install tox
+```
+
+After it is installed, simply use the **tox** command:
+
+```
+tox
+```
+
+Then install the service in development mode.
```
pip install -e .
@@ -142,4 +160,4 @@ Finally, start the service on localhost by using pyramid's **pserve**:
pserve development.ini --reload
```
-You should now be able to see the 'Hello world' message when visiting **http://localhost:8080** in your browser.
\ No newline at end of file
+You should now be able to make requests to the CLMC service on http://localhost:8080/aggregator.
\ No newline at end of file
diff --git a/src/clmcservice/setup.py b/src/clmcservice/setup.py
index bbc0d79..f0b52b7 100644
--- a/src/clmcservice/setup.py
+++ b/src/clmcservice/setup.py
@@ -46,11 +46,11 @@ requires = [
'pyramid_debugtoolbar',
'waitress',
'influxdb',
+ 'pytest',
]
tests_require = [
'WebTest >= 1.3.1', # py3 compat
- 'pytest',
'pytest-cov',
]
--
GitLab