Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 2.2 KB

README.md

File metadata and controls

45 lines (34 loc) · 2.2 KB
Raw

Twitter NLP Library

Project Overview:

This project utilizes the Twitter API to search tweets based on user-provided criteria with the option to run various Natural Language Processing (NLP) scripts against. The search query is limited to tweets from the past seven days, based on developer account permitted use. The following NLP capabilities currently exist in this repository:

  • Sentiment Analysis: calculates the average sentiment of tweets and breaks down into positive, negative, neutral, and compound scores metrics. Provides plot and table to summarize the output of a given keyword.
  • Word Cloud: creates a word cloud of frequently used words in a collection of tweets for a given keyword.

Getting Started:

  1. create a '.env' file in the main directory
    1. create a BEARER_TOKEN variable with your associated bearer token from twitter dev account
    2. Template: BEARER_TOKEN=''
      1. Note - .env requires line 2 to be a whitespace line
  2. In a bash terminal run 'source ./setup.sh' to install all dependencies

Running the Script(s) with a Custom Query:

  1. edit the parameters in config.ini to specify the tweet parameters for one or two queries
    1. The 'keyword' for QUERY 1 is required - this value can be a word, a hashtag or a longer phrase
      1. Values should not include quotes (single or double)
    2. The 'keyword' for QUERY 2 is optional - if not specified, the script will only run the first keyword query
    3. the 'language' for PARAMETERS only supports english at this time (lang:en) and will be used for all queries
    4. the 'num_tweets' for PARAMETERS is the number of tweets you would like to retrieve for each query, this is used for all queries
    5. Be sure to save config.ini (see below for example configuration)
  2. in a bash terminal, the following scripts can be run to execute different NLP tasks: python analyze_sentiment.py python create_word_cloud.py

Unit Testing, Coverage, etc.

The following commands can be run for local unit testing and code coverage: python -m pytest python -m pytest --cov=helpers

Example config.ini Inputs:

[QUERY 1]

keyword = #LIVTour

[QUERY 2]

keyword = #PGATour

[PARAMETERS]

language = lang:en

num_tweets = 1000