README.md

# Slack Bot Assistant 🚀

A powerful, enterprise-grade Slack bot designed for team collaboration, productivity automation, and AI assistance with advanced features.

## 🌟 Key Features

### Core Features
- **AI Assistance**: Get instant answers and task management help with adaptive personalities
- **Advanced Sentiment Analysis**: VADER-powered sentiment detection (URGENT/POSITIVE/NEGATIVE/NEUTRAL)
- **Adaptive Personalities**: Switch between Professional, Casual, Technical, Friendly, and Formal AI modes
- **Multi-language Support**: English, Hindi, Spanish, French, German (expandable)
- **Workflow Automation**: Custom shortcuts and slash commands for daily tasks

### Advanced Task Management
- **Task Creation & Tracking**: Full CRUD operations for tasks with priorities and due dates
- **Task Lists**: View and filter tasks by status (pending, in_progress, completed)
- **Priority System**: Low, Medium, High, and Urgent priority levels
- **Due Date Management**: Flexible date parsing (relative and absolute dates)

### Productivity Tools
- **Smart Reminders**: Scheduled reminders with natural language time parsing
- **Meeting Summaries**: AI-powered summaries from channel conversations
- **Standup Templates**: Quick standup format generation
- **Poll Creation**: Interactive polls for team decisions

### Analytics & Insights
- **Channel Analytics**: Comprehensive channel health reports
- **Sentiment Tracking**: Historical sentiment analysis data
- **Command Analytics**: Usage statistics and patterns
- **Real-time Dashboard**: Live metrics and visualizations

### Database Integration
- **SQLite/PostgreSQL Support**: Flexible database backend
- **User Preferences**: Persistent user settings and configurations
- **Data Persistence**: All reminders, tasks, and summaries saved
- **Analytics Storage**: Command history and sentiment data

### External Integrations
- **Weather API**: Get weather information (OpenWeatherMap)
- **Translation APIs**: Multi-language support (expandable)

## 🛠️ Technologies

### Backend
- **Python 3.8+**
- **Slack Bolt Framework** - Official Slack SDK
- **SQLAlchemy** - Database ORM
- **VADER Sentiment** - Advanced sentiment analysis
- **Requests** - HTTP client for API integrations

### Frontend (Dashboard)
- **HTML5/CSS3** - Modern, responsive design
- **Chart.js** - Interactive data visualization
- **Font Awesome** - Icon library

## 🚀 Quick Start

### Prerequisites
- Python 3.8 or higher
- Slack Workspace with Admin permissions
- Slack App created at [api.slack.com/apps](https://api.slack.com/apps)

### Installation

1. **Clone the repository**
```bash
git clone <repository-url>
cd slack-bot-assistant
```

2. **Create virtual environment**
```bash
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
```

3. **Install dependencies**
```bash
pip install -r requirements.txt
```

4. **Configure environment variables**
```bash
cp .env.example .env
# Edit .env with your Slack credentials
```

5. **Set up Slack App**
- Go to [api.slack.com/apps](https://api.slack.com/apps)
- Create a new app or use existing one
- Enable Socket Mode
- Add required OAuth scopes (see SETUP.md for details)
- Install app to your workspace
- Copy tokens to `.env` file

6. **Run the bot**
```bash
python bot/app.py
```

For detailed setup instructions, see [SETUP.md](SETUP.md).

## 📋 Available Commands

### Basic Commands
- `/help` - Show all available commands
- `/bot-settings` - Configure bot personality and language preferences

### Task Management
- `/task-create <title> | <description> | <priority> | <due_date>` - Create a new task
- Example: `/task-create Fix login bug | Update authentication logic | high | tomorrow 5pm`
- `/task-list` - List your active tasks with filters

### Productivity
- `/set-reminder <message> | <time>` - Set a smart reminder
- Example: `/set-reminder Team meeting | in 2 hours`
- Supports: "in X hours/days", "tomorrow 10am", ISO dates
- `/summarize-meeting` - Generate meeting summary from recent channel messages
- `/standup` - Get daily standup template

### Team Collaboration
- `/manage-channel` - Get comprehensive channel analytics and management report
- `/poll <question> | <option1> | <option2> | ...` - Create interactive polls
- Example: `/poll Best meeting time? | 9am | 2pm | 5pm`

### Utilities
- `/weather <location>` - Get weather information (requires OpenWeather API key)
- Example: `/weather New York`
- `/quote` - Get a random motivational quote
- `/random` - Generate random number or choose from options
- Example: `/random` (1-100) or `/random 1-50` or `/random option1, option2, option3`
- `/translate <text> | <language>` - Translate text (basic, expandable with API)
- Example: `/translate Hello | Hindi`
- `/note <text>` - Create and save a quick note
- Example: `/note Remember to update docs tomorrow`

### Mentions
Mention `@BotAssistant` in any channel for AI-powered assistance with contextual responses!

## 🏗️ Project Structure

```
slack-bot-assistant/
├── bot/
│ ├── app.py # Main bot application with all handlers
│ ├── config.py # Centralized configuration management
│ ├── models.py # Database models and schema
│ ├── utils.py # Utility functions (sentiment, formatting, etc.)
│ ├── helpers.py # Additional helper functions
│ └── scheduler.py # Advanced task scheduling system
├── demo.html # Advanced analytics dashboard
├── index.html # Landing page
├── run.py # Main entry point script
├── requirements.txt # Python dependencies
├── SETUP.md # Detailed setup guide
├── FEATURES.md # Comprehensive feature list
├── CHANGELOG.md # Version history and changes
├── .env.example # Environment variables template
├── .gitignore # Git ignore file
└── README.md # This file
```

## ⚙️ Configuration

### Environment Variables

| Variable | Required | Description |
|----------|----------|-------------|
| `SLACK_BOT_TOKEN` | Yes | Bot User OAuth Token from Slack |
| `SLACK_SIGNING_SECRET` | Yes | Signing Secret from Slack |
| `SLACK_APP_TOKEN` | Yes | App-Level Token for Socket Mode |
| `OPENWEATHER_API_KEY` | No | For weather command (get from openweathermap.org) |
| `DATABASE_URL` | No | Database connection string (default: SQLite) |
| `LOG_LEVEL` | No | Logging level (DEBUG, INFO, WARNING, ERROR) |

### Feature Configuration

Edit `bot/config.py` to customize:
- Default personality and language
- Supported languages and personalities
- Feature flags (database, scheduling, etc.)
- Reminder settings and limits
- Meeting summary parameters

## 📊 Database Schema

The bot uses SQLite by default (configurable for PostgreSQL, MySQL, etc.):

- **user_configs** - User preferences (personality, language, timezone)
- **reminders** - Scheduled reminders with timestamps
- **tasks** - Task management with priorities and due dates
- **meeting_summaries** - Generated meeting summaries
- **message_sentiments** - Sentiment analysis data for analytics
- **command_history** - Command usage analytics
- **polls** - Poll data and votes

## 🔧 Advanced Features

### Scheduled Reminders
- Background thread checks reminders every 60 seconds (configurable)
- Automatic delivery when reminder time is reached
- Supports up to 50 active reminders per user (configurable)
- Natural language time parsing

### Sentiment Analysis
- VADER sentiment analyzer for accurate sentiment detection
- Falls back to keyword-based analysis if VADER unavailable
- Tracks sentiment scores and confidence levels
- Stores historical sentiment data for analytics

### Task Management
- Full CRUD operations
- Priority levels: Low, Medium, High, Urgent
- Status tracking: Pending, In Progress, Completed, Cancelled
- Flexible due date parsing
- Task filtering and listing

### Meeting Summaries
- Analyzes recent channel messages (configurable count)
- Extracts key topics and action items
- Identifies participants and message volume
- Stores summaries in database for reference

## 📈 Dashboard Features

The demo dashboard (`demo.html`) includes:
- Real-time statistics and metrics
- Interactive charts (trends, sentiment, command usage)
- Channel activity heatmap
- Task management interface
- Live bot logs simulation
- Responsive design

## 🐛 Troubleshooting

### Common Issues

**Bot not responding**
- Verify tokens in `.env` file
- Check Socket Mode is enabled in Slack app settings
- Review bot logs for errors

**Database errors**
- Ensure database file permissions
- Check database URL format
- Delete `bot_data.db` to reset (development only)

**Commands not working**
- Verify commands are registered in Slack app
- Check OAuth scopes/permissions
- Review bot logs for error messages

For more troubleshooting tips, see [SETUP.md](SETUP.md).

## 🤝 Contributing

This is a proprietary project by RSK World. For inquiries about contributions or licensing, please contact us.

## 👨‍💻 Developer Details

- **Founder & Lead Developer**: Molla Samser (RSK World)
- **Design & Testing**: Rima Khatun
- **Website**: [rskworld.in](https://rskworld.in)
- **Contact**: hello@rskworld.in | +91 93305 39277
- **Year**: 2026

## 📄 License

© 2026 RSK World. All rights reserved.

## 🔗 Resources

- [Slack API Documentation](https://api.slack.com/)
- [Slack Bolt Framework](https://slack.dev/bolt-python/)
- [SQLAlchemy Documentation](https://docs.sqlalchemy.org/)
- [VADER Sentiment](https://github.com/cjhutto/vaderSentiment)

---

**Made with ❤️ by RSK World**