Commit e9353143 authored by Jan Luc Tavares's avatar Jan Luc Tavares
Browse files

alterado 'leiame' para 'readme' e melhorado seu conteudo

parent 9ed7a169
Bot das EMM para Telegram
====================================================
Repositório: https://git.cta.if.ufrgs.br/emm/emm-bot
Decidimos realizar a construção do BOT no Telegram, por ser uma plataforma simples, bem documentada e amplamente utilizada. Objetiva-se, porém, permitir uma adaptabilidade fácil a outros meios (outros mensageiros, por exemplo).
Objetiva-se a capacidade de informar os parâmetros medidos pelas estações meteorológicas de forma muito simples e acessível.
### Funcionalidades ###
Para testar mesmo as funcionalidades, recomendamos a utilização do bot. Resumimos as funcionalidades a seguir:
1. Oi - Dá as boas-vindas ao usuário;
1. Ajuda - Explica os comandos;
1. Tchau - Remove o usuário do banco de dados e se despede;
1. Selecionar estação - Atribui ao usuário a estação selecionada.
#### Ainda não implementado: ####
1. Último - Informa (via string) o valor da última medida do dado selecionado;
1. Dia - Informa (via gráfico) o último dia de medidas;
1. Semana - Informa (via gráfico) a última semana de medidas;
1. Mês - Informa (via gráfico) o último mês de medidas.
### Sobre o TOKEN ###
Se você clonar o repositório não conseguirá fazer o bot funcionar imediatamente, pois é necessário possuir um "código de acesso" fornecido pelo Telegram.
Por esse motivo foi criado um arquivo chamado "secretoken.py" contendo o TOKEN de acesso ao sistema do Telegram. Esse token permite que o bot utilize o serviço do Telegram e deve ser mantido em segredo para que ninguém se passe pelo BOT desenvolvido por outras pessoas. Dessa forma, realizamos um
>from secretoken import tokensecret
E não realizamos o upload do secretoken.py para o servidor. Nesse arquivo consta apenas o código de acesso para o BOT. Você pode criar o seu token usando o "BotFather":https://core.telegram.org/bots#botfather.
### Bibliotecas utilizadas ###
Para o gerenciamento do banco de dados (arquivo dbhelper.py) foi usado o SQlite3.
Referência: https://docs.python.org/2/library/sqlite3.html
Além dessa, até agora foram utilizadas as bibliotecas:
* json - para lidar com a sintaxe de json.
* requests - para fazer os "get" http.
* time - para esperar um tempo mínimo entre um "get" e outro.
* os - simplifica a localização de arquivos no sistema (sim, poderíamos ter feito diferente).
* urllib - converte o texto para ele ser amigável a um texto de URL.
----------------------------------------------------
Todo o código é disponibilizado sob a licença GPLv3.
Jan Luc Tavares,
Agosto de 2017.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment