PythonItaliaTGbot

Bot principale per il gruppo Telegram di PythonItalia.

Che cos'è?

Questo bot è un fork della versione base di tgBot (ex Marie). Lo sviluppo orizzontale del bot ha permesso di aggiungere funzionalità e risolvere bug presenti nel codice sorgente originale.

Il deploy

Il deploy del bot può essere effettuato su Heroku (settando le variabili di ambiente) che su una VPS dedicata (preferibilmente con kernel linux > 2.6.13).

Configurazione del db

Il primo step necessario è la configurazione del database postgres.

Installazione e configurazione di postgres

• Installa postgres:

sudo apt-get update && sudo apt-get install postgresql

• Cambia l'utente postgres:

sudo su - postgres

• Crea un nuovo database utente (cambia USER con il nome dell'utente):

createuser -P -s -e USER

Ti verrà chiesto di inserire una password.

• Crea una nuova tabella nel db:

createdb -O USER YDB_NAME

• In fine

psql DB_NAME -h YOUR_HOST USER

A questo punto sarai in grado di connetterti al db via terminal. Di default YOUR_HOST dovrebbe essere 0.0.0.0:5432. Il database-uri sarà quindi:

postgres://username:pw@hostname:port/db_name

Configurazione

Esistono due modi per configurare il bot: modificando il file config.py oppure impostando delle variabili d'ambiente.

Il metodo migliore è l'uso del file config.py perchè è più semplice rivedere tutte le impostazioni in un singolo file. Il metodo predefinito per creare il file config.py è estendere la classe di sample_config.

Un esempio di config.py potrebbe essere:

from tg_bot.sample_config import Config


class Development(Config):
    OWNER_ID = 00000000  # my telegram ID
    OWNER_USERNAME = "########"  # my telegram username
    API_KEY = "your bot api key"  # my api key, as provided by the botfather
    SQLALCHEMY_DATABASE_URI = 'postgresql://username:password@localhost:5432/database'  # sample db credentials
    MESSAGE_DUMP = '00000000' # some group chat that your bot is a member of
    USE_MESSAGE_DUMP = True
    SUDO_USERS = [0000000, 000000]  # List of id's for users which have sudo access to the bot.
    LOAD = []
    NO_LOAD = ['translation']

Nel caso in cui tu voglia deployare il bot su heroku dovrai impostare le ENV. Sono supportate le seguenti variabili:

ENV: Setting this to ANYTHING will enable env variables

TOKEN: Token del bot, come stringa.

OWNER_ID: Numero intero che identifica il proprietario del bot (id di Telegram)

OWNER_USERNAME: Il tuo username

DATABASE_URL: URI del db

MESSAGE_DUMP: opzionale: chat in cui sono salvate le risposte del bot dove non possono essere cancellate

LOAD: Lista separata da spazi di moduli che vuoi abilitare

NO_LOAD: Lista separata da spazi di moduli che NON vuoi abilitare

WEBHOOK: Impostarlo a ANYTHING abiliterà i webhooks nei messaggi env

URL: URL del webhook (richiesto solo se abilitata la modalità webhook)

SUDO_USERS: Lista separata da spazi di ids di amministratori del bot

SUPPORT_USERS: Lista separata da spazi di ids di utenti-supporter (possono gban/ungban, e basta)

WHITELIST_USERS: Lista separata da spazi di ids di utenti che non possono essere bannati

DONATION_LINK: Opzionale: Link per le donazioni

CERT_PATH: Path del certificato webhooks

PORT: Porta usata per connettersi al tuo servizio webhooks

DEL_CMDS: Se cancellare i comandi dagli utenti che non hanno i diritti per usare quel comando

STRICT_GBAN: Imponi gban su nuovi gruppi e vecchi gruppi. Quando un utente gbanned parla, sarà bannato

WORKERS: Numero di threads da usare. 8 è raccomandato (e numero di default). Nota che aumentare questo numero non porterà necessariamente dei benefici alla velocità del bot.

BAN_STICKER: Sticker da usare quando viene bannato un utente.

ALLOW_EXCL: Se consentire l'utilizzo di punti esclamativi ! per i comandi e /.

Dependency

Installa le dependency con questo comando:

pip3 install -r requirements.txt

Moduli

Imposta l'ordine di caricamento dei moduli

L'ordine di caricamento in memoria dei moduli può essere opportunamente modificato tramite l'uso di LOAD e NO_LOAD.

Nota: NO_LOAD è prioritario rispetto a LOAD

Avviare il bot con docker

Requisiti

• docker
• docker-compose

Avvio

• Crea un file .env usando docker/dev/config.sample come template e salvandola in docker/dev/
• Assicurati di essere nella root del progetto e inserisci il seguente comando:

docker-compose -f docker/dev/docker-compose.yml up -d

Costruito con

• tgbot - Bot modulare scritto in Python3
• Trevis CI - Deploy in production
• Docker - Usato per sviluppare il bot in ambiente dev

Come contribuire

Per favore leggi CONTRIBUTING.md per avere dettagli sulle regole per contribuire e come effettuare una pull-request.

Versioning

Noi usiamo SemVer per il versioning, sincronizzato con i tag in production di GH.

Autori

Controlla la lista di contributors che hanno reso questo progetto grande.

License

This project is licensed under the MIT License - see the LICENSE.md file for details