dbatalha/ScrappyTwitch

Twitch bot that gather information and store it in a DB.

ScrappyTwitch

ScrappyTwitch is a Python application that acts as a Twitch bot, gathering information about online streamers and storing it in a database.

Table of Contents

• Prerequisites
• Installation
• Configuration
• Usage
• Project Structure
• Contributing
• License

Prerequisites

• Python (>=3.12)
• Poetry
• Twitch API Client ID and Secret
• MongoDB

Installation

1. Clone the repository:

   git clone https://github.com/dbatalha/ScrappyTwitch.git
   cd ScrappyTwitch

2. Install project dependencies using Poetry:

   poetry install

Configuration

1. Obtain Twitch API credentials:

   • Register a new application on the Twitch Developer Portal.
   • Note the Client ID and Client Secret.

2. Configure the application:

   • Edit the file "scrappy_bot/resources/config.ini"":
   • Replace the {CLIENT_ID} with your application key and secret;

   [Twitch]
   client_id = {CLIENT_ID}
   client_secret = {CLIENT_SECRET}
   grant_type = client_credentials
   
   [Database]
   mongodb_connection = {CONNECTION}

Usage

Run the ScrappyTwitch application:

python start.py