debrupf2946 / b0bot

B0Bot - Bug Zero Twitter Bot

B0Bot - CyberSecurity News API

Setup

1. Install all necessary packages

pip install -r ./requirements.txt

2. Set up your MongoDB Atlas database

https://www.mongodb.com/atlas/database

3. Set up your OpenAI API account

https://platform.openai.com/docs/overview

4. Create .env file in the root directory

# ./env

# OpenAI
OPENAI_API_KEY='[Your OpenAI API Key here]'

# MongoDB Atlas
DB_PASSWORD='[Your database password here]'

5. Remember to replace the MongoDB connection string

# Example
client = MongoClient(f"mongodb+srv://b0bot:{DB_PASSWORD}@cluster0.zqgexb4.mongodb.net/") # Replace the string with yours

6. Enrich/Update news data into your database

Run ./db_update/Update.py as a worker on a cloud service (e.g. heroku). Or, run ./db_update/Update.py manually in local.

7. Run the flask app

flask --app app.py run

8. Two available url paths

/news
/news_keywords?keywords=[Place news keywords here]

In this project, our objective is to develop a CyberSecurity News API tailored for automated bots on social media platforms.

It is a cutting-edge Flask-based API that grants seamless access to the latest cybersecurity and hacker news. Users can effortlessly retrieve news articles either through specific keywords or without, streamlining the information acquisition process.

Once a user requests our API, it retrieves news data from our knowledge base and feeds it to ChatGPT. After ChatGPT processes the data, the API obtains the response and returns it in JSON format.

High-Level Architecture Diagram

Our API lives inside a Flask API and is powered by LangChain and OpenAI API.

In addition, to keep the knowledge base of news up to date, a scheduled script will be executed on a regular interval to retrieve the most recent cybersecurity news by scraping a list of target news websites and store them into the MongoDB Atlas Database. Everytime a user requests the API, news in the database will be read into LangChain's memory and fed to the LLM of OpenAI. Then, answers will be generated based on both OpenAI model and our knowledge base.

The API will continuely run as a serverless function (hosted on Render) and it will record a successfull operation in a monitoring dashboard set up in Better Uptime.