md files ok

m2f0 · Jun 23, 2024 · dc624a3 · dc624a3
1 parent 3fc0318
commit dc624a3
Show file tree

Hide file tree

Showing 3 changed files with 140 additions and 43 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,22 +2,94 @@
 
 Obrigado por considerar contribuir para o dataGPT! Aqui estão algumas diretrizes para ajudar você a começar:
 
-## Como contribuir
+## Como Contribuir
 
 1. Faça um fork do repositório.
 2. Crie uma branch para sua feature (`git checkout -b feature/nome-da-feature`).
 3. Commit suas mudanças (`git commit -m 'Adiciona nova feature'`).
 4. Envie para o branch (`git push origin feature/nome-da-feature`).
 5. Abra um Pull Request.
 
-## Reportando problemas
+## Reportando Problemas
 
-Se você encontrar um bug ou tiver uma sugestão, por favor abra uma issue no repositório.
+Se você encontrar um bug ou tiver uma sugestão, por favor, abra uma issue no repositório.
 
 ## Testes
 
 Certifique-se de que suas mudanças passaram nos testes antes de enviar um Pull Request. Adicione testes para qualquer nova funcionalidade adicionada.
 
+## Estilo de Código
+
+Siga as seguintes diretrizes de estilo de código para garantir a consistência no código-base:
+
+### Mensagens de Commit
+
+- Use o tempo presente ("Adiciona feature" e não "Adicionou feature")
+- Use o modo imperativo ("Move cursor para..." e não "Moveu cursor para...")
+- Limite a primeira linha a 72 caracteres ou menos
+- Referencie issues e pull requests liberamente
+- Considere iniciar a mensagem de commit com um emoji aplicável:
+  - :tada: `:tada:` quando criar uma nova release
+  - :bug: `:bug:` quando corrigir um bug
+  - :memo: `:memo:` quando escrever documentação
+
+### Estilo de Código Python
+
+Siga o guia de estilo [PEP 8](https://pep8.org/).
+
+### Estilo de Documentação
+
+Siga o [Guia de Estilo do Google](https://google.github.io/styleguide/pyguide.html) para documentação.
+
 ## Código de Conduta
 
 Por favor, leia nosso [Código de Conduta](CODE_OF_CONDUCT.md) para entender nossas expectativas em relação à participação da comunidade.
+
+---
+
+# Contributing to dataGPT
+
+Thank you for considering contributing to dataGPT! Here are some guidelines to help you get started:
+
+## How to Contribute
+
+1. Fork the repository.
+2. Create a branch for your feature (`git checkout -b feature/feature-name`).
+3. Commit your changes (`git commit -m 'Add new feature'`).
+4. Push to the branch (`git push origin feature/feature-name`).
+5. Open a Pull Request.
+
+## Reporting Issues
+
+If you find a bug or have a suggestion, please open an issue in the repository.
+
+## Tests
+
+Ensure that your changes pass the tests before submitting a Pull Request. Add tests for any new functionality added.
+
+## Code Style
+
+Follow these code style guidelines to ensure consistency in the codebase:
+
+### Git Commit Messages
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moved cursor to...")
+- Limit the first line to 72 characters or less
+- Reference issues and pull requests liberally
+- Consider starting the commit message with an applicable emoji:
+  - :tada: `:tada:` when you create a release
+  - :bug: `:bug:` when you fix a bug
+  - :memo: `:memo:` when you write docs
+
+### Python Code Style
+
+Refer to the [PEP 8](https://pep8.org/) style guide for Python code.
+
+### Documentation Style
+
+Follow the [Google Style Guide](https://google.github.io/styleguide/pyguide.html) for documentation.
+
+## Code of Conduct
+
+Please read our [Code of Conduct](CODE_OF_CONDUCT.md) to understand our expectations regarding community participation.
diff --git a/LICENSE b/LICENSE
@@ -1,3 +1,27 @@
+Licença MIT
+
+Direitos Autorais (c) 2024 Mario Mayerle Filho
+
+A permissão é concedida, gratuitamente, a qualquer pessoa que obtenha uma cópia
+deste software e dos arquivos de documentação associados (o "Software"), para lidar
+com o Software sem restrição, incluindo, sem limitação, os direitos de usar,
+copiar, modificar, mesclar, publicar, distribuir, sublicenciar e/ou vender
+cópias do Software, e permitir às pessoas a quem o Software é
+fornecido a fazer isso, sujeitas às seguintes condições:
+
+O aviso de direitos autorais acima e este aviso de permissão devem ser incluídos em todas
+as cópias ou partes substanciais do Software.
+
+O SOFTWARE É FORNECIDO "COMO ESTÁ", SEM GARANTIA DE QUALQUER TIPO, EXPRESSA OU
+IMPLÍCITA, INCLUINDO, MAS NÃO SE LIMITANDO ÀS GARANTIAS DE COMERCIALIZAÇÃO,
+ADEQUAÇÃO A UM DETERMINADO FIM E NÃO VIOLAÇÃO. EM NENHUM CASO OS
+AUTORES OU TITULARES DOS DIREITOS AUTORAIS SERÃO RESPONSÁVEIS POR QUALQUER REIVINDICAÇÃO, DANOS OU OUTRAS
+RESPONSABILIDADES, SEJA EM UMA AÇÃO DE CONTRATO, DELITO OU DE OUTRA FORMA, DECORRENTE DE,
+FORA DE OU EM CONEXÃO COM O SOFTWARE OU O USO OU OUTRAS NEGOCIAÇÕES NO
+SOFTWARE.
+
+---
+
 MIT License
 
 Copyright (c) 2024 Mario Mayerle Filho

diff --git a/README.md b/README.md
@@ -11,15 +11,15 @@ Uma aplicação para visualizar dados do Google Sheets compartilhados via Google
 Tabela de Conteúdos
 -------------------
 
-- Sobre
-- Primeiros Passos
-- Deployment
-- Uso
-- Construído Usando
-- TODO
-- Contribuindo
-- Autores
-- Agradecimentos
+- [Sobre](#sobre)
+- [Primeiros Passos](#primeiros-passos)
+- [Deployment](#deployment)
+- [Uso](#uso)
+- [Construído Usando](#construído-usando)
+- [TODO](#todo)
+- [Contribuindo](#contribuindo)
+- [Autores](#autores)
+- [Agradecimentos](#agradecimentos)
 
 Sobre
 -----
@@ -40,7 +40,6 @@ pip install -r requirements.txt
 ```
 
 ### Instalando
-
 Um passo a passo da série de exemplos que informam como obter um ambiente de desenvolvimento em funcionamento:
 
 Clonar o repositório:
@@ -52,38 +51,32 @@ cd dataGPT
 
 Instalar as dependências:
 
-```sh
+```
 pip install -r requirements.txt
 ```
 
 ### Configuração do Ambiente
-
-Criar um arquivo `config.py` com as configurações necessárias, incluindo a chave da API e a rede neural selecionada:
+Criar um arquivo config.py com as configurações necessárias, incluindo a chave da API e a rede neural selecionada:
 
 ```python
 # config.py
 API_KEY = 'sua_chave_api_aqui'
 NEURAL_NETWORK = 'rede_neural_selecionada'
 ```
 
-Uso
----
-
+### Uso
 Para executar a aplicação, use o seguinte comando:
 
 ```sh
 streamlit run app.py
 ```
 
-Abra o navegador e acesse `http://localhost:8501`.
-
-Deployment
-----------
+Abra o navegador e acesse http://localhost:8501.
 
+### Deployment
 Para implantar este projeto, siga as etapas abaixo.
 
-### Configuração do Nginx
-
+Configuração do Nginx
 1. Instale o Nginx:
 
 ```sh
@@ -99,7 +92,7 @@ sudo nano /etc/nginx/sites-available/dataGPT
 
 Adicione a seguinte configuração:
 
-```
+```bash
 server {
     listen 80;
     server_name free.datagpt.com.br;
@@ -148,9 +141,13 @@ Crie um serviço systemd para garantir que a aplicação inicie automaticamente:
 sudo nano /etc/systemd/system/datagpt.service
 ```
 
+```sh
+sudo nano /etc/systemd/system/datagpt.service
+```
+
 Adicione o seguinte conteúdo:
 
-```
+```makefile
 [Unit]
 Description=Streamlit instance to serve dataGPT
 After=network.target
@@ -173,26 +170,30 @@ sudo systemctl start datagpt
 sudo systemctl enable datagpt
 ```
 
-Construído Usando
------------------
+### Construído Usando
+[Streamlit](https://streamlit.io/) - Framework 
+[Plotly](https://plotly.com/python/) - Biblioteca de Gráficos
+[Pandas](https://pandas.pydata.org/) - Biblioteca de Análise de Dados
+[Python](https://www.python.org/) - Linguagem de Programação
+
+### TODO
+
+ - Adicionar mais tipos de gráficos
+ - Melhorar a interface de usuário
+ - Implementar autenticação de usuário
 
-- [Streamlit](https://streamlit.io/) - Framework
-- [Plotly](https://plotly.com/python/) - Biblioteca de Gráficos
-- [Pandas](https://pandas.pydata.org/) - Biblioteca de Análise de Dados
-- [Python](https://www.python.org/) - Linguagem de Programação
+### Contribuindo
+
+Por favor, leia nosso Guia de Contribuição para detalhes sobre nosso código de conduta e o processo para enviar pull requests para nós.
 
 Autores
--------
+[@m2f](https://github.com/m2f0) - Ideia & Trabalho inicial
 
-- [@m2f0](https://github.com/m2f0) - Ideia & Trabalho inicial
+### Agradecimentos
 
-Veja também a lista de [colaboradores](https://github.com/seuusuario/dataGPT/graphs/contributors) que participaram deste projeto.
+[Streamlit](https://streamlit.io/)
+[Plotly](https://plotly.com/python/)
+[Pandas](https://pandas.pydata.org/)
+[GitHub](https://www.python.org/)
 
-Agradecimentos
---------------
 
-- [Streamlit](https://streamlit.io/)
-- [Plotly](https://plotly.com/)
-- [Pandas](https://pandas.pydata.org/)
-- [GitHub](https://github.com/)
-```