---
gitea: none
include_toc: true
---

# 🎴 Бот для ведения статистики клана в AniCard

<img src="https://git.a2s.su/AniCard/ClanStat/raw/branch/master/assets/icon.png" alt="Иконка" height="512">

## 📦 Возможности

- [ ] Сохранение статистики побед в КВ членов клана
- [ ] Сохранение статистики пожертвований в сокровищницу членов клана


## 💽 Установка и использование

### 📄 Подготовка файла конфигурации

Настройки приложения хранится в файле `.env`.
Пример файла с настройками называется `env.example`.

```sh
cp env.example .env
```

Разбор файла настроек:

- `APP_ID`  — Идентификатор приложения Telegram.
- `APP_HASH` — Хэш  приложения Telegram.
- `ACCOUNT` — Имя аккаунта пользователя Telegram (_например `db_o_qp`_).
- `LOG_PATH` — Путь в файлу логов (_например `/tmp/test.log`_).
- `DB_HOST` — Хост базы данных PostgreSQL
- `DB_PORT` — Порт сервера базы данных
- `DB_NAME` — Имя базы данных
- `DB_USER` — Имя пользователя
- `DB_PASSWORD` — Пароль пользователя


### 🐦‍🔥 Настройка виртуального окружения и загрузка бибилотек

Создание и активация виртуального окружения.

```sh
python3 -m venv venv
. ./venv/bin/activate
```

Установка библиотек.

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


### ▶️ Первый запуск

В время первого запуска появится запрос данных авторизации от библиотеки `Pyrogram`.

```text
Welcome to Pyrogram (version 2.0.106)
Pyrogram is free software and comes with ABSOLUTELY NO WARRANTY. Licensed
under the terms of the GNU Lesser General Public License v3.0 (LGPL-3.0).

Enter phone number or bot token: 898********
Is "898********" correct? (y/N): y
The confirmation code has been sent via Telegram app
Enter confirmation code: 14628
```


### 🧤 Systemd

> ⚠️ В процессе написания...


# 📑 TODO

- [ ] Добавить уведомления, если что-то пошло не так


# 💼 Используемые библиотеки

- **Pyrogram** — Telegram клиент
- **python-dotenv** — Работа с `.env` файлами
- **loguru** — Логирование
- **psycopg2** — Работа с PostgreSQL
- **black** — Форматирование кода