Deployed 8e3d990 with MkDocs version: 1.5.3

index.html

@@ -73,7 +73,7 @@
     <div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
         <ul class="nav flex-column">
 
-            <li class="nav-item" data-level="1"><a href="#bem-vindo-a-documentacao-do-meu-projeto" class="nav-link">Bem-vindo à Documentação do Meu Projeto</a>
+            <li class="nav-item" data-level="1"><a href="#bem-vindo-a-documentacao-do-workshop-como-estruturar-um-projeto-do-zero" class="nav-link">Bem-vindo à Documentação do Workshop 'Como estruturar um projeto do Zero'</a>
               <ul class="nav flex-column">
             <li class="nav-item" data-level="2"><a href="#secoes" class="nav-link">Seções</a>
               <ul class="nav flex-column">
@@ -102,24 +102,25 @@
 </div></div>
                     <div class="col-md-9" role="main">
 
-<h1 id="bem-vindo-a-documentacao-do-meu-projeto">Bem-vindo à Documentação do Meu Projeto</h1>
-<p>Aqui você encontrará uma visão geral e detalhada da API do nosso projeto e outras informações pertinentes.</p>
+<h1 id="bem-vindo-a-documentacao-do-workshop-como-estruturar-um-projeto-do-zero">Bem-vindo à Documentação do Workshop 'Como estruturar um projeto do Zero'</h1>
+<p>Este é um projeto exemplo dedicado a demonstrar práticas de refatoração. Neste espaço, você encontrará uma descrição aprofundada da ETL, instruções para instalação, respostas a perguntas frequentes e mais. Seja você um colaborador ou simplesmente alguém com interesse no projeto, esperamos que esta documentação lhe seja útil.</p>
+<p>Além disso, esta documentação pode ser integrada ao Confluence ou a uma intranet interna, facilitando o acesso e colaboração de todos os membros da equipe.</p>
 <h2 id="secoes">Seções</h2>
 <ul>
-<li><a href="#">Introdução</a></li>
-<li><a href="#">Guia de instalação</a></li>
+<li><a href="#introdu%C3%A7%C3%A3o">Introdução</a></li>
+<li><a href="#guia-de-instala%C3%A7%C3%A3o">Guia de Instalação</a></li>
 <li><a href="api/">API</a></li>
-<li><a href="#">FAQ</a></li>
-<li><a href="#">Contato</a></li>
+<li><a href="#faq">FAQ</a></li>
+<li><a href="#contato">Contato</a></li>
 </ul>
 <h2 id="introducao">Introdução</h2>
-<p>Fale um pouco sobre seu projeto aqui.</p>
+<p>O objetivo deste projeto é demonstrar como técnicas de refatoração podem ser aplicadas para melhorar a qualidade do código, otimizar a performance e tornar o software mais manutenível. A refatoração é essencial para manter o código limpo e compreensível, permitindo que equipes mantenham uma alta velocidade de desenvolvimento ao longo do tempo.</p>
 <h2 id="guia-de-instalacao">Guia de Instalação</h2>
-<p>Instruções detalhadas sobre como instalar e configurar seu projeto.</p>
+<p>Aqui, você encontrará instruções detalhadas sobre como instalar e configurar o projeto em seu ambiente local. Seguir as instruções corretamente garante que você tenha uma experiência suave ao trabalhar no projeto.</p>
 <h2 id="faq">FAQ</h2>
-<p>Respostas para perguntas frequentes.</p>
+<p>Esta seção fornece respostas para perguntas frequentes. Se você tiver alguma dúvida que não está coberta aqui, sinta-se à vontade para entrar em contato.</p>
 <h2 id="contato">Contato</h2>
-<p>Informações de contato e como obter suporte.</p></div>
+<p>Para quaisquer dúvidas, feedbacks ou suporte relacionado ao projeto, você pode entrar em contato diretamente através do e-mail: <a href="mailto:lvgalvaofilho@gmail.com">lvgalvaofilho@gmail.com</a>. Estou sempre disposto a ajudar!</p></div>
             </div>
         </div>
 
@@ -202,5 +203,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.5.3
-Build Date UTC : 2023-09-22 05:32:21.716234+00:00
+Build Date UTC : 2023-09-22 05:41:39.022131+00:00
 -->

search/search_index.json

@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Bem-vindo \u00e0 Documenta\u00e7\u00e3o do Meu Projeto Aqui voc\u00ea encontrar\u00e1 uma vis\u00e3o geral e detalhada da API do nosso projeto e outras informa\u00e7\u00f5es pertinentes. Se\u00e7\u00f5es Introdu\u00e7\u00e3o Guia de instala\u00e7\u00e3o API FAQ Contato Introdu\u00e7\u00e3o Fale um pouco sobre seu projeto aqui. Guia de Instala\u00e7\u00e3o Instru\u00e7\u00f5es detalhadas sobre como instalar e configurar seu projeto. FAQ Respostas para perguntas frequentes. Contato Informa\u00e7\u00f5es de contato e como obter suporte.","title":"Home"},{"location":"#bem-vindo-a-documentacao-do-meu-projeto","text":"Aqui voc\u00ea encontrar\u00e1 uma vis\u00e3o geral e detalhada da API do nosso projeto e outras informa\u00e7\u00f5es pertinentes.","title":"Bem-vindo \u00e0 Documenta\u00e7\u00e3o do Meu Projeto"},{"location":"#secoes","text":"Introdu\u00e7\u00e3o Guia de instala\u00e7\u00e3o API FAQ Contato","title":"Se\u00e7\u00f5es"},{"location":"#introducao","text":"Fale um pouco sobre seu projeto aqui.","title":"Introdu\u00e7\u00e3o"},{"location":"#guia-de-instalacao","text":"Instru\u00e7\u00f5es detalhadas sobre como instalar e configurar seu projeto.","title":"Guia de Instala\u00e7\u00e3o"},{"location":"#faq","text":"Respostas para perguntas frequentes.","title":"FAQ"},{"location":"#contato","text":"Informa\u00e7\u00f5es de contato e como obter suporte.","title":"Contato"},{"location":"api/","text":"API Documentation Abaixo, voc\u00ea encontrar\u00e1 detalhes sobre as fun\u00e7\u00f5es e m\u00f3dulos do nosso projeto. M\u00f3dulo consolidador extract def extract(input_folder: str) -> list: \"\"\" Fun\u00e7\u00e3o para extrair dados de arquivos Excel. Args: input_folder (str): Caminho da pasta contendo arquivos Excel. Returns: list: Lista contendo DataFrames do pandas. \"\"\" transform def transform(data: list) -> pd.DataFrame: \"\"\" Fun\u00e7\u00e3o para transformar uma lista de DataFrames em um \u00fanico DataFrame consolidado. Args: data (list): Lista contendo DataFrames para consolida\u00e7\u00e3o. Returns: DataFrame: DataFrame consolidado. \"\"\" load def load(df: pd.DataFrame, output_folder: str, filename: str) -> None: \"\"\" Fun\u00e7\u00e3o para carregar (ou salvar) um DataFrame em um arquivo Excel. Args: df (pd.DataFrame): DataFrame a ser salvo. output_folder (str): Diret\u00f3rio onde o arquivo ser\u00e1 salvo. filename (str): Nome do arquivo Excel. Returns: None \"\"\" consolidate_excels ```python def consolidate_excels(input_folder: str, output_folder: str, filename: str) -> None: \"\"\" Fun\u00e7\u00e3o para consolidar m\u00faltiplos arquivos Excel em um \u00fanico arquivo. Args: input_folder (str): Pasta contendo arquivos Excel. output_folder (str): Pasta onde o arquivo consolidado ser\u00e1 salvo. filename (str): Nome do arquivo Excel consolidado. Returns: None \"\"\"","title":"API"},{"location":"api/#api-documentation","text":"Abaixo, voc\u00ea encontrar\u00e1 detalhes sobre as fun\u00e7\u00f5es e m\u00f3dulos do nosso projeto.","title":"API Documentation"},{"location":"api/#modulo-consolidador","text":"","title":"M\u00f3dulo consolidador"},{"location":"api/#extract","text":"def extract(input_folder: str) -> list: \"\"\" Fun\u00e7\u00e3o para extrair dados de arquivos Excel. Args: input_folder (str): Caminho da pasta contendo arquivos Excel. Returns: list: Lista contendo DataFrames do pandas. \"\"\"","title":"extract"},{"location":"api/#transform","text":"def transform(data: list) -> pd.DataFrame: \"\"\" Fun\u00e7\u00e3o para transformar uma lista de DataFrames em um \u00fanico DataFrame consolidado. Args: data (list): Lista contendo DataFrames para consolida\u00e7\u00e3o. Returns: DataFrame: DataFrame consolidado. \"\"\"","title":"transform"},{"location":"api/#load","text":"def load(df: pd.DataFrame, output_folder: str, filename: str) -> None: \"\"\" Fun\u00e7\u00e3o para carregar (ou salvar) um DataFrame em um arquivo Excel. Args: df (pd.DataFrame): DataFrame a ser salvo. output_folder (str): Diret\u00f3rio onde o arquivo ser\u00e1 salvo. filename (str): Nome do arquivo Excel. Returns: None \"\"\"","title":"load"},{"location":"api/#consolidate_excels","text":"```python def consolidate_excels(input_folder: str, output_folder: str, filename: str) -> None: \"\"\" Fun\u00e7\u00e3o para consolidar m\u00faltiplos arquivos Excel em um \u00fanico arquivo. Args: input_folder (str): Pasta contendo arquivos Excel. output_folder (str): Pasta onde o arquivo consolidado ser\u00e1 salvo. filename (str): Nome do arquivo Excel consolidado. Returns: None \"\"\"","title":"consolidate_excels"}]}
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Bem-vindo \u00e0 Documenta\u00e7\u00e3o do Workshop 'Como estruturar um projeto do Zero' Este \u00e9 um projeto exemplo dedicado a demonstrar pr\u00e1ticas de refatora\u00e7\u00e3o. Neste espa\u00e7o, voc\u00ea encontrar\u00e1 uma descri\u00e7\u00e3o aprofundada da ETL, instru\u00e7\u00f5es para instala\u00e7\u00e3o, respostas a perguntas frequentes e mais. Seja voc\u00ea um colaborador ou simplesmente algu\u00e9m com interesse no projeto, esperamos que esta documenta\u00e7\u00e3o lhe seja \u00fatil. Al\u00e9m disso, esta documenta\u00e7\u00e3o pode ser integrada ao Confluence ou a uma intranet interna, facilitando o acesso e colabora\u00e7\u00e3o de todos os membros da equipe. Se\u00e7\u00f5es Introdu\u00e7\u00e3o Guia de Instala\u00e7\u00e3o API FAQ Contato Introdu\u00e7\u00e3o O objetivo deste projeto \u00e9 demonstrar como t\u00e9cnicas de refatora\u00e7\u00e3o podem ser aplicadas para melhorar a qualidade do c\u00f3digo, otimizar a performance e tornar o software mais manuten\u00edvel. A refatora\u00e7\u00e3o \u00e9 essencial para manter o c\u00f3digo limpo e compreens\u00edvel, permitindo que equipes mantenham uma alta velocidade de desenvolvimento ao longo do tempo. Guia de Instala\u00e7\u00e3o Aqui, voc\u00ea encontrar\u00e1 instru\u00e7\u00f5es detalhadas sobre como instalar e configurar o projeto em seu ambiente local. Seguir as instru\u00e7\u00f5es corretamente garante que voc\u00ea tenha uma experi\u00eancia suave ao trabalhar no projeto. FAQ Esta se\u00e7\u00e3o fornece respostas para perguntas frequentes. Se voc\u00ea tiver alguma d\u00favida que n\u00e3o est\u00e1 coberta aqui, sinta-se \u00e0 vontade para entrar em contato. Contato Para quaisquer d\u00favidas, feedbacks ou suporte relacionado ao projeto, voc\u00ea pode entrar em contato diretamente atrav\u00e9s do e-mail: lvgalvaofilho@gmail.com . Estou sempre disposto a ajudar!","title":"Home"},{"location":"#bem-vindo-a-documentacao-do-workshop-como-estruturar-um-projeto-do-zero","text":"Este \u00e9 um projeto exemplo dedicado a demonstrar pr\u00e1ticas de refatora\u00e7\u00e3o. Neste espa\u00e7o, voc\u00ea encontrar\u00e1 uma descri\u00e7\u00e3o aprofundada da ETL, instru\u00e7\u00f5es para instala\u00e7\u00e3o, respostas a perguntas frequentes e mais. Seja voc\u00ea um colaborador ou simplesmente algu\u00e9m com interesse no projeto, esperamos que esta documenta\u00e7\u00e3o lhe seja \u00fatil. Al\u00e9m disso, esta documenta\u00e7\u00e3o pode ser integrada ao Confluence ou a uma intranet interna, facilitando o acesso e colabora\u00e7\u00e3o de todos os membros da equipe.","title":"Bem-vindo \u00e0 Documenta\u00e7\u00e3o do Workshop 'Como estruturar um projeto do Zero'"},{"location":"#secoes","text":"Introdu\u00e7\u00e3o Guia de Instala\u00e7\u00e3o API FAQ Contato","title":"Se\u00e7\u00f5es"},{"location":"#introducao","text":"O objetivo deste projeto \u00e9 demonstrar como t\u00e9cnicas de refatora\u00e7\u00e3o podem ser aplicadas para melhorar a qualidade do c\u00f3digo, otimizar a performance e tornar o software mais manuten\u00edvel. A refatora\u00e7\u00e3o \u00e9 essencial para manter o c\u00f3digo limpo e compreens\u00edvel, permitindo que equipes mantenham uma alta velocidade de desenvolvimento ao longo do tempo.","title":"Introdu\u00e7\u00e3o"},{"location":"#guia-de-instalacao","text":"Aqui, voc\u00ea encontrar\u00e1 instru\u00e7\u00f5es detalhadas sobre como instalar e configurar o projeto em seu ambiente local. Seguir as instru\u00e7\u00f5es corretamente garante que voc\u00ea tenha uma experi\u00eancia suave ao trabalhar no projeto.","title":"Guia de Instala\u00e7\u00e3o"},{"location":"#faq","text":"Esta se\u00e7\u00e3o fornece respostas para perguntas frequentes. Se voc\u00ea tiver alguma d\u00favida que n\u00e3o est\u00e1 coberta aqui, sinta-se \u00e0 vontade para entrar em contato.","title":"FAQ"},{"location":"#contato","text":"Para quaisquer d\u00favidas, feedbacks ou suporte relacionado ao projeto, voc\u00ea pode entrar em contato diretamente atrav\u00e9s do e-mail: lvgalvaofilho@gmail.com . Estou sempre disposto a ajudar!","title":"Contato"},{"location":"api/","text":"API Documentation Abaixo, voc\u00ea encontrar\u00e1 detalhes sobre as fun\u00e7\u00f5es e m\u00f3dulos do nosso projeto. M\u00f3dulo consolidador extract def extract(input_folder: str) -> list: \"\"\" Fun\u00e7\u00e3o para extrair dados de arquivos Excel. Args: input_folder (str): Caminho da pasta contendo arquivos Excel. Returns: list: Lista contendo DataFrames do pandas. \"\"\" transform def transform(data: list) -> pd.DataFrame: \"\"\" Fun\u00e7\u00e3o para transformar uma lista de DataFrames em um \u00fanico DataFrame consolidado. Args: data (list): Lista contendo DataFrames para consolida\u00e7\u00e3o. Returns: DataFrame: DataFrame consolidado. \"\"\" load def load(df: pd.DataFrame, output_folder: str, filename: str) -> None: \"\"\" Fun\u00e7\u00e3o para carregar (ou salvar) um DataFrame em um arquivo Excel. Args: df (pd.DataFrame): DataFrame a ser salvo. output_folder (str): Diret\u00f3rio onde o arquivo ser\u00e1 salvo. filename (str): Nome do arquivo Excel. Returns: None \"\"\" consolidate_excels ```python def consolidate_excels(input_folder: str, output_folder: str, filename: str) -> None: \"\"\" Fun\u00e7\u00e3o para consolidar m\u00faltiplos arquivos Excel em um \u00fanico arquivo. Args: input_folder (str): Pasta contendo arquivos Excel. output_folder (str): Pasta onde o arquivo consolidado ser\u00e1 salvo. filename (str): Nome do arquivo Excel consolidado. Returns: None \"\"\"","title":"API"},{"location":"api/#api-documentation","text":"Abaixo, voc\u00ea encontrar\u00e1 detalhes sobre as fun\u00e7\u00f5es e m\u00f3dulos do nosso projeto.","title":"API Documentation"},{"location":"api/#modulo-consolidador","text":"","title":"M\u00f3dulo consolidador"},{"location":"api/#extract","text":"def extract(input_folder: str) -> list: \"\"\" Fun\u00e7\u00e3o para extrair dados de arquivos Excel. Args: input_folder (str): Caminho da pasta contendo arquivos Excel. Returns: list: Lista contendo DataFrames do pandas. \"\"\"","title":"extract"},{"location":"api/#transform","text":"def transform(data: list) -> pd.DataFrame: \"\"\" Fun\u00e7\u00e3o para transformar uma lista de DataFrames em um \u00fanico DataFrame consolidado. Args: data (list): Lista contendo DataFrames para consolida\u00e7\u00e3o. Returns: DataFrame: DataFrame consolidado. \"\"\"","title":"transform"},{"location":"api/#load","text":"def load(df: pd.DataFrame, output_folder: str, filename: str) -> None: \"\"\" Fun\u00e7\u00e3o para carregar (ou salvar) um DataFrame em um arquivo Excel. Args: df (pd.DataFrame): DataFrame a ser salvo. output_folder (str): Diret\u00f3rio onde o arquivo ser\u00e1 salvo. filename (str): Nome do arquivo Excel. Returns: None \"\"\"","title":"load"},{"location":"api/#consolidate_excels","text":"```python def consolidate_excels(input_folder: str, output_folder: str, filename: str) -> None: \"\"\" Fun\u00e7\u00e3o para consolidar m\u00faltiplos arquivos Excel em um \u00fanico arquivo. Args: input_folder (str): Pasta contendo arquivos Excel. output_folder (str): Pasta onde o arquivo consolidado ser\u00e1 salvo. filename (str): Nome do arquivo Excel consolidado. Returns: None \"\"\"","title":"consolidate_excels"}]}