# rpasuite (`camiloccarvalho/rpasuite`) Actor RPA Suite: um conjunto abrangente de ferramentas projetadas para simplificar e otimizar o desenvolvimento de projetos de automação RPA com Python. - **URL**: https://apify.com/camiloccarvalho/rpasuite.md - **Developed by:** [Camilo Carvalho](https://apify.com/camiloccarvalho) (community) - **Categories:** Automation, Developer tools - **Stats:** 2 total users, 2 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-usage ## What's an Apify Actor? An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md. ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run. For examples already wired to this Actor's own input schema, see the [API](#api) section below. Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`). # README ![RPA Suite](https://raw.githubusercontent.com/CamiloCCarvalho/rpa_suite/db6977ef087b1d8c6d1053c6e0bafab6b690ac61/logo-rpa-suite.svg)

RPA Suite


![PyPI Latest Release](https://img.shields.io/pypi/v/rpa-suite.svg) ![PyPI Downloads](https://img.shields.io/pypi/dm/rpa-suite.svg?label=PyPI%20downloads) *** ### 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, Botcity ou Playwright? Experimente a RPA Suite e descubra como podemos facilitar seu projeto, ou qualquer projeto de Robôs de Software. ### Sumário do conteudo - [Destaque](#destaque) - [Objetivo](#objetivo) - [Instalação](#instalação) - [Exemplo](#exemplo) - [Dependências](#dependências) - [Estrutura do módulo](#estrutura-do-módulo) - [Versão do projeto](#versão-do-projeto) - [Mais Sobre](#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 de emails (já configurado e personalizavel) - Validação de emails (limpeza e tratamento) - Busca por palavras, strings ou substrings (patterns) em textos. - Criação e deleção de pasta/arquivo temporário com um comando - Console com mensagens de melhor visualização com cores definidas para alerta, erro, informativo e sucesso. - E muito mais ### Instalação Para **instalar** o projeto, utilize o comando: ```python >>> python -m pip install rpa-suite ``` ou no conda: ```python conda install -c conda-forge rpa-suite ``` Após instalação basta fazer a importação do modulo e instanciar o Objeto `suite`: ```python from rpa_suite import suite as rpa ``` Feito isso já estará pronto para o uso: ```python ## function send mail by SMTP rpa.send_mail(...) ``` > \[!NOTE] > > Para **desinstalar** o projeto, utilize o comando abaixo. > **Obs.:** como usamos algumas libs no projeto, lembre-se de desinstar elas caso necessário. ```python >>> python -m pip uninstall rpa-suite ``` > \[!IMPORTANT] > > Opcionalmente você pode querer desinstalar as libs que foram inclusas no projeto, sendo assim: ```python >>> python -m pip uninstall loguru mail_validator colorama ``` ### 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 suite as rpa # Usando a função de envio de email por SMTP default rpa.send_email(my_email, my_pass, mail_to, subject, message_body) # Usando submódulo clock para aguardar 30 (seg) e então executar uma função time = 30 rpa.wait_for_exec(time, my_function, param1, param2) ``` ### 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 \[!IMPORTANT] No caso da função de screenshot é necessario ter as libs 'pyautogui' 'pillow' e 'pyscreeze' instalados, geralmente a instalação de pyautogui já instala as demais dependências deste caso. ### 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 cada tipo de tarefa - **rpa_suite** - **clock** - **waiter** - Função capaz de aguardar para executar a função do argumento, ou executar a função do argumento para aguardar posteriormente - **exec_at** - Função capaz de executar a função do argumento no horario especificado "xx:yy" parecido com scheduler, porem com a vantagem de ter o horario como variavel dentro do escopo de código podendo gerar variações pela propria natureza da aplicação - **date** - **date** - Funções capazes de extrair dia/mes/ano e hora/min/seg, facilitando a necessidade de formatar o resultado de datetime, a função ja devolve os valores em trio formatados em string - **email** - **sender_smtp** - Funções para envio de email SMPT com configuração simples já default porem personalizavel - **file** - **counter** - Funções para contagem de arquivos - **temp_dir** - Funções para diretórios temporários - **screen_shot** - Função para criar diretório e arquivo de print com nome do diretório, arquivo e delay personalizáveis - **file_flag** - Funções para criar e deletar arquivo utilizado como flag de execução, tendo path e nome do arquivo já automatico porem personalizavel para se adequar ao seu projeto - **log** - **logger_uru** - Instanciador de stream e handlefile que cria na pasta raiz do arquivo chamador pasta de log e seta o stream para as funções de log - **functions_logger_uru** - Funções de log parecida com os prints personalizados, setadas e personalizadas para todos log levels usado pelo ´logger_uru´, já escreve no arquivo setado além de gerar o print no terminal - **printer** - Funções de print personalizados (alerta, erro, sucesso, informativo) - **regex** - **pattern_in_text** - Função para otimizar o uso mais comum de regex buscando padrões em um texto - **validate** - **mail_validator** - Função para validar lista de emails, devolvendo a lista com emails validos a partir da lista original - **string_validator** - Função que valida presença de letras, palavras, e textos e possibilita contar as ocorrencias em uma string ### Release Versão: **Beta 1.3.1** Lançamento: *20/02/2024* Última atualização: *10/11/2024* Status: Em desenvolvimento. # #### Notas da atualização: 1.3.1 - Correções de bugs em diversas funções relacionadas a tempo: *exec_at_hour* , *wait_for_exec* , *exec_and_wait* - Correções de bugs com tempo superior a 10 minutos nas funções de data: *get_hms* e *get_dma* - Função **get_dma** atualizada e **renomeada** para **get_dmy** para manter o padrão em ingles - Função *send_email* atualizada para suportar autenticação *SSL* ou *TLS* via argumentos recebidos nos parametros - Adicionado parametro de *"display_message"* para o usuario poder ativar ou desativar as mensagens de console em cada função - Correção de bug na função *"count_files"* para realizar de maneira correta a soma de todos arquivos nos diretórios - Funções de regex e busca em textos por strings e palavras atualizadas - Implementado nova função para arquivo de flag para execuções, no submodulo file, as funções são: *"file_flag_create"* e *"file_flag_delete"* - correção de imports no arquivo suite.py das funções *"get_dmy"* e *"search_str_in"* - ajuste de cores no svg da logo rpa-suite ### Mais Sobre Para mais informações, visite nosso projeto no Github ou PyPi:
Ver no GitHub.
Ver projeto publicado no PyPI.
## Actor input object example ```json {} ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("camiloccarvalho/rpasuite").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("camiloccarvalho/rpasuite").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}") for item in client.dataset(run.default_dataset_id).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call camiloccarvalho/rpasuite --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "type": "http", "url": "https://mcp.apify.com/?tools=fetch-actor-details,camiloccarvalho/rpasuite" } } } ``` The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer ` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations). ## OpenAPI specification Download the OpenAPI definition: https://api.apify.com/v2/actors/v9bvnNuA0n85DPfUg/builds/xqL3zhJgeVujEFvdn/openapi.json