rpa-suite


Namerpa-suite JSON
Version 0.9.1 PyPI version JSON
download
home_page
SummaryConjunto de ferramentas essenciais para Automação RPA com Python, que facilitam o dia a dia de desenvolvimento.
upload_time2024-02-20 19:37:41
maintainer
docs_urlNone
authorCamilo Costa de Carvalho
requires_python
licenseMIT
keywords basic-tools email-tools email-validation file-tools simple-functions rpa-tools rpa-functions tools rpa automation rpa automação python ferramentas de rpa automação de processos biblioteca python para rpa
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![RPA Suite](https://raw.githubusercontent.com/CamiloCCarvalho/rpa_suite/3e1ccd0acad654916466f03c2b8f166dc8d360d4/logo-rpa-suite.svg)


<h1 align="left">
    RPA Suite
</h1>
<br>

![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
  
## 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ções para aguardar em relação a execução de uma função, podendo ser antes ou depois
        - **exec_at** - Funções para executar em momentos pré determinados
    - **date**
        - **date** - Funções para capturar data, mes, ano, hora, minutos de forma individual em apenas uma linha
    - **email**
        - **sender_smtp** - Funções para envio de email SMPT 
    - **file**
        - **counter** - Funções para contagens
        - **temp_dir** - Funções para diretórios temporários
    - **log**
        - **loggin** - Funções decoradoras com log de execução das funções
        - **printer** - Funções print personalizados (alerta, erro, sucesso, informativo)
    - **regex**
        - **list_from_text** - Funções para gerar listas, dividindo texto usando padrão regex
    - **validate**
        - **mail_validator** - Funções para validação de emails
        - **string_validator** - Funções para validação/varredura (strings, substrings, palavras)

## Release
Versão: **Alpha 0.9.1**

Lançamento: *20/02/2024*

Status: Em desenvolvimento.


## Mais Sobre

Para mais informações, visite nosso projeto no Github ou PyPi:
<br>
<a href='https://github.com/CamiloCCarvalho/rpa_suite' target='_blank'>
    Ver no GitHub.
</a>
<br>
<a href='https://pypi.org/project/rpa-suite/' target='_blank'>
    Ver projeto publicado no PyPI.
</a>

<hr>

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "rpa-suite",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "basic-tools,email-tools,email-validation,file-tools,simple-functions,rpa-tools,rpa-functions,Tools,Rpa,Automation,RPA,Automa\u00e7\u00e3o,Python,Ferramentas de RPA,Automa\u00e7\u00e3o de Processos,Biblioteca Python para RPA",
    "author": "Camilo Costa de Carvalho",
    "author_email": "camilo.carvalho@triasoftware.com.br",
    "download_url": "https://files.pythonhosted.org/packages/a3/c7/ee2b111bac8ec39859c6f650e650e0ebe168a0005c31df75ed9488e0ea67/rpa_suite-0.9.1.tar.gz",
    "platform": null,
    "description": "![RPA Suite](https://raw.githubusercontent.com/CamiloCCarvalho/rpa_suite/3e1ccd0acad654916466f03c2b8f166dc8d360d4/logo-rpa-suite.svg)\r\n\r\n\r\n<h1 align=\"left\">\r\n    RPA Suite\r\n</h1>\r\n<br>\r\n\r\n![PyPI Latest Release](https://img.shields.io/pypi/v/rpa-suite.svg)\r\n![PyPI Downloads](https://img.shields.io/pypi/dm/rpa-suite.svg?label=PyPI%20downloads)\r\n\r\n-----------------\r\n\r\n## O que \u00e9?\r\n**RPA Suite:** um conjunto abrangente de ferramentas projetadas para simplificar e otimizar o desenvolvimento de projetos de automa\u00e7\u00e3o RPA com Python. Embora nossa su\u00edte seja um conjunto de Ferramentas de RPA especializado, sua versatilidade a torna igualmente \u00fatil 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\u00f4s de Software.\r\n\r\n## Sum\u00e1rio do conteudo\r\n\r\n- [Destaque](#destaque)\r\n- [Objetivo](#objetivo)\r\n- [Instala\u00e7\u00e3o](#instala\u00e7\u00e3o)\r\n- [Exemplo](#exemplo)\r\n- [Depend\u00eancias](#depend\u00eancias)\r\n- [Estrutura do m\u00f3dulo](#estrutura-do-m\u00f3dulo)\r\n- [Vers\u00e3o do projeto](#vers\u00e3o-do-projeto)\r\n- [Mais Sobre](#mais-sobre)\r\n\r\n## Destaque\r\n\r\n**Vers\u00e1til**: Al\u00e9m da Automa\u00e7\u00e3o de Processos e cria\u00e7\u00e3o de BOT em RPA, mas tamb\u00e9m para uso geral podendo  ser aplicadas em outros modelos de projeto, *al\u00e9m do RPA*.\r\n\r\n**Simples**: Constru\u00edmos as ferramentas de maneira mais direta e assertiva poss\u00edvel, utilizando apenas bibliotecas conhecidas no mercado para garantir o melhor desempenho poss\u00edvel.\r\n\r\n## Objetivo\r\n\r\nNosso objetivo \u00e9 se tornar a Biblioteca Python para RPA refer\u00eancia. Tornando o desenvolvimento de RPAs mais produtivo, oferecendo uma gama de fun\u00e7\u00f5es para tal:\r\n\r\n- Envio de emails (j\u00e1 configurado e personalizavel)\r\n- Valida\u00e7\u00e3o de emails (limpeza e tratamento)\r\n- Busca por palavras, strings ou substrings (patterns) em textos.\r\n- Cria\u00e7\u00e3o e dele\u00e7\u00e3o de pasta/arquivo tempor\u00e1rio com um comando\r\n- Console com mensagens de melhor visualiza\u00e7\u00e3o com cores definidas para alerta, erro, informativo e sucesso.\r\n- E muito mais\r\n\r\n## Instala\u00e7\u00e3o\r\nPara **instalar** o projeto, utilize o comando:\r\n\r\n~~~python\r\n>>> python -m pip install rpa-suite\r\n~~~\r\nou no conda:\r\n~~~python\r\nconda install -c conda-forge rpa-suite\r\n~~~\r\n\r\nAp\u00f3s instala\u00e7\u00e3o basta fazer a importa\u00e7\u00e3o do modulo e instanciar o Objeto ``suite``:\r\n~~~~python\r\nfrom rpa_suite import suite as rpa\r\n~~~~\r\n\r\nFeito isso j\u00e1 estar\u00e1 pronto para o uso:\r\n~~~~python\r\n# function send mail by SMTP \r\nrpa.send_mail(...)\r\n~~~~\r\n\r\n>[!NOTE]\r\n>\r\n>Para **desinstalar** o projeto, utilize o comando abaixo.\r\n>**Obs.:** como usamos algumas libs no projeto, lembre-se de desinstar elas caso necess\u00e1rio.\r\n\r\n~~~~python\r\n>>> python -m pip uninstall rpa-suite\r\n~~~~\r\n\r\n>[!IMPORTANT]\r\n>\r\n>Opcionalmente voc\u00ea pode querer desinstalar as libs que foram inclusas no projeto, sendo assim:\r\n\r\n~~~~python\r\n>>> python -m pip uninstall loguru mail_validator colorama\r\n~~~~\r\n\r\n\r\n## Exemplo\r\nDo m\u00f3dulo principal, importe a suite. Ela retorna uma inst\u00e2ncia do Objeto de classe Rpa_suite, onde possui vari\u00e1veis apontando para todas fun\u00e7\u00f5es dos subm\u00f3dulos:\r\n\r\n    from rpa_suite import suite as rpa\r\n\r\n    # Usando a fun\u00e7\u00e3o de envio de email por SMTP default\r\n    rpa.send_email(my_email, my_pass, mail_to, subject, message_body)\r\n\r\n\r\n    # Usando subm\u00f3dulo clock para aguardar 30 (seg) e ent\u00e3o executar uma fun\u00e7\u00e3o\r\n    time = 30\r\n    rpa.wait_for_exec(time, my_function, param1, param2)\r\n\r\n\r\n## Depend\u00eancias\r\nNo setup do nosso projeto j\u00e1 est\u00e3o inclusas as depend\u00eancias, s\u00f3 ser\u00e1 necess\u00e1rio instalar nossa **Lib**, mas segue a lista das libs usadas:\r\n- colorama\r\n- loguru\r\n- email-validator\r\n  \r\n## Estrutura do m\u00f3dulo\r\nO m\u00f3dulo principal do rpa-suite \u00e9 dividido em categorias. Cada categoria cont\u00e9m m\u00f3dulos com fun\u00e7\u00f5es destinadas a cada tipo de tarefa\r\n- **rpa_suite**\r\n    - **clock**\r\n        - **waiter** - Fun\u00e7\u00f5es para aguardar em rela\u00e7\u00e3o a execu\u00e7\u00e3o de uma fun\u00e7\u00e3o, podendo ser antes ou depois\r\n        - **exec_at** - Fun\u00e7\u00f5es para executar em momentos pr\u00e9 determinados\r\n    - **date**\r\n        - **date** - Fun\u00e7\u00f5es para capturar data, mes, ano, hora, minutos de forma individual em apenas uma linha\r\n    - **email**\r\n        - **sender_smtp** - Fun\u00e7\u00f5es para envio de email SMPT \r\n    - **file**\r\n        - **counter** - Fun\u00e7\u00f5es para contagens\r\n        - **temp_dir** - Fun\u00e7\u00f5es para diret\u00f3rios tempor\u00e1rios\r\n    - **log**\r\n        - **loggin** - Fun\u00e7\u00f5es decoradoras com log de execu\u00e7\u00e3o das fun\u00e7\u00f5es\r\n        - **printer** - Fun\u00e7\u00f5es print personalizados (alerta, erro, sucesso, informativo)\r\n    - **regex**\r\n        - **list_from_text** - Fun\u00e7\u00f5es para gerar listas, dividindo texto usando padr\u00e3o regex\r\n    - **validate**\r\n        - **mail_validator** - Fun\u00e7\u00f5es para valida\u00e7\u00e3o de emails\r\n        - **string_validator** - Fun\u00e7\u00f5es para valida\u00e7\u00e3o/varredura (strings, substrings, palavras)\r\n\r\n## Release\r\nVers\u00e3o: **Alpha 0.9.1**\r\n\r\nLan\u00e7amento: *20/02/2024*\r\n\r\nStatus: Em desenvolvimento.\r\n\r\n\r\n## Mais Sobre\r\n\r\nPara mais informa\u00e7\u00f5es, visite nosso projeto no Github ou PyPi:\r\n<br>\r\n<a href='https://github.com/CamiloCCarvalho/rpa_suite' target='_blank'>\r\n    Ver no GitHub.\r\n</a>\r\n<br>\r\n<a href='https://pypi.org/project/rpa-suite/' target='_blank'>\r\n    Ver projeto publicado no PyPI.\r\n</a>\r\n\r\n<hr>\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Conjunto de ferramentas essenciais para Automa\u00e7\u00e3o RPA com Python, que facilitam o dia a dia de desenvolvimento.",
    "version": "0.9.1",
    "project_urls": null,
    "split_keywords": [
        "basic-tools",
        "email-tools",
        "email-validation",
        "file-tools",
        "simple-functions",
        "rpa-tools",
        "rpa-functions",
        "tools",
        "rpa",
        "automation",
        "rpa",
        "automa\u00e7\u00e3o",
        "python",
        "ferramentas de rpa",
        "automa\u00e7\u00e3o de processos",
        "biblioteca python para rpa"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "350d804f2b2340c229125d0aad9585401c3eeb37f506bd994841c4ab537dc136",
                "md5": "20de00a8683f25cc3b55f9422913f29a",
                "sha256": "e49e916b39874273d642de923a2acfe8014a4bd5270309cfd83f47ddfa076e3e"
            },
            "downloads": -1,
            "filename": "rpa_suite-0.9.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "20de00a8683f25cc3b55f9422913f29a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 22754,
            "upload_time": "2024-02-20T19:37:29",
            "upload_time_iso_8601": "2024-02-20T19:37:29.111053Z",
            "url": "https://files.pythonhosted.org/packages/35/0d/804f2b2340c229125d0aad9585401c3eeb37f506bd994841c4ab537dc136/rpa_suite-0.9.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a3c7ee2b111bac8ec39859c6f650e650e0ebe168a0005c31df75ed9488e0ea67",
                "md5": "0944421aaaf8ca0aa33ee50696a4993b",
                "sha256": "9790106389a028c7c4494bcd29d6e632f80fa585654793e3bc1f6e08fb90d0f5"
            },
            "downloads": -1,
            "filename": "rpa_suite-0.9.1.tar.gz",
            "has_sig": false,
            "md5_digest": "0944421aaaf8ca0aa33ee50696a4993b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 20231,
            "upload_time": "2024-02-20T19:37:41",
            "upload_time_iso_8601": "2024-02-20T19:37:41.881103Z",
            "url": "https://files.pythonhosted.org/packages/a3/c7/ee2b111bac8ec39859c6f650e650e0ebe168a0005c31df75ed9488e0ea67/rpa_suite-0.9.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-20 19:37:41",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "rpa-suite"
}
        
Elapsed time: 0.23542s