Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thesuncatcher222/detective_announcer_bot

Your assistant detective
https://github.com/thesuncatcher222/detective_announcer_bot

python python3 telegram-bot telegram-bot-api vk vk-api vkontakte vkontakte-api

Last synced: 15 days ago
JSON representation

Your assistant detective

Host: GitHub
URL: https://github.com/thesuncatcher222/detective_announcer_bot
Owner: TheSuncatcher222
License: mit
Created: 2023-02-01T14:26:32.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-04-09T19:39:56.000Z (7 months ago)
Last Synced: 2024-10-10T18:21:25.366Z (about 1 month ago)
Topics: python, python3, telegram-bot, telegram-bot-api, vk, vk-api, vkontakte, vkontakte-api
Language: Python
Homepage:
Size: 6.3 MB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# __Detective Announcer Bot__ 🕵

Бот, предназначен для пересылки записей со стены сообщества [Alibi](https://vk.com/alibigames) и [Detectit](https://vk.com/detectitspb) в выбранный телеграм чат/канал, создания более удобной системы опросов выбора игрового дня, чем это может предложить Telegram, а также ведения в чате истории побед команды.
___
### Возможности
💨 Мгновенная пересылка новых записей со стены VK в телеграм чат.

🚨 Получение уведомления в телеграм чате от организации об успешной регистрации команды на игре.

📈 Сохранение истории побед (для игр, в которых команда заняла 1-5 место).

🙋‍♀️ Автоматическое создание наглядного сообщения-опроса с кнопками, содержащего вакантные игровые даты предстоящей игры с подробной информацией.

![buttons_preview](https://github.com/TheSuncatcher222/detective_announcer_bot/assets/36377190/b0da3621-b443-491f-bcb7-bf053a4c2aab)

___
### Технологии

[Python] - целевой язык программирования.

![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)

[Telegram API] - набор готовых классов, процедур, функций, структур и констант, предоставляемых социальной сетью Telegram, которые позволяют взаимодействовать с ее базой данных с помощью http-запросов.

![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white)

[VK API] - набор готовых классов, процедур, функций, структур и констант, предоставляемых социальной сетью VK (ВКонтакте), которые позволяют взаимодействовать с ее базой данных с помощью http-запросов.

![Вконтакте](https://img.shields.io/badge/вконтакте-%232E87FB.svg?&style=for-the-badge&logo=vk&logoColor=white)
___

### Установка

✅ Создать телеграм-бота согласно [официальной инструкции ](https://core.telegram.org/bots).

✅ Получить VK токен по [ссылке ](https://vkhost.github.io/)

_Стоит выбрать токен VK.com. Однако в случае возникновения ошибок (например, API VK: vk_api.exceptions.ApiError: [3] Unknown method passed) необходимо выбрать токен VK Admin._

✅ Перейти в целевую папку проекта и клонировать репозиторий
```sh
git clone https://github.com/TheSuncatcher222/Detective_Announcer_Bot.git
cd Detective_Announcer_Bot
```

✅ Создать виртуальное окружение

> Windows

```sh
python -3.9 -m venv venv
```

> Linux

```sh
python3 -m venv venv
```

> MacOS

```sh
brew link [email protected]
```

✅ Активировать виртуальное окружение

```sh
source venv/scripts/activate
```

✅ Обновить инсталлятор pip

```sh
python -m pip install --upgrade pip
```

✅ Установить зависимости из requirements.txt

```sh
pip install -r requirements.txt
```

✅ Перейти в папку с данными для подключения к API
```
cd project/data
```

✅ Переименовать файл .env.example в .env и заполнить его согласно примеру

```
# Нижеуказанный код приведен для консоли Bash:
mv .env.example .env
nano .env
```

✅ Вернуться в корневую папку и запустить сервер

```sh
cd ../..
python main.py
```
___
### Лицензия

MIT
**Free Software, Hell Yeah!**

Created by [TheSuncatcher222](https://github.com/TheSuncatcher222)

Данный бот __не является__ официальным!

[Alibi]:
[Python]:
[VK API]:
[Telegram API]: