BotListBot

Le télégramme @BotListBot

Il s'agit du Chatbot chargé de maintenir la Telegram BotList, une chaîne qui est une approche communautaire pour collecter les meilleurs Bots sur Telegram.

Le bot simplifie la navigation en agissant comme un miroir de la BotList et automatise le processus de soumission, de révision et de publication des robots par la communauté BotListChat.

Ce référentiel est destiné à servir d'inspiration et de conseils techniques aux créateurs de robots, principalement aux personnes utilisant l'incroyable bibliothèque python-telegram-bot.

JosXa/BotListBot est sous licence MIT.

Guide de configuration

Conditions préalables

Obligatoire

• Python 3.7.x
• Une instance de base de données PostgreSQL ou Docker (voir ci-dessous)
• Pipenv installé globalement ( pip install pipenv )
• Votre propre jeton de bot pour le développement local

Facultatif

• Un compte sentry.io (logging)
• Un stockage objet compatible S3 (ex : Minio)

Configuration du développement

Utilisation des espaces de codes GitHub et VSCode ( recommandé )

Recommandé car c’est l’option la plus rapide pour démarrer.

1. Sur GitHub Codespaces, saisissez « JosXa/BotListBot » et créez votre conteneur de développement.
2. Modifiez les variables dans template.env et enregistrez le fichier sous simplement .env dans le dossier racine de la caisse.
3. Exécutez le projet via pipenv run python -m botlistbot.main

Utiliser PyCharm...

Configurer une instance de base de données PostgreSQL avec Docker

1. Installer Docker
2. Exécutez docker-compose up -d
3. Créez et amorcez la base de données via pipenv run python scripts/initialize_database.py seed
4. Pour arrêter la base de données, exécutez docker-compose down

Configurer BotListBot

1. VCS -> Obtenir depuis le contrôle de version... -> https://github.com/JosXa/BotListBot (ou votre propre fork)
2. Ajoutez un nouvel interprète de projet à l'aide de Pipenv ( et non de virtualenv ) et laissez PyCharm installer les packages pour vous.
3. Modifiez les variables dans template.env et enregistrez le fichier sous simplement .env dans le dossier racine
4. Exécutez le fichier scripts/initialize_database.py une fois. Ensuite, ouvrez sa configuration d'exécution, ajoutez le mot « graine » à la liste des arguments et exécutez-la à nouveau. Cela remplira la base de données avec certaines valeurs initiales requises.
5. Exécutez botlistbot/main.py en utilisant une configuration par défaut

Je n'utilise pas PyCharm...

Configurer une instance de base de données PostgreSQL avec Docker

1. Installer Docker
2. Exécutez docker-compose up -d
3. Créez et amorcez la base de données via pipenv run python scripts/initialize_database.py seed
4. Pour arrêter la base de données, exécutez docker-compose down

Configurer BotListBot

1. Cloner depuis GitHub : git clone https://github.com/JosXa/BotListBot (ou votre propre fork)
2. Exécutez pipenv install
3. Modifiez les variables dans template.env et enregistrez le fichier sous simplement .env dans le dossier racine de la caisse.
4. Créez et amorcez la base de données via pipenv run python scripts/initialize_database.py seed
5. Exécutez le projet via pipenv run python -m botlistbot.main

Plus de détails sur la configuration

Si vous jetez un œil à settings.py, vous pouvez voir un tas de variables d'environnement qui sont récupérées via des appels decouple.config(...) . Ces paramètres peuvent être contrôlés via le fichier .env que vous avez créé dans le dossier racine.