Biblioteca em nível de aplicação para criar bots no Telegram 🤖 · telegram

Você pode encontrar muitas bibliotecas e módulos prontos para construir bots no Telegram, mas nenhum deles cobre as funcionalidades básicas que são quase indispensáveis, como criar um menu de ajuda automaticamente a partir de comandos, registrar usuários, gerar um log no administrador do Telegram e outros.
O objetivo desta biblioteca é preencher essas lacunas e permitir que os desenvolvedores de bots do Telegram criem rapidamente bots poderosos, estáveis e seguros em apenas algumas linhas de código. Este trabalho ainda está em seus estágios iniciais, mas convido você a juntar-se a nós e nos ajudar a explorar e conquistar o fascinante mundo dos bots do Telegram colaborando e usando esta biblioteca.

Como funciona:
Basicamente, construímos uma classe chamada TlgBotFwk, que herda da classe Application, implementada pela biblioteca telegram.ext, fornecida pelo pacote python-telegram-bot, versão 21 ou superior (https://github.com/python-telegram-bot/python-telegram-bot). Nesta classe filha, implementamos alguns métodos padrão para lidar com os comandos universais /start, /help e outros comandos não reconhecidos. No entanto, o desenvolvedor pode implementar seus próprios manipuladores de comando sem perder a funcionalidade interna. Recomendo a leitura do código-fonte para mais detalhes. Eu também recomendo usar a versão Python 3.12.

Utilização:
Para usar essa classe, basta criar um script simples com as linhas de código abaixo e o bot será executado imediatamente com todos os defaults e recursos já embutidos na biblioteca:

if __name__ == "__main__": 
    app = TlgBotFwk()  
    app.run()

Não se esqueça de criar um arquivo .env, porque a biblioteca carregará automaticamente configurações como token do Telegram e o user id do administrador do bot a partir dele. Você encontrará um arquivo sample.env na raiz do projeto, com este conteúdo de exemplo para criar um arquivo .env, e que pode ser obtido como explicado logo abaixo.

DEFAULT_BOT_TOKEN=<COLOQUE AQUI O TOKEN TELEGRAM OBTIDO NO PROCEDIMENTO ABAIXO>
DEFAULT_BOT_OWNER=<COLOQUE AQUI SEU TELEGRAM ID OBTIDO NO PROCEDIMENTO ABAIXO>

Para obter um token de bot do Telegram, a partir do bot oficial BotFather e usar em um script de bot em Python, siga estas etapas:

Inicie um bate-papo com BotFather :
Abra o Telegram e procure por "BotFather".
Inicie uma conversa clicando no botão "Iniciar".
Crie um novo bot :
Digite e envie a mensagem./newbot
BotFather pedirá um nome para o seu bot. Escolha um nome que termine com "Bot", como "MyAwesomeBot".
Escolha um nome de usuário :
Depois de nomear o bot, o BotFather pedirá um nome de usuário exclusivo para o seu bot. Deve terminar em "bot" (por exemplo, ou ).AwesomeBotMyAwesomeBot_bot
Receba o Token :
Depois de fornecer um nome de usuário válido, o BotFather gerará um token para seu bot.
O token será parecido com 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11
Salve o token :
Esse token é essencial para acessar a API do Telegram Bot. Copie e salve-o em algum lugar seguro, pois você precisará dele para autenticar seu bot em seu script Python.
Use o token no arquivo .env :
No seu arquivo .env, você pode usar esse token substituindo-o em:
<COLOQUE AQUI O TOKEN TELEGRAM OBTIDO NO PROCEDIMENTO ABAIXO>

Para obter o seu ID do Telegram e substituí-lo, siga estes passos:

Inicie um bate-papo com um bot que revela o ID do usuário :
- Procure por um bot como userinfobot ou qualquer outro bot semelhante no Telegram.
- Inicie o bate-papo clicando em "Iniciar".
- Obtenha o número depois de "Id:" e substitua-o em .env no lugar de COLOQUE AQUI SEU TELEGRAM ID OBTIDO NO PROCEDIMENTO ABAIXO
- Primeiros passos
- Estas instruções lhe darão uma cópia do projeto em funcionamento em sua máquina local para fins de desenvolvimento e teste.

Siga os itens de instalação abaixo para implantar o projeto em seu computador.

Pré-requisitos
Que coisas você precisa para instalar o software e como instalá-los.

-Uma IDE Python IDE como VS Code ou PyCharm não é obrigatória, mas desejável, para alterar ou colaborar no código fonte (eu recomendo VS Code).
-Python 3.12 ou superior instalado localmente é obrigatório.
-pip 24 ou superior instalado também é obrigatório.

Instalação

Escolha ou crie uma pasta nova e clone todo o repositório

    git clone https://github.com/gersonfreire/tlgfwk.git

Instale as dependências:

    pip -r requirements.txt

Execute a função principal da classe base

    python tlgfwk.py

Envolva-se entrando no grupo do Telegram do Projeto e veja também a lista de colaboradores que participaram deste projeto Por favor, sinta-se à vontade para se juntar a nós e vamos construir uma estrutura real completa e poderosa para bots.

Grupo Telegram: https://t.me/TlgBotFwk
Bot Demo: https://t.me/TecVitoriaBot