Readme

README.md

@@ -0,0 +1,163 @@
+---
+title: Jira Ai Assistant
+emoji: 📚
+colorFrom: indigo
+colorTo: pink
+sdk: gradio
+sdk_version: 5.19.0
+app_file: app.py
+pinned: false
+---
+
+# Jira AI Assistant
+
+Додаток на основі Gradio для аналізу даних Jira з використанням AI.
+
+## Опис
+
+Jira AI Assistant - це інструмент для аналізу даних Jira, який дозволяє:
+- Завантажувати дані з CSV-файлів або напряму через Jira API
+- Генерувати статистику та візуалізації
+- Аналізувати дані за допомогою AI (OpenAI, Google Gemini)
+- Створювати звіти у різних форматах (Markdown, HTML, PDF)
+- Відправляти повідомлення у Slack
+
+## Встановлення
+
+1. Клонуйте репозиторій:
+```bash
+git clone https://github.com/your-username/jira-ai-assistant.git
+cd jira-ai-assistant
+```
+
+2. Встановіть залежності:
+```bash
+pip install -r requirements.txt
+```
+
+3. Створіть файл `.env` у корені проекту та додайте необхідні змінні середовища:
+```
+JIRA_URL=https://your-company.atlassian.net
+JIRA_USERNAME=your-email@example.com
+JIRA_API_TOKEN=your-api-token
+
+OPENAI_API_KEY=your-openai-api-key
+GEMINI_API_KEY=your-gemini-api-key
+
+SLACK_BOT_TOKEN=your-slack-bot-token
+```
+
+## Використання
+
+### Запуск додатку
+
+```bash
+python app.py
+```
+
+Додаток буде доступний за адресою: http://127.0.0.1:7860
+
+### Отримання даних
+
+Існує два способи отримання даних для аналізу:
+
+1. **Завантаження CSV-файлу**: На вкладці "CSV Аналіз" завантажте CSV-файл з експортованими даними Jira.
+
+2. **Використання Jira API**: На вкладці "Jira API" введіть URL Jira сервера, ім'я користувача та API токен, потім вкажіть ключ проекту та опціонально ID дошки.
+
+### Аналіз даних
+
+Після завантаження даних:
+
+1. Налаштуйте параметри аналізу (кількість днів неактивності тощо).
+2. За бажанням, додайте AI аналіз, вказавши API ключ OpenAI або Google Gemini.
+3. Натисніть кнопку "Аналізувати" для виконання аналізу.
+
+### Збереження звіту
+
+Після аналізу ви можете зберегти результати:
+
+1. Виберіть формат звіту (Markdown, HTML, PDF).
+2. За бажанням, додайте візуалізації у звіт.
+3. Натисніть кнопку "Зберегти звіт" для збереження результатів.
+
+## Розширені можливості
+
+### Інтеграція з Slack
+
+Ви можете надсилати звіти у Slack:
+
+1. На вкладці "Інтеграції" введіть назву каналу та текст повідомлення.
+2. Виберіть звіт для прикріплення (опціонально).
+3. Натисніть кнопку "Надіслати у Slack" для відправлення повідомлення.
+
+### AI Асистенти
+
+На вкладці "AI Асистенти" ви можете:
+
+1. Задавати питання щодо завантажених даних Jira.
+2. Отримувати відповіді та рекомендації від AI.
+3. Використовувати AI агентів для різних задач.
+
+## Структура проекту
+
+```
+jira-ai-assistant/
+├── app.py                  # Головний файл додатку
+├── config.py               # Конфігурація додатку
+├── requirements.txt        # Залежності
+├── README.md               # Цей файл
+├── assets/                 # Статичні ресурси
+├── data/                   # Директорія для зберігання даних
+├── reports/                # Директорія для зберігання звітів
+├── temp/                   # Тимчасові файли
+├── logs/                   # Логи додатку
+└── modules/                # Модулі додатку
+    ├── core/               # Ядро додатку
+    ├── data_import/        # Модуль імпорту даних
+    ├── data_analysis/      # Модуль аналізу даних
+    ├── ai_analysis/        # Модуль AI аналізу
+    ├── reporting/          # Модуль звітування
+    ├── integrations/       # Модуль інтегр��цій
+    └── rag/                # Модуль RAG
+```
+
+## Отримання API ключів
+
+### Jira API Token
+
+1. Увійдіть в [Atlassian Account](https://id.atlassian.com/manage-profile/security/api-tokens)
+2. Натисніть "Create API token"
+3. Дайте назву API токену та скопіюйте його
+
+### OpenAI API Key
+
+1. Увійдіть в [OpenAI Dashboard](https://platform.openai.com/account/api-keys)
+2. Натисніть "Create new secret key"
+3. Скопіюйте створений ключ
+
+### Google Gemini API Key
+
+1. Перейдіть на [Google AI Studio](https://makersuite.google.com/app/apikey)
+2. Створіть новий API ключ
+3. Скопіюйте створений ключ
+
+### Slack Bot Token
+
+1. Перейдіть на [Slack API](https://api.slack.com/apps)
+2. Створіть новий додаток
+3. Додайте OAuth scopes: chat:write, files:write
+4. Встановіть додаток у ваш робочий простір
+5. Скопіюйте Bot User OAuth Token
+
+## Внесення змін
+
+Якщо ви хочете розширити функціонал додатку, ви можете:
+
+1. Додати новий модуль у директорію `modules/`
+2. Оновити головний файл `app.py` для включення нового функціоналу
+3. Оновити файл `requirements.txt`, якщо потрібні нові залежності
+
+## Ліцензія
+
+Цей проект поширюється під ліцензією MIT.