Jerimum Bot

É o bot do Telegram controlado pelo Guilherme, o gato mais bonito e simpático do mundo, com finalidade de ajudar a comunidade do Jerimum Hackerspace.

Instalação e Configuração para Desenvolvimento

Seguindo este rápido guia (desenvolvido para Linux), ao fim você será capaz de executar sua própria instância do nosso bot.

Guia de instalação

Clonando o repositório

Utilizando Git

Para instalar o bot, o primeiro passo é clonar o repositório no seu ambiente local. Isso pode ser feito através do seguinte comando, via terminal:

git clone https://github.com/jerimumhs/JerimumBot.git

Com isso pronto, basta entrar no diretório recém criado:

cd JerimumBot/

Configurando o ambiente

Para rodar nosso bot é necessário Python e Mongo. Pode ser utilizado o docker para facilitar a utilizar ou realizar a instalação dessas tecnologias,

instalação Python + Mongo

Python

É necessário ter algum python a cima da versão 3.6 siga a documentação oficial para instalar.

Criando um ambiente virtual

Antes de prosseguir na execução do bot, você precisará criar um ambiente virtual. Existem maneiras diferentes de fazer isso.

utilizando venv

Utilizando Python3.6, basta executar:

python3 -m venv {{nome_do_seu_venv}}

Onde {{nome_do_seu_venv}} deve ser substituído por um nome de sua escolha.

Agora, será necessário ativar este ambiente execute o comando referente ao seu SO:

Linux

source {{nome_do_seu_venv}}/bin/activate

Windows

{{nome_do_seu_venv}}/bin/activate.bat

Para mais informações sobre o assunto, basta ler a documentação oficial.

Instalando dependências

Instale as dependências de desenvolvimento do python

Linux Debian Based

Instale estes pacotes:

sudo apt install build-essential python3-dev libssl-dev libffi-dev \
               libxml2-dev libxslt1-dev zlib1g-dev

Depois disso, dentro do repositório clonado, basta executar:

pip install -r requirements-dev.txt

Mongo

Siga a [documentação oficial](https://docs.mongodb.com/manual/installation/)

instalação Docker

Docker

Para rodar nosso bot no docker é nessecário ter o docker-ce e docker-compose. Siga as documentações oficiais para instalar o docker-ce e o docker-compose

Para construir a imagem da aplicação rode o comando

make docker.build

Criando seu próprio bot no Telegram

Você precisará criar o seu próprio bot no Telegram para testar/desenvolver o JerimumBot. É um processo bastante rápido e simples. Inicialmente, acesse a página do BotFather e clique em Send Message.

A partir daí, o Telegram tentará abrir o aplicativo dele na sua máquina. Caso você não o tenha instalado, pode abrir o Telegram Web (ou até mesmo a versão mobile) e pesquisar por BotFather. Ao localizá-lo, inicie a conversa com um /start e siga as instruções para criar um novo bot. Ao fim, copie o token gerado, que será necessário na próxima seção.

Configurando o .env no seu repositório local

Você já está quase lá! Agora é necessário configurar a sua versão local do .env. Já existe um arquivo chamado .env.example na raiz do diretório. Copie o conteúdo dele para um novo arquivo chamando .env.

Na primeira linha do arquivo você encontrará

BOT_TOKEN=meu_token_123

Substitua meu_token_123 pelo token que foi gerado quando você criou o seu bot, no passo anterior.

Nas linhas 9 à 13 você encontrará linha do arquivo você encontrará

DB_USER=mongo
DB_PASSWORD=mongo
DB_HOST=mongo
DB_NAME=mongo
DB_PORT=27017
DB_AUTH=admin

Substitua os valores de acordo com a configuração de seu mongo nos passo anterior.

Por último, você precisará carregar as variáveis de ambiente do arquivo .env no seu terminal:

Linux

source .env

Executando o JerimumBot

Python + Mongo

Confirme que o seu mongo está rodando corretamente antes de executar o bot!

Depois de ter seguido todos os passos desse tutorial até aqui, você está com tudo pronto para executar o JerimumBot. Basta executar o comando make run e... pronto!

Docker

Depois de ter seguido todos os passos desse tutorial até aqui, você está com tudo pronto para executar o JerimumBot. Basta executar o comando make docker.up e... pronto!

Testando a sua instância

Depois disso, você pode testar as funcionalidades do JerimumBot no chat do próprio bot que você criou anteriormente. Todos os comandos do JerimumBot estarão disponíveis para você, além dos novos que você possa ter desenvolvido.

Exemplo de uso

Em breve...

Autores

Geraldo Castro - Code / Ideas / Review - exageraldo
Rodrigo Castro - Code / Ideas / Review - rodrigondec
Allan Kardec - Code / Ideas - kaardeco

Contributing

Faça o fork do projeto (https://github.com/JerimumHS/JerimumBot/fork)
Crie uma branch para sua modificação (git checkout -b feature/nome_da_feature)
Faça o commit (git commit -am 'Add feature nome_da_feature')
Push (git push origin feature/nome_da_feature)
Crie um novo Pull Request
Aguarde a revisão

Esse é o seu primeiro Pull Request? Você pode aprender como colaborar com esse artigo gratuito: How to Contribute to an Open Source Project on GitHub

Licença

Distribuído sob a GNU General Public License v3.0. Veja LICENSE para mais informações.

jerimumhs / JerimumBot