This service was created as a result of the OpenReq project funded by the European Union Horizon 2020 Research and Innovation programme under grant agreement No 732463. This project uses the Connexion library on top of Flask.
This service analyzes a given set of requirements and measures the similarity for each requirement with all other requirements (pairwise). The most similar requirement pairs are then marked as potential similar candidates and delivered as recommendation.
This service requires Python 3.7.0+
- Docker (-> https://www.docker.com/)
- Flask Connexion (-> https://github.com/zalando/connexion/)
- python-dateutil (-> https://pypi.org/project/python-dateutil/)
- scikit-learn (-> https://scikit-learn.org/)
- SciPy (-> https://www.scipy.org/)
- NumPy (-> http://www.numpy.org/)
- Flask (-> https://github.com/pallets/flask/)
- NLTK (-> https://github.com/nltk/nltk/)
- Pattern Library (-> https://github.com/clips/pattern)
- Werkzeug (-> http://werkzeug.pocoo.org/)
- Setuptools (-> https://pypi.org/project/setuptools/)
To run the server and to install all dependencies, please execute the following commands from the project root directory:
pip3 install -r requirements.txt
python3 -m application
To launch the integration tests, use tox:
sudo pip install tox
tox
To run the server on a Docker container, please execute the following commands from the project root directory:
# building the image
docker build -t application .
# starting up a container
docker run -p 9006:9006 applicationOnce the server is running, open your browser and call the following URL to see the API documentation:
http://217.172.12.199:9006/ui/
The Swagger definition lives here:
http://217.172.12.199:9006/swagger.json
None.
None.
See OpenReq project contribution Guidlines
Free use of this software is granted under the terms of the EPL version 2 (EPL2.0).