Table of Contents

• 🎴 Клиент для ведения статистики клана в AniCard
• 📦 Возможности
• 💽 Установка и использование
• ⬇️ Загрузка проекта
• 📄 Подготовка файла конфигурации
• 🐦‍🔥 Настройка виртуального окружения и загрузка библиотек
• ▶️ Первый запуск
• 🧤 Systemd
• 📑 TODO
• 💼 Используемые библиотеки

🎴 Клиент для ведения статистики клана в AniCard

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

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

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

⬇️ Загрузка проекта

Первым делом необходимо скачать приложение.

# Скачиваем приложение и переходим в скачанную директорию
git clone https://git.a2s.su/AniCard/ClanStat.git
cd ClanStat

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

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

# Копируем файл с примером конфигурации
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 — Пароль пользователя

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

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

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

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

pip3 install -r requirements.txt

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

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

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 — Форматирование кода
• pdoc — Генератор документации Python кода