This repository has been archived on 2022-08-14. You can view files and clone it, but cannot push or open issues or pull requests.
feurBot/README.md

66 lines
2.6 KiB
Markdown
Raw Normal View History

2021-08-03 20:10:54 +02:00
# Bot Twitter
Bot qui envoie automatiquement des réponses ennuyante quand les personnes que tu suis finissent leur tweet par mot spécial.
2021-08-05 21:01:25 +02:00
| Mot | Réponse | ¦ | Mot | Réponse
2021-08-05 21:11:34 +02:00
------|-----------------------|:-:|---------|-
2021-08-05 21:01:25 +02:00
quoi | feur (ou équivalent) | ¦ | con | combre (ou équivalent)
oui | stiti (ou équivalent) | ¦ | ok | sur glace (ou équivalent)
non | bril (ou équivalent) | ¦ | ouais | stern (ou équivalent)
nan | cy (ou équivalent) | ¦ | comment | tateur (ou équivalent)
hein | deux (ou équivalent) | ¦ | mais | on (ou équivalent)
ci | tron (ou équivalent) | ¦ | fort | boyard (ou équivalent)
2021-08-04 16:01:29 +02:00
N'hésitez pas à ouvrir un ticket ou faire une merge request pour ajouter des mots/réponses.
2021-08-03 20:10:54 +02:00
## Lancer le Bot
Donner la permission `Read and Write` (ou `Read + Write + Direct Messages` mais aucun DM n'est envoyé) au Bot dans `Settings` puis `App permissions`.
Détails des variables d'environnement :
2021-08-03 20:57:21 +02:00
| Variable | Explication et où elle se trouve
2021-08-03 20:10:54 +02:00
----------------|-
TOKEN | Token d'accès disponible dans la section `Authentication Tokens` sous la sous-rubrique `Access Token and Secret`
TOKEN_SECRET | Token d'accès secret disponible dans la section `Authentication Tokens` sous la sous-rubrique `Access Token and Secret`
CONSUMER_KEY | Clé API disponible dans la section `Consumer Keys`
CONSUMER_SECRET | Clé secrète API disponible dans la section `Consumer Keys`
PSEUDOS | Pseudos du ou des compte.s que vous voulez écouter pour le snipe (a séparer avec une virgule **sans** espaces)
2021-08-05 20:26:25 +02:00
WHITELIST | Pseudos des comptes qui ne seront pas touché par le Bot (facultatif, a séparer avec une virgule **sans** espaces, par défaut la liste est vide)
VERBOSE | Affiche plus de messages dans la console [False\|True] (facultatif, par défaut sur False)
2021-08-03 20:10:54 +02:00
### En local
Pour le lancer, complètez le `.envexample` et renomme le en `.env`.
Ensuite, installez les dépendances avec `pip install -r requirements.txt`.
Et enfin lancez `python3 main.py`.
### Avec Docker
2021-08-03 20:10:54 +02:00
Avec une ligne de commande :
```bash
docker run -d \
--name="feurBot" \
registry.gitlab.com/mylloon/feurbot:latest \
--TOKEN="" \
--TOKEN_SECRET="" \
--CONSUMER_KEY="" \
--CONSUMER_SECRET="" \
--PSEUDOS="" \
```
Ou avec un `docker-compose.yml` :
```bash
version: "2.1"
services:
feurBot:
image: registry.gitlab.com/mylloon/feurbot:latest
container_name: feurBot
environment:
- TOKEN=
- TOKEN_SECRET=
- CONSUMER_KEY=
- CONSUMER_SECRET=
- PSEUDOS=
restart: unless-stopped
```