Skip to content

Commit

Permalink
prepara workflow e cria readme (#3)
Browse files Browse the repository at this point in the history
* Create python-app.yml

* Update README.md

* add images

* set workflow

* corrige workflow

* Corrige workflow 2
  • Loading branch information
gustavosett authored Oct 13, 2023
1 parent 0f31b5a commit f549799
Show file tree
Hide file tree
Showing 6 changed files with 112 additions and 2 deletions.
45 changes: 45 additions & 0 deletions .github/workflows/python-app.yml
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"python.testing.pytestArgs": [
"tests"
],
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true
}
62 changes: 60 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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!
Binary file added src/avatar.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/full_body.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f549799

Please sign in to comment.