Skip to content

Latest commit

 

History

History
86 lines (76 loc) · 2.82 KB

README.md

File metadata and controls

86 lines (76 loc) · 2.82 KB
Raw

X-Bot: Twitter Automation Bot

Description

X-Bot is a Twitter automation bot that posts promotional tweets using data stored in Firebase, generates text with AI via Groq Cloud, and sends notifications via SMS with the Twilio API.

Features

  • Retrieves the current index for the post.
  • Fetches product information from Firebase.
  • Generates promotional text using Groq Cloud.
  • Posts the text on Twitter.
  • Updates Firebase with the post status.
  • Sends SMS notifications via Twilio.

Prerequisites

  • Python 3.8+
  • Firebase account
  • Twilio account
  • Groq Cloud account
  • Twitter Developer account

Installation

  1. Clone the repository: 
    git clone https://github.com/devgabrielsborges/X-Bot.git
cd X-Bot
  2. Create and activate a virtual environment: 
    python -m venv venv
source venv/bin/activate  # For Linux/MacOS
venv\Scripts\activate  # For Windows
  3. Install the dependencies: 
    pip install -r requirements.txt
  4. Create a .env file in the root directory with the following variables: 
    x_apikey=YOUR_TWITTER_API_KEY
x_apisecret=YOUR_TWITTER_API_SECRET
x_token=YOUR_TWITTER_ACCESS_TOKEN
x_tokensecret=YOUR_TWITTER_ACCESS_TOKEN_SECRET
x_bearertoken=YOUR_TWITTER_BEARER_TOKEN
twilio_sid=YOUR_TWILIO_SID
twilio_token=YOUR_TWILIO_AUTH_TOKEN
number_from=YOUR_TWILIO_PHONE_NUMBER
number_to=YOUR_PHONE_NUMBER
firebase_api_key=YOUR_FIREBASE_API_KEY
firebase_db_url=YOUR_FIREBASE_DB_URL

Running the Bot

  1. Ensure the initial index is correctly set in Firebase under actual_index.
  2. Run the main script: 
    python main.py

File Structure

  • classes.py: Contains all auxiliary classes and methods used by the main script.
    • FirebaseAPI: Class for Firebase operations.
    • TwilioAPI: Class for Twilio API operations.
    • GroqCloud: Class for Groq Cloud operations.
    • Product: Class representing the product and its information.
  • main.py: Main script that runs the complete automation.

Dependencies

  • firebase-admin: For interacting with Firebase.
  • pytz: For timezone manipulation.
  • requests: For HTTP requests.
  • tweepy: For interacting with the Twitter API.
  • python-dotenv: For loading environment variables from a .env file.
  • twilio: For sending SMS via Twilio.
  • langchain_core and langchain_groq: For integration with Groq Cloud.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

  1. Fork the project.
  2. Create a new branch (git checkout -b feature/new-feature).
  3. Commit your changes (git commit -am 'Add new feature').
  4. Push to the branch (git push origin feature/new-feature).
  5. Create a new Pull Request.

For questions or issues, please open an issue in this repository.