diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml new file mode 100644 index 0000000..3483538 --- /dev/null +++ b/.github/workflows/python-app.yml @@ -0,0 +1,45 @@ +name: Python application + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +permissions: + contents: read + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Set up Python 3.11 + uses: actions/setup-python@v3 + with: + python-version: "3.11" + + - name: Cache pip dependencies + uses: actions/cache@v2 + with: + path: ~/.cache/pip + key: ${{ runner.os }}-pip-${{ hashFiles('**/prod_requirements.txt') }} + restore-keys: | + ${{ runner.os }}-pip- + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install pytest flake8 + if [ -f prod_requirements.txt ]; then pip install -r prod_requirements.txt; fi + + - name: Lint with flake8 + run: | + flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics + flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + + - name: Test with pytest + run: | + python -m pytest ./tests diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..9b38853 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,7 @@ +{ + "python.testing.pytestArgs": [ + "tests" + ], + "python.testing.unittestEnabled": false, + "python.testing.pytestEnabled": true +} \ No newline at end of file diff --git a/README.md b/README.md index 27035a7..5ac1c5a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,60 @@ -# pixzinho-whatsapp-bot - +# Pixzinho Bot + +![Banner ou Logo do Projeto](src/banner.png) + +O **Pixzinho Bot** é um assistente virtual financeiro robusto e gratuito, desenvolvido para ajudar os usuários a gerenciar suas finanças pessoais, interagindo através do WhatsApp e utilizando a tecnologia de processamento de linguagem natural do GPT. + +## Índice + +- [Visão Geral](#visão-geral) +- [Funcionalidades](#funcionalidades) +- [Instalação](#instalação) +- [Como Contribuir](#como-contribuir) +- [Licença](#licença) +- [Equipe e Reconhecimentos](#equipe-e-reconhecimentos) + +## Visão Geral + +No cenário financeiro atual, a gestão adequada das finanças pessoais é mais importante do que nunca. **Pixzinho Bot** foi criado com o objetivo de ser um companheiro financeiro, sempre disponível no seu WhatsApp para ajudar em suas necessidades financeiras. + +## Funcionalidades + +- **Gestão de Contas**: Cadastre e monitore suas contas diretamente através do bot. +- **Dicas Financeiras**: Receba dicas personalizadas para otimizar seus gastos e investimentos. +- **Alertas e Lembretes**: Seja notificado sobre datas de vencimento, metas financeiras e outros. +- **Interatividade Avançada**: Utilizando GPT, o bot entende e responde de forma natural. + +## Instalação + +1. Clone este repositório: +``` +git clone https://github.com/gustavosett/pixzinho-whatsapp-bot.git +``` + +2. Navegue até o diretório do projeto: +``` +cd pixzinho-whatsapp-bot +``` + +3. Siga as [instruções detalhadas](#TODO) para configurar as variáveis de ambiente, instalar dependências e inicializar o bot. + +## Como Contribuir + +Contribuições são muito bem-vindas! Aqui estão algumas maneiras de contribuir: + +1. **Proponha Novas Funcionalidades**: Se você tem uma ideia de como melhorar o bot, abra uma issue! +2. **Reporte Bugs**: Encontrou um problema? Reporte na seção de issues. +3. **Melhore a Documentação**: Pode ser no README, ou em qualquer outra parte do projeto. +4. **Submeta Pull Requests**: Melhorias de código, correções de bugs, e novas funcionalidades são muito bem-vindas. + +Por favor, leia o [guia de contribuição](LINK_PARA_GUIA_DE_CONTRIBUIÇÃO) para informações detalhadas sobre como contribuir com o projeto. + +## Licença + +Este projeto está licenciado sob a licença MIT - veja o arquivo [LICENSE.md](LICENSE.md) para detalhes. + +## Equipe e Reconhecimentos + +- **Gustavo** - Fundador e Desenvolvedor Principal - [GitHub](https://github.com/gustavosett/) + +Agradecimentos especiais para todos os [contribuidores](#TODO) que ajudaram a dar vida a este projeto! diff --git a/src/avatar.jpg b/src/avatar.jpg new file mode 100644 index 0000000..18c2d84 Binary files /dev/null and b/src/avatar.jpg differ diff --git a/src/banner.png b/src/banner.png new file mode 100644 index 0000000..6e49330 Binary files /dev/null and b/src/banner.png differ diff --git a/src/full_body.jpeg b/src/full_body.jpeg new file mode 100644 index 0000000..e85f81d Binary files /dev/null and b/src/full_body.jpeg differ