Skip to content
/ finch Public

Multi-lingual tweet entities and tweet sentiment extractor using aws comprehend 🐦 πŸ“– 🐦

License

Notifications You must be signed in to change notification settings

YashMeh/finch

Repository files navigation

Finch

Finch is a multi-lingual tweet parsing tool which gives the entities involved in the tweet and the sentiment of the tweet,in addition to all the information provided by the Twitter-API.

T Image Size C Image Size GitHub Build

Languages Supported

Hindi, English, Korean, Chinese, German, Italian, French, Arabic

Architecture πŸ—οΈ

Finch Arch

How to setup πŸ’»

Twitter keys πŸ”‘

  • Make a developers account on twitter and get the access keys and secret tokens for your app.

AWS keys πŸ”‘

  • Create a programmatic user using IAM
  • Give the user read/write access to the comprehend service

How to run πŸƒ

There are 2 methods to run the project

  1. Using Docker (Easiest) 🐳
  • Just edit the docker-compose.yml file and add the required keys.

  • The images are auto-built and can be found at Docker Hub

  1. Individual Setup πŸ§”
  • Download and install the NATS server, mongoDB and nodeJS (v>=8.x).

  • Install dependencies inside comprehend-service and twitter-service using npm install.

  • Add a .env file to the services and add your keys and configurations.

  • .env for twitter-service

NATS_URL=
CONSUMER_KEY=
CONSUMER_SECRET=
ACCESS_TOKEN=
ACCESS_TOKEN_SECRET=
TAG=<single-tag-you-want-to-follow>

  • .env for comprehend-service
NATS_URL=
ACCESS_KEY=
SECRET_ACCESS=
  • Run using node <filename>.js

  • Checkout the database at http://localhost:5000/api/v1

  • By default,all your previous tag data is saved in a DB volume named finch_data-db. Thus, in case you want to start from a fresh DB

  • Delete the volume using

docker volume rm finch_data-db -f

Output

Finch Arch

Work Left πŸ‘¨β€πŸ­

  • Add exhaustive tests

  • Build a GUI to convert this to a CRM tool.

Finch fetches the tag given in the .env file every 5 minutes and updates the database

Stargazers over time

Stargazers over time

Yash Mehrotra

GitHub followers Twitter URL


if(repo.isAwesome || repo.isHelpful){
    StarRepo();
}

About

Multi-lingual tweet entities and tweet sentiment extractor using aws comprehend 🐦 πŸ“– 🐦

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •