Social Popularity Indication Service

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.

Technical description

What does the service do

This service fetches tweets from Twitter related to a given set of requirements and computes a social popularity indication value reflecting the relevance of the requirements for the crowds for each requirement. The underlying approach extracts relevant nouns from the title and description text of each requirement and these nouns are then used to be compared with all words which occur in the tweets.

Which technologies are used

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/)
• Requests (-> http://docs.python-requests.org/en/master/)
• Requests-OAuthlib (-> https://github.com/requests/requests-oauthlib)
• TwitterAPI (-> https://github.com/geduldig/TwitterAPI)
• urllib3 (-> https://github.com/urllib3/urllib3)
• 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/)

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 9005:9005 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:9005/v1/ui/

The Swagger definition lives here:

http://217.172.12.199:9005/v1/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).