This is a draft geenrated by ChatGPT. Tkae lightly haha
π©π½βπ» A chatbot that seamlessly integrates TeamDynamix, OpenAI, and Slack to streamline ticket management for the University of Michigan Biomedical Engineering IT Department.
- 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.
- Python 3.7 or higher
- Slack Workspace with bot permissions
- TeamDynamix API credentials
- OpenAI API key
-
Clone the repository:
git clone https://github.com/your-username/bme-it-slackbot.git cd bme-it-slackbot
-
Create a virtual environment (optional but recommended):
python3 -m venv venv source venv/bin/activate # On Windows, use `venv\Scripts\activate`
-
Install dependencies:
pip install -r requirements.txt
-
Configure the environment variables (see 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
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
.
- 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.
We welcome contributions! Please follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature
- Commit your changes and push:
git commit -m "Add your feature description" git push origin feature/your-feature
- Open a Pull Request.
This project is licensed under the MIT License. See the LICENSE file for details.
For questions or support, please reach out to the Biomedical Engineering IT Department at [email protected]
.
- Removed Node.js references: Updated the prerequisites and installation steps for Python.
- Slack Python SDK setup: Adjusted the configuration and startup instructions for a Python project.
- Simplified startup command:
python bot.py
instead of Node commands. - Virtual environment: Added optional virtual environment setup to ensure dependency isolation.
Let me know if further tweaks are needed!