Командный проект по курсу «Профессиональная работа с Python»

VKinder

Цель проекта

Цель командного проекта — разработать программу-бота для взаимодействия с базами данных социальной сети. Бот будет предлагать различные варианты людей для знакомств в социальной сети ВКонтакте в виде диалога с пользователем.

Вам предстоит:

• разработать программу-бота на Python,
• спроектировать и реализовать базу данных (БД) для программы,
• настроить взаимодействие бота с ВКонтакте,
• написать документацию по использованию программы.

В результате выполнения этого задания вы:

• получите практический опыт работы в команде;
• прокачаете навыки коммуникации и умение выполнять задачи в срок;
• закрепите навыки работы с GitHub и программирования на языке Python;
• разработаете с нуля полноценный программный продукт, который можно будет добавить в портфолио бэкенд-разработчика.

---

Чеклист готовности к работе над проектом

1. Изучили «Инструкцию по выполнению командного проекта» и «Правила работы в команде» в личном кабинете.
2. Знаете, кто с вами в команде.
3. Познакомились со своей командой и определились, каким способом будете общаться: переписка в любом мессенджере, видеозвонки.
4. Договорились, кто будет размещать общий репозиторий проекта и отправлять его на проверку.
5. У вас установлен Python 3.x и любая IDE. Мы рекомендуем работать с Pycharm.
6. Компьютер настроен для работы с БД PostgreSQL.
7. Установлен git и создан аккаунт на GitHub.
8. Создана группа в ВКонтакте, от имени которой будет общаться разрабатываемый бот. Получен токен для группы. Инструкцию можно посмотреть здесь.

Если все этапы чеклиста пройдены, можно стартовать работу над проектом. Успехов в работе.

---

Инструменты / дополнительные материалы, которые пригодятся для выполнения задания

1. Python + IDE (Pycharm).
2. Git + GiHhub.
3. Postgre + PgAdmin.
4. ВКонтакте.

---

Инструкция для работы над проектом

Нужно разработать программу-бота, который выполняет действия:

1. Используя информацию (возраст, пол, город) о пользователе, который общается с ботом в ВКонтакте, сделать поиск других пользователей ВКонтакте для знакомств.
2. У тех людей, которые подошли под критерии поиска, получить три самые популярные фотографии в профиле. Популярность определяется по количеству лайков.
3. Выводить в чат с ботом информацию о пользователе в формате:

- имя и фамилия,
- ссылка на профиль,
- три фотографии в виде attachment(https://dev.vk.com/method/messages.send).

4. Должна быть возможность перейти к следующему человеку с помощью команды или кнопки.
5. Сохранить пользователя в список избранных.
6. Вывести список избранных людей.

Обратите внимание: инструкция для получения токена для ВК находится в вашем личном кабинете в итоговом блоке по модулю.

---

Roadmap и распределение задач в команде

Работа над проектом рассчитана на 10 дней для команды из 2-3 человек. Для планирования времени рекомендуем опираться на roadmap. Придерживайтесь следующего деления проекта на этапы и задачи участников.

1. Вариант для команды из 2 участников

Roadmap:

1 этап:

1. Участник А. Создайте общий репозиторий на GitHub. Для предоставления доступа другим участникам нужно зайти в Settings репозитория проекта, найти раздел Collaborators, кликнуть по кнопке Add people, добавить ник напарника и выбрать роль Admin.
2. Участник Б. Спроектируйте БД. В БД должно быть создано минимум 3 таблицы.

2 этап:

1. Участник А. Разработайте взаимодействие с ВКонтакте для получения информации о пользователях и их фотографий. Можно использовать готовые библиотеки.
2. Участник Б. Реализуйте БД для программы с помощью PostgreDB. Приложите скрипты для создания таблиц, чтобы преподаватель смог создать у себя БД. Можно использовать ORM.

3 этап:

1. Участник А.

• Разработайте взаимодействие с ботом. Можно воспользоваться этим шаблоном. Будет плюсом, если вы добавите кнопки для более удобного взаимодействия с пользователем.
• Подготовьте проект к сдаче курсовой работы. Исправьте ошибки.

2. Участник Б.

• Реализуйте интеграцию бота и БД. Напишите документацию.
• Подготовьте проект к сдаче курсовой работы. Исправьте ошибки.

---

2. Вариант для команды из 3 участников

Roadmap:

1 этап:

1. Участник А. Создайте общий репозиторий на GitHub. Для предоставления доступа другим участникам нужно зайти в Settings репозитория проекта, найти раздел Collaborators, кликнуть по кнопке Add people, добавить ник напарника и выбрать роль Admin.
2. Участник Б. Спроектируйте БД. В БД должно быть создано минимум 3 таблицы.
3. Участник B. Разработайте взаимодействие с ВКонтакте для получения информации о пользователях и их фотографий. Можно использовать готовые библиотеки.

2 этап:

1. Участник А. Разработайте взаимодействие с ботом. Можно воспользоваться этим шаблоном. Будет плюсом, если вы добавите кнопки для более удобного взаимодействия с пользователем.
2. Участник Б. Реализуйте БД для программы с помощью PostgreDB. Приложите скрипты для создания таблиц, чтобы преподаватель смог создать у себя БД. Можно использовать ORM.
3. Участник B. Реализуйте интеграцию бота и БД.

3 этап:

1. Участник A. Подготовьте проект к сдаче курсовой работы. Исправьте ошибки.
2. Участник Б. Подготовьте проект к сдаче курсовой работы. Исправьте ошибок.
3. Участник В. Напишите документацию.

---

Дополнительные требования к проекту (не обязательны для получения зачёта)

1. Получать токен от пользователя с нужными правами.
2. Добавлять человека в чёрный список, чтобы он больше не попадался при поиске, используя БД.
3. Создать кнопки в чате для взаимодействия с ботом.
4. Добавить возможность ставить/убирать лайк выбранной фотографии.
5. К списку фотографий из аватарок добавлять список фотографий, где отмечен пользователь.
6. В ВКонтакте максимальная выдача при поиске — 1 000 человек. Подумайте, как это ограничение можно обойти.
7. Можно усложнить поиск, добавив поиск по интересам. Разбор похожих интересов — группы, книги, музыка — нужно будет провести с помощью анализа текста.
8. У каждого критерия поиска должны быть свои веса, то есть совпадение по возрасту должно быть важнее общих групп, интересы по музыке — важнее книг, наличие общих друзей — важнее возраста и т. д.

---

Правила сдачи работы

• разработан бот, и все части кода объединены в главной ветке (master/main);
• один из участников команды добавил ссылку на публичный репозиторий в личном кабинете в поле «Ссылка на решение» и в поле «Отправить на проверку эксперту» проставил галочку.

---

Критерии оценки

Зачёт по разработанному проекту ставится, если созданный программный продукт соответствует критериям:

1. Отсутствуют ошибки (traceback) во время выполнения программы.
2. Результат программы записывается в БД. Количество таблиц должно быть не меньше трёх. Приложена схема БД.
3. Программа добавляет человека в избранный список, используя БД.
4. Программа декомпозирована на функции/классы/модули/пакеты.
5. Написана документация по использованию программы.
6. Код программы удовлетворяет PEP8. Перед отправкой решения на проверку проверьте код с помощью линтеров.

Зачёт ставится всем студентам-участникам команды при выполнении всех требований командного проекта.