Skip to content
WP3 - Recommendation of Prioritized Requirements
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
.swagger-codegen
application
.dockerignore
.gitignore
.swagger-codegen-ignore
.travis.yml
Dockerfile
LICENSE
Pipfile
README.md
git_push.sh
requirements.txt
setup.py
test-requirements.txt
tox.ini

README.md

Issue Recommendation Service for Eclipse Plugin EPL 2.0

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. It includes a recommendation approach for the Eclipse Plugin that finds relevant issues for developers and ranks/prioritizes them according to certain criteria such as individual relevance (e.g., "is this issue assigned to the active user?", "do the keywords overlap with the keywords of the active user's profile?", etc.) and community relevance (e.g., "number of comments", "does this issue block other issues and if so, how many other issues are blocked and how relevant are these blocked issues?", etc.). This project uses the Connexion library on top of Flask.

Technical description

What does the service do

This service provides the backend server-side functionality of Vogella's OpenReq Eclipse Plugin (see: https://github.com/OpenReqEU/eclipse-plugin-vogella). This service addresses the Eclipse developer community. It supports the individual Eclipse developers in their daily work by recommending relevant bugs/issues to them. These recommended bugs/issues are then delivered to Vogella's Eclipse plugin. The service fetches bugs/issues from the Bugzilla API of Eclipse (http://bugs.eclipse.org) and estimates how relevant these bugs/issues are for the current developer. The estimation of a bug/issue is based on the computation of a priority value by exploiting characteristic meta-information of the bug/issue. After the estimation, the recommended list of issues (sorted by their priorities) is finally sent to the Eclipse plugin. Issues with very low priorities are excluded from the recommended list.

Which technologies are used

This service requires Python 3.7.0+

How to install it

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

Running with Docker

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 9002:9002 application

How to use it (high-level description)

Once the server is running, open your browser and call the following URL to see the API documentation:

http://217.172.12.199:9002/ui/

The Swagger definition lives here:

http://217.172.12.199:9002/swagger.json

Rendered Documentation

Notes for developers

None.

Sources

None.

How to contribute

See OpenReq project contribution Guidlines

License

Free use of this software is granted under the terms of the EPL version 2 (EPL2.0).

You can’t perform that action at this time.