BotListBot

Телеграмма @BotListBot

Это чат-бот, отвечающий за поддержку Telegram BotList, канала, который представляет собой управляемый сообществом подход к сбору лучших ботов в Telegram.

Бот упрощает навигацию, выступая в качестве зеркала BotList, и автоматизирует процесс отправки, проверки и публикации ботов сообществом BotListChat.

Этот репозиторий предназначен для вдохновения и технического руководства для разработчиков ботов, в основном для людей, использующих замечательную библиотеку python-telegram-bot.

JosXa/BotListBot лицензируется по лицензии MIT.

Руководство по установке

Предварительные требования

Обязательный

• Питон 3.7.x
• Экземпляр базы данных PostgreSQL или Docker (см. ниже).
• Pipenv установлен глобально ( pip install pipenv )
• Ваш собственный токен бота для локального развития

Необязательный

• Учетная запись sendry.io (ведение журнала)
• S3-совместимое объектное хранилище (например, Minio)

Настройка разработки

Использование кодовых пространств GitHub и VSCode ( рекомендуется )

Рекомендуется, поскольку это самый быстрый способ начать работу.

1. В кодовых пространствах GitHub введите « JosXa/BotListBot » и создайте свой контейнер разработки.
2. Измените переменные в template.env и сохраните файл как .env в корневой папке оформления заказа.
3. Запустите проект через pipenv run python -m botlistbot.main

Использование PyCharm...

Настройте экземпляр базы данных PostgreSQL с помощью Docker

1. Установить Докер
2. Запустите docker-compose up -d
3. Создайте и заполните базу данных с помощью pipenv run python scripts/initialize_database.py seed
4. Чтобы остановить базу данных, запустите docker-compose down

Настроить BotListBot

1. VCS -> Получить из контроля версий... -> https://github.com/JosXa/BotListBot (или ваша собственная вилка)
2. Добавьте новый интерпретатор проекта, используя Pipenv ( не virtualenv ), и позвольте PyCharm установить пакеты за вас.
3. Измените переменные в template.env и сохраните файл как .env в корневой папке.
4. Запустите файл scripts/initialize_database.py один раз. Затем откройте конфигурацию запуска, добавьте слово «seed» в список аргументов и запустите ее еще раз. Это заполнит базу данных некоторыми начальными необходимыми значениями.
5. Запустите botlistbot/main.py используя конфигурацию по умолчанию.

Не использовать PyCharm...

Настройте экземпляр базы данных PostgreSQL с помощью Docker

1. Установить Докер
2. Запустите docker-compose up -d
3. Создайте и заполните базу данных с помощью pipenv run python scripts/initialize_database.py seed
4. Чтобы остановить базу данных, запустите docker-compose down

Настроить BotListBot

1. Клон с GitHub: git clone https://github.com/JosXa/BotListBot (или собственный форк)
2. Запустите pipenv install
3. Измените переменные в template.env и сохраните файл как .env в корневой папке оформления заказа.
4. Создайте и заполните базу данных с помощью pipenv run python scripts/initialize_database.py seed
5. Запустите проект через pipenv run python -m botlistbot.main

Более подробная информация о конфигурации

Если вы посмотрите на settings.py, вы увидите множество переменных среды, которые извлекаются с помощью вызовов decouple.config(...) . Этими настройками можно управлять с помощью файла .env , который вы создали в корневой папке.