A Twitter stream analyzer
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

A tool to perform sentiment analysis (positive, negative, neutral) on a live Twitter stream, filtered by language and keywords.

To build this program, we are using the Twitter API to pull in a stream of tweets which are placed in a queue to be processed. The list of tweets is processed by the deep learning model that has been fine tuned on sentiment classification. The tweet ID is then given an associated sentiment prediction that is output to the stream. The overall sentiment is held in a histogram to show the user the normal sentiment over the stream.

(back to top)

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Read through this README to find all relevant information and locations of other guides to get started.

Installation

Follow the steps listed in the installation guide

(back to top)

Usage

Examples and descriptions of how the project can be used are available at the project overview.

(back to top)

Roadmap

• Iteration 1: Display Twitter stream
• Iteration 2: Overall sentiment on stream
• Iteration 3: Filter Twitter stream by language
• Iteration 4: Filter stream by keyword
• Iteration 5: Single sentiment Analysis
• Iteration 6: Filter stream by topic
• Iteration 7: Bot detection

See the full future roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

See detailed instructions here

(back to top)

License

Distributed under the GNU GPL-3.0 License. See LICENSE for more information.

(back to top)

Contact

For reporting a conduct issue, see the Enforcement section of our code of conduct

Project Link: https://github.com/joshuam1008/media-analyzer

(back to top)

Acknowledgments

• README is based off of this template

(back to top)