Skip to content

README.md

Latest commit

 

History

History
108 lines (70 loc) · 2.7 KB

README.md

File metadata and controls

108 lines (70 loc) · 2.7 KB

Sentimental Analyser for Discor messages


Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing

About The Project

Discord bot performing sentiment analysis on messages and labeling them into 28 different categories and storing the results using Mongo-DB.

(back to top)

Built With

Remove any of these if they dont match your project, or add more if you need to.

  • Tensorflow
  • Disnake
  • Transformers
  • PyMongo
  • python-dotenv

(back to top)

Getting Started

Prerequisites

  • Docker

Installation

  1. Creat a free discord bot Discord developers portal to get a bot token
  2. Invite you new bot with admin permissions in your discord server
  3. Clone the repo 
    git clone https://github.com/vannsoko/SentimentAnalysisDiscordBot.git
  4. Renaming .env.exemple to .env
  5. Enter the needed env variables 
     BOT_TOKEN="EXAMPLE TOKEN REPLACE IN YOUR OWN ENV FILE"
 CHANNEL_ID="EXAMPLE CHANNEL ID REPLACE IN YOUR OWN ENV FILE" Ex: "123,456,678"

 MongoDBurl="EXEMPLE mongodb://localhost:27017/"
 DATABASE_NAME="EXAMPLE DATABASE NAME REPLACE IN YOUR OWN ENV FILE"
 COLLECTION_NAME="EXAMPLE COLLECTION NAME REPLACE IN YOUR OWN ENV FILE"

(back to top)

Contributing

  1. Find an issue or create one your self. If you have create the issue please make sure that it is relevant to the project.
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature). Please use the name of the issue in the branch name. or reference the issue id in the name.
  3. Do your changes and commit them (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request and wait for it to be merged

(back to top)