{"id":15134097,"url":"https://github.com/not-whale/vk_bot","last_synced_at":"2025-09-29T03:30:33.736Z","repository":{"id":42209734,"uuid":"465175888","full_name":"not-Whale/vk_bot","owner":"not-Whale","description":":coffee: :dollar: Бот для продажи энергетиков в студенческом общежитии","archived":true,"fork":false,"pushed_at":"2022-04-13T23:43:02.000Z","size":1461,"stargazers_count":3,"open_issues_count":13,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-24T06:28:42.462Z","etag":null,"topics":["bot","open-source","python3","vk","vk-api","vk-bot","vkontakte","vkontakte-api"],"latest_commit_sha":null,"homepage":"https://not-whale.github.io/vk_bot/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/not-Whale.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-02T05:56:01.000Z","updated_at":"2024-07-23T17:15:41.000Z","dependencies_parsed_at":"2022-08-12T09:41:21.186Z","dependency_job_id":null,"html_url":"https://github.com/not-Whale/vk_bot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/not-Whale%2Fvk_bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/not-Whale%2Fvk_bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/not-Whale%2Fvk_bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/not-Whale%2Fvk_bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/not-Whale","download_url":"https://codeload.github.com/not-Whale/vk_bot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234583683,"owners_count":18856280,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","open-source","python3","vk","vk-api","vk-bot","vkontakte","vkontakte-api"],"created_at":"2024-09-26T05:02:38.207Z","updated_at":"2025-09-29T03:30:28.090Z","avatar_url":"https://github.com/not-Whale.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"### vk_bot - бот для продажи энергетиков в студенческом общежитии!\n\u003cimg src=\"./src/resources/photos/main logo 250x250.png\" alt=\"logo\"/\u003e\n\n***\n### Немного истории\n*В конце февраля 2022 года* у двух моих хороших друзей родилась идея *продавать энергетики* в студенческом общежитии, чтобы сэкономить время других студентов на походе в магазин и дать возможность получить заряд кофеина даже ночью, когда все закрыто. \n\nВ этот момент в моей голове возникла идея помочь им с продвижением и реализовать свою давнюю маленькую **мечту** - написать бота для *сообщества vk*, который будет работать как интерактивное меню и автоматизировать обработку заявок (представим, что поток клиентов достаточно большой для того, чтобы отвечать всем самостоятельно).\n\nТак и появился *vk_bot*, актуальную версию которого вы можете видеть здесь!\n***\n### Описание\nВ репозитории представлен исходный код *бота для vkontakte*, который подключается к социальной сети путем авторизации как администратор (по логину и паролю) либо как сообщество (по ключу доступа). \n\nЕсть **два** типа взаимодействия с ботом в зависимости от роли пользователя. Все роли пользователей *определяются при инициализации* экземпляра класса бота и *сохраняются локально* для каждой копии проекта. \n\nИнтерфейс взаимодействия с ботом **для админов** представляет из себя одну главную клавиатуру, на которой пользователь может указать свой `on/offline` статус, изменить количество энерегтиков на руках в данный момент и отметить новую проведенную сделку. Также админу предоставляется возможность изучить свою *краткую статистику* по продажам с помощью той же основной клавиатуры. \n\nИнтерфейс взаимодействия с ботом **для покупателей** имеет 5 уровней вложенности с *различными* вариантами движения по нему в зависимости от потребностей пользователя. С помощью бота покупатель может ознакомиться со своей статистикой покупок, сделать новый заказ (выбрать количество энерегетиков, способ оплаты, получить данные продавца), оставить отзыв или связаться с разработчиком.\n\nВозможен случай, когда покупатель сделал заказ, но ни одного админа нет в сети, тогда каждому из находящихся в базе админов *отправляется оповещение* о том, что поступила новая заявка и её нужно обработать как можно скорее.\n***\n### Что будет дальше? \nВ бущем мы планируем *развивать* наш продукт, добавляя больше интересных, удобных и просто приятных фишек. Посмотреть краткосрочные задачи или оставить свои пожелания по развитию вы всегда можете [во вкладке issues](https://github.com/not-Whale/vk_bot/issues). Кроме того, особого внимание заслуживают следующие изменения:\n* Добавления стэка вызовов для ускорения движения по клавиатурам и оптимизации кода;\n* Добавления простейших алгоритмов удержания клиента: \n    * Скидочные программы для оптовых покупателей, \n    * Скидочные программы для постоянных покупателей, \n    * Специальные предложения для заинтересованных, но не решившихся;\n* Добавление ключей командной строки для запуска бота в различных режимах;\n* Создание интерактивной оболочки отправки команд боту для взаимодействия с функционалом суперпользователя без перезапуска скрипта;\n* Добавление к сообщениям бота милых **картинок с котиками и Дорой** для поднятия настроения покупателей и админов;\n***\n### Наша команда:\n* Резепин Никита [[@not-Whale](https://github.com/not-Whale)]: разработчик бота, тестировщик, не кит\n* Калита Никита [[@ontoshenka](https://github.com/ontoshenka)] : научный руководитель\n* Поляков Данила [[@qqqq4u](https://github.com/qqqq4u)] : автор задумки, идейный вдохновитель\n* Кравченко Данила [[@228Danila228](https://github.com/228Danila228)] : автор задумки, талисман команды\n* Уксусов Егор [[@egkssv](https://vk.com/egkssv)] : дизайнер логотипа\n***\n### Инструкция по установке и запуску:\n1. Склонируйте репозиторий в папку на персональном компьютере:  \n```\ngit clone https://github.com/not-Whale/vk_bot\n```\n2. Создайте в директории `src/main/bot` файл `open_keys.py`;\n3. Задайте в созданном файле следующие обязательные строковые переменные:\n    * SBERBANK_CARD_NUMBER - номер карты Сбербанк для оплаты;\n    * TINKOFF_CARD_NUMBER - номер карты Тинькофф для оплаты;\n    * TELEPHONE_FOR_PAYMENT - номер телефона для переводов;\n    * PAY_URL - ссылка на перевод через платежную систему (мы использовали платежи Тинькофф);\n    * VK_TOKEN - токен для авторизации в качестве сообщества;\n    * VK_LOGIN - логин админа (если авторизация планируется не через токен);\n    * VK_PASSWORD - пароль админа (если авторизация планируется не через токен);\n    * FEEDBACK_URL - ссылка на отзывы (подразумевается возможность оставить свой отзыв);\n4. При необходимости в файл `src/main/main.py` добавьте строку:  \n```\nbot.add_new_admin(Admin(%user_id%, %room_number%, ...))\n```\nС полный списком параметров и описанием работы каждой функции бота можно ознакомиться, обратившись к [документации](https://not-whale.github.io/vk_bot/);  \n\n5. Установите любую версию python 3.x.x c [официального сайта](https://www.python.org/downloads/), если она еще не установлена;\n6. Запустите скрипт бота:  \n```\npython src/main/main.py\n```\n7. Переходите в личные сообщения сообщества Вконтакте;\n8. Готово!\n***\n### Интересно прочитать\nВ процессе разработки я пользовался следующими *информационными* ресурсами:\n* [Vk_api](https://github.com/python273/vk_api) для python и их [документацией](https://vk-api.readthedocs.io/en/latest/);\n* [Документацией](https://vk.com/dev/methods) API от Вконтакте;\n* [Мотивационной статьей](https://habr.com/ru/post/427691/) на Хабре;\n* [Документацией](https://sphinx-ru.readthedocs.io/ru/latest/sphinx.html) Sphinx.\n\nА также стандартами оформления кода и документации, поиск которых оставим в качестве домашнего задания!\n***\n### Связь с разработчиками\nВ случае, если у вас есть *интересные идеи* по дальнейшему развитию и применению проекта или вам хочется лично обсудить вопросы, связанные с этим или другими проектами, **напишите мне** на почту, указанную в профиле, либо свяжитесь со мной в социальных сетях: [вконтакте](https://vk.com/rezepinn) или [телеграмм](https://t.me/rezepinn).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnot-whale%2Fvk_bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnot-whale%2Fvk_bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnot-whale%2Fvk_bot/lists"}