rpa-suite

RPA Suite

O que é?

RPA Suite: um conjunto abrangente de ferramentas projetadas para simplificar e otimizar o desenvolvimento de projetos de automação RPA com Python. Embora nossa suíte seja um conjunto de Ferramentas de RPA especializado, sua versatilidade a torna igualmente útil para uma ampla gama de projetos de desenvolvimento. Esta desenvolvendo com Selenium ou Botcity? Experimente a RPA Suite e descubra como podemos facilitar seu projeto e qualquer projeto de Robôs de Software.

Documentação

• Documentação no GitHub Conta com guia de uso , instação e todas funcionalidades.

Sumário

• O que é?
• Documentação
• Sumário do conteudo
• Destaque
• Objetivo
• Instalação
• Exemplo
• Dependências
• Estrutura do módulo
• Release
• Mais Sobre

Destaque

Versátil: Além da Automação de Processos e criação de BOT em RPA, mas também para uso geral podendo ser aplicadas em outros modelos de projeto, além do RPA.

Simples: Construímos as ferramentas de maneira mais direta e assertiva possível, utilizando apenas bibliotecas conhecidas no mercado para garantir o melhor desempenho possível.

Objetivo

Nosso objetivo é se tornar a Biblioteca Python para RPA referência. Tornando o desenvolvimento de RPAs mais produtivo, oferecendo uma gama de funções para tal:

• Envio e validação de Emails com apenas uma linha
• Criação e Manipulação de registros de Logs
• Busca por palavras, strings e padrões em textos
• Criar e Deletar Pastas e arquivos temporarios
• Console com mensagens de melhor visualização com cores definidas para alerta, erro, informativo e sucesso.
• Módulo dedicado para execução com Paralelismo
• Funções que facilitam execuções Assincronas
• Registro de Screenshot com apenas um comando
• E muito mais

Instalação

Para instalar o projeto, utilize o comando:

>>> python -m pip install rpa-suite

ou no conda:

conda install -c conda-forge rpa-suite

Após instalação basta fazer a importação do modulo rpa que ja tera um objeto instanciado de suite:

from rpa_suite import rpa

Feito isso já estará pronto para o uso:

# function send mail by SMTP 
rpa.email.send_mail(...)

⚠️ IMPORTANTE: Para desinstalar o projeto, utilize o comando abaixo:

python -m pip uninstall rpa-suite

Observação: Caso necessário, desinstale também as bibliotecas utilizadas no projeto, como loguru, mail_validator, colorama, pillow, e pyautogui.

⚠️ IMPORTANTE: Opcionalmente, você pode querer desinstalar as bibliotecas que foram incluídas no projeto. Para isso, utilize o seguinte comando:

python -m pip uninstall loguru mail_validator colorama pillow pyautogui

Exemplo

Do módulo principal, importe a suite. Ela retorna uma instância do Objeto de classe Rpa_suite, onde possui variáveis apontando para todas funções dos submódulos:

from rpa_suite import rpa

# Exemplo com função de execução em horário específico
rpa.clock.exec_at_hour('13:53', my_function, param_a, param_b)

# Usando submódulo clock para aguardar 30(seg) para executar minha função
time = 30
rpa.clock.wait_for_exec(time, my_function, param1, param2)

# Usando submódulo email para envio de email por SMTP comum
rpa.email.send_smtp(...)

Dependências

No setup do nosso projeto já estão inclusas as dependências, só será necessário instalar nossa Lib, mas segue a lista das libs usadas:

• colorama

• loguru

• email-validator

• colorlog

• pillow

• pyautogui

• typing

  opcionalmente para usar todas funcionalidades:

  • selenium
  • webdriver_manager
  • docling

⚠️ IMPORTANTE: No caso da função de screenshot, é necessário ter as bibliotecas pyautogui, pillow e pyscreeze instaladas. Geralmente, a instalação de pyautogui já inclui as demais dependências necessárias.

Estrutura do módulo

O módulo principal do rpa-suite é dividido em categorias. Cada categoria contém módulos com funções destinadas a categoria:

• rpa_suite

  clock

  • exec_at_hour - Função que executa uma função no horário especificado "xx:yy", permitindo agendamento de tarefas com precisão.
  • wait_for_exec - Função que aguarda um tempo em segundos antes de executar a função passada como argumento.
  • exec_and_wait - Função que executa uma função e, em seguida, aguarda um tempo em segundos antes de continuar.

  date

  • get_hms - Função que retorna hora, minuto e segundo formatados como strings.
  • get_dmy - Função que retorna dia, mês e ano formatados como strings.

  email

  • send_smtp - Função para envio de emails via SMTP com suporte a anexos e mensagens HTML, configurável e personalizável.

  file

  • screen_shot - Função para capturar screenshots, criando diretórios e arquivos com nomes e caminhos personalizáveis.
  • flag_create - Função para criar arquivos de flag indicando execução de processos.
  • flag_delete - Função para deletar arquivos de flag após a execução de processos.
  • count_files - Função para contar arquivos em diretórios, com suporte a extensões específicas.

  directory

  • create_temp_dir - Função para criar diretórios temporários com nomes e caminhos personalizáveis.
  • delete_temp_dir - Função para deletar diretórios temporários, com opção de remover arquivos contidos.

  log

  • config_logger - Função para configurar logs com suporte a arquivos e streams, utilizando a biblioteca Loguru.
  • log_start_run_debug - Função para registrar logs de início de execução em nível de depuração.
  • log_debug - Função para registrar logs em nível de depuração.
  • log_info - Função para registrar logs em nível informativo.
  • log_warning - Função para registrar logs em nível de aviso.
  • log_error - Função para registrar logs em nível de erro.
  • log_critical - Função para registrar logs em nível crítico.

  printer

  • success_print - Função para imprimir mensagens de sucesso com destaque em verde.
  • alert_print - Função para imprimir mensagens de alerta com destaque em amarelo.
  • info_print - Função para imprimir mensagens informativas com destaque em ciano.
  • error_print - Função para imprimir mensagens de erro com destaque em vermelho.

  regex

  • check_pattern_in_text - Função para verificar a presença de padrões em textos, com suporte a case-sensitive.

  validate

  • emails - Função para validar listas de emails, retornando listas de emails válidos e inválidos.
  • word - Função para buscar palavras ou padrões específicos em textos, com suporte a contagem de ocorrências.

  Browser

  • start_browser - Função para iniciar o navegador Chrome com suporte a depuração remota.
  • find_ele - Função para localizar elementos na página utilizando estratégias de localização do Selenium.
  • get - Função para navegar para URLs específicas.
  • close_browser - Função para fechar o navegador e encerrar processos relacionados.

  Parallel (ParallelRunner)

  • run - Função para iniciar um processo em paralelo.
  • is_running - Função para capturar o status atual do processo que esta rodando em paralelo.
  • get_result - Função para coletar o retorno da execução em paralelo junto com resultado da função ou funções que foram enviadas a este processo com retorno em forma de dict.
  • terminate - Função para finalizar o processo paralelo mantendo apenas o processo principal do seu código, também é chamada de forma automatica esta função ao final de um procesos paralelo ou no final da função "get_result".

  Asyn (AsyncRunner)

  • run - Função para iniciar a execução assíncrona de uma função mantendo o fluxo principal da aplicação.
  • is_running - Função para verificar se a tarefa assíncrona ainda está em execução.
  • get_result - Função para obter o resultado da execução assíncrona, incluindo tempo de execução e status, com suporte a timeout.
  • cancel - Função para cancelar a tarefa assíncrona em execução.

  Iris (OCR-IA)

  • read_document - Reads and converts a document to the specified format.

Release Notes

Versão: Beta 1.6.2

• Data de Lançamento: 20/02/2024
• Última Atualização: 08/06/2025
• Status: Em desenvolvimento

Esta versão marca um grande avanço no desenvolvimento da RPA Suite, trazendo melhorias significativas na arquitetura, novas funcionalidades e maior simplicidade no uso. Confira as principais mudanças abaixo.

Notas:

• atualização 1.6.0

  • Adição Módulo: Iris (OCR-IA)
  • Feat.: leitura de documento (aceita multiplos formatos)
  • Feat.: leitura em lote (multiplos docmumentos em uma unica chamada)
  • Melhoria de docstrings

• atualização 1.5.9

  • Atualização de Linters e Formatters
  • black
  • pylint
  • bandit
  • flake8
  • isort
  • pyupgrade
  • detect-secrets
  • autoflake

Mais Sobre

Para mais informações, visite os links abaixo:

• Repositório no GitHub Explore o código-fonte, contribua com melhorias e acompanhe o desenvolvimento do projeto.
• Página no PyPI Confira a documentação oficial, instale a biblioteca e veja as versões disponíveis.