Git Product home page Git Product logo

discord-helper-bot's Introduction

Discord Bot with Google Sheets Integration

This Discord bot allows users to set reminders, add events, manage work pauses, and update Google Sheets with job application information. The bot leverages gspread and oauth2client for Google Sheets integration and uses discord.py for interacting with Discord.

Features

  • /remind: Set a reminder at a specified time with a custom message.
  • /add_event: Schedule an event at a specified date and time.
  • /wp: Start and stop work-pause reminders.
  • /update: Immediately append job application information to a Google Sheet.

Requirements

  • Python 3.6+
  • A Discord bot token
  • Google Sheets API credentials
  • Required Python packages (listed in requirements.txt)

Setup

  1. Clone the repository:

    git clone https://github.com/your-username/your-repo-name.git
    cd your-repo-name
  2. Create a virtual environment and activate it:

    python -m venv venv
    source venv/bin/activate  # On Windows use `venv\Scripts\activate`
  3. Install the required packages:

    pip install -r requirements.txt
  4. Set up Google Sheets API credentials:

    • Follow the instructions to create a Google Cloud project and enable the Google Sheets API.
    • Create credentials for a service account and download the JSON key file.
    • Place the JSON key file in the src/constants directory and name it token.json.
  5. Create a .env file in the root directory of the project and add your credentials:

    BOT_TOKEN=your-discord-bot-token
    GOOGLE_SHEETS_CREDENTIALS_PATH=src/constants/token.json
    SHEET_NAME=Your Google Sheet Name
    WORKSHEET_NAME=Sheet1
  6. Run the bot:

    python app.py

Usage

  • /remind HH:MM Message: Set a reminder for a specified time with a custom message.

  • /add_event YYYY-MM-DD HH:MM Event: Schedule an event at a specified date and time.

  • /wp start {time in minutes}: Start work-pause reminders.

  • /wp end: End work-pause reminders.

  • /update JSON: Append job application information to a Google Sheet. Use backticks (`) around the JSON data to avoid issues with Discord command parsing.

    Example:

    /update `{"Name of Company": "Discord", "Job Title": "Engineer", "Job ID": "12345", "Link": "https://discord.com/careers", "Status": "Applied", "Location": "NY"}`
    

Images

Screenshot 2024-07-09 at 4 23 03 AM Screenshot 2024-07-09 at 4 21 37 AM Screenshot 2024-07-09 at 4 24 08 AM

Contributing

Feel free to fork the repository and submit pull requests. For major changes, please open an issue first to discuss what you would like to change.

License

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

discord-helper-bot's People

Contributors

darakhtech avatar

Watchers

Lucian avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.