Skip to content

πŸ‘©πŸ½β€πŸ’» A chat bot that seamlessly integrates TeamDynamix, OpenAI, and Slack to provide efficient ticket assistance for the University of Michigan Biomedical Engineering IT Department.

Notifications You must be signed in to change notification settings

ciaracade/bme-it-bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

This is a draft geenrated by ChatGPT. Tkae lightly haha

UMich Biomedical Engineering IT Dept Slack Bot

πŸ‘©πŸ½β€πŸ’» A chatbot that seamlessly integrates TeamDynamix, OpenAI, and Slack to streamline ticket management for the University of Michigan Biomedical Engineering IT Department.


πŸš€ Features

  • TeamDynamix Integration: Automatically fetch, create, and update tickets directly from Slack.
  • OpenAI-Powered Assistance: Smart suggestions and automated responses to common IT queries.
  • Slack Workflow Compatibility: Seamless integration with existing Slack channels and workflows.
  • Time-Saving: Reduces manual effort, allowing IT staff to focus on more critical tasks.

πŸ“– Table of Contents

  1. Getting Started
  2. Installation
  3. Usage
  4. Configuration
  5. Features in Depth
  6. Contributing
  7. License
  8. Contact

πŸ› οΈ Getting Started

Prerequisites

  • Python 3.7 or higher
  • Slack Workspace with bot permissions
  • TeamDynamix API credentials
  • OpenAI API key

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/bme-it-slackbot.git
    cd bme-it-slackbot
  2. Create a virtual environment (optional but recommended):

    python3 -m venv venv
    source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
  3. Install dependencies:

    pip install -r requirements.txt
  4. Configure the environment variables (see Configuration).


βš™οΈ Configuration

Create a .env file in the root directory with the following variables:

SLACK_BOT_TOKEN=your-slack-bot-token
SLACK_APP_TOKEN=your-slack-app-token
TEAMDYNAMIX_API_KEY=your-teamdynamix-api-key
OPENAI_API_KEY=your-openai-api-key

πŸ’» Usage

Start the bot with:

python bot.py

Once running, invite the bot to your desired Slack channel and start interacting with it using commands like /ticket create or /help.


πŸ“š Features in Depth

  • Ticket Creation: Use /ticket create to generate a new ticket in TeamDynamix.
  • Status Updates: Query ticket statuses with /ticket status <ticket_id>.
  • AI Responses: Get natural language answers to technical queries using OpenAI's API.
  • Custom Commands: Easily add custom commands for your department's unique workflows.

🀝 Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature/your-feature
  3. Commit your changes and push:
    git commit -m "Add your feature description"
    git push origin feature/your-feature
  4. Open a Pull Request.

πŸ“„ License

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


πŸ“¬ Contact

For questions or support, please reach out to the Biomedical Engineering IT Department at [email protected].


Key Changes:

  1. Removed Node.js references: Updated the prerequisites and installation steps for Python.
  2. Slack Python SDK setup: Adjusted the configuration and startup instructions for a Python project.
  3. Simplified startup command: python bot.py instead of Node commands.
  4. Virtual environment: Added optional virtual environment setup to ensure dependency isolation.

Let me know if further tweaks are needed!

About

πŸ‘©πŸ½β€πŸ’» A chat bot that seamlessly integrates TeamDynamix, OpenAI, and Slack to provide efficient ticket assistance for the University of Michigan Biomedical Engineering IT Department.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages