hellmrf / tweemol

Bot em Node.js que publica, diária e automaticamente, uma molécula de interesse farmacológico, bem como sua estrutura, informações e um link para a Wikipédia.

Tweemol

Robô que publica, todos os dias, uma molécula no Twitter contendo as informações extraídas da Wikipédia, um link e a imagem.
Acessar » · Reportar Bug · Fazer sugestão

Índice

• Sobre o Projeto
  • Motivação
  • Feito com
• Começando
  • Pré-requisitos
  • Configurando o ambiente
• Uso
• Contribuindo
• Licença
• Contato

Sobre o Projeto

Tweemol é um robô desenvolvido por Héliton Martins em Node.js que, todos os dias, escolhe uma molécula de interesse farmacológico e publica um Tweet com sua estrutura, informações e link para a Wikipédia. Isso é feito através de uma busca na Wikipédia seguida do resumo do texto. A imagem é obtida da Wikipédia ou Google Images, nesta ordem de prioridade. O robô, então, de posse de um texto de tamanho adequado para o Twitter e de uma imagem também adequada, publica esse conjunto de informações em @Tweemol no Twitter.

Motivação

Este projeto teve como principal objetivo o meu estudo pesosal do ambiente Node.js e utilização de APIs. Sou programador auto-didata e apaixonado pela programação. Assim, acredito que a melhor forma de estar sempre "em forma", isto é, alinhado com as novidades do mundo tecnológico, é desenvolvendo projetos pessoais que traduzam bem o instinto programador: resolver todos os problemas possíveis através de automação.

Antes de desenvolver este projeto, recebi grande influência do projeto open-source do youtuber Filipe Deschamps e também do @bot_RU_UFMG, robô desenvolvido por Vitor Mafra e que publica no Twitter o cardápio diário do Restaurante Universitário (bandejão) da UFMG, universidade na qual também estudo.

Feito com

Este projeto foi desenvolvido com:

Linguagem/Tecnologia:

• Node.js

Dependências:

• Axios · requisições GET
• Node-fetch · requisições POST
• Sentence-Boundary-Detection (SBD) · detecção de frases
• Sharp · conversão de imagens
• Twit · implementação em Node.js da API do Twitter
• Twitter-Text · contagem precisa de caracteres

APIs:

• Algorithmia
  • nlp/Summarizer · resumo de textos
• Google Custom Search API · busca de imagens
• Twitter Standard API · publicação de Tweets

Serviços

• Heroku · hospedagem e execução programada

Começando

Para reutilizar o projeto, seja para contribuir enviando um Pull-Request, ou para usar em seu projeto pessoal, veja a seguir o que será necessário.

Pré-Requisitos

Você precisará ter pré-instalado:

• Node.js (> 10.16.3*)
• npm (> 6.14.5*)
• Git

* Versões inferiores não testadas.

Configurando o ambiente

1. Clone o repositório utilizando git clone.

git clone [email protected]:hellmrf/Tweemol.git

2. Instale as dependências.

cd Tweemol
npm install

3. Consiga uma conta de desenvolvedor do Twitter. ㅤ Para evitar a utilização inadequada das APIs, o Twitter fará uma verificação das suas inteções antes de aprovar sua conta. Isso pode demorar algumas horas. Acesse o Twitter Developer ou clique aqui para aplicar para o acesso. Detalhe o máximo possível suas intenções. Com a conta de desenvolvedor criada, crie um app. ㅤ

4. O projeto está quase completamente configurado, exceto pelas chaves de API que serão necessárias e que deverão estar corretamente configuradas dentro de /credentials/. Para ver as instruções detalhadas para consegui-las, acesse este arquivo.

Uso

Após tudo devidamente configurado, basta executar o arquivo de entrada do projeto.

node index.js

Contribuindo

Contribuições são o que tornam a comunidade open-source um ambiente incrível para aprender, se inspirar e criar. Qualquer contribuição que você fizer será enormemente apreciada.

1. Crie um fork do Projeto
2. Crie uma nova branch (git checkout -b feature/recursoIncrivel)
3. Faça o commit das suas alterações (git add . e git commit -m 'Adicionando este incrível recurso.')
4. Envie para o seu Github (git push origin feature/recursoIncrivel)
5. Abra um Pull Request detalhando ao máximo o que você implementou, os problemas que ainda precisam ser resolvidos e o que mais julgar necessário.
6. Pronto! Você está contribuindo com o mundo open-source.

Licença

Distribuido sob Licensa MIT. Veja LICENSE para mais informações.

Contato

Heliton Martins - @hellmrf - [email protected]

Link do projeto: https://github.com/hellmrf/Tweemol/

tweemol's Issues

Escopo e tarefas

A seguir estão as tarefas a serem completadas.

• Receber moléculas
  • Definir origem dos dados

---

• Pesquisar na Wikipédia

  • Verificar se página existe
  • Extrair resumo
  • Extrair propriedades
  • Extrair SMILES
  • Extrair imagem, se disponível
  • Sanitizar dados

• Preparar Texto

  • Verificar tamanho do resumo
    • Resumir usando IA se for muito grande
  • Organizar as propriedades

• Criar imagem

  • Verificar imagem da Wikipédia, se disponível
  • Desenhar molécula via SMILES, se possível
    • Encontrar a API ideal
    • Gerar imagem
    • Subir para imgur
  • Pesquisar imagem no Google Images, caso as duas etapas acima falhem
  • Baixar imagem escolhida
  • Converter imagem para PNG
  • Limpar diretório temporário após conclusão.

• Publicar no Twitter

  • Gerar chaves de API
  • Escrever Tweet
  • Adicionar link
  • Adicionar imagem

• Hospedar Online

  • Verificar conta Heroku
  • Instalar complemento de agendamento
  • Agendar as execuções do script

• Gerais

  • Caso algum erro seja lançado, tentar novamente até conseguir.

• TESTE FINAL