finange / finange-bot Goto Github PK

View Code? Open in Web Editor NEW

10.0 2.0 10.0 88 KB

Finange Telegram Bot

License: MIT License

Dockerfile 1.40% Python 98.60%

python3

finange-bot's Introduction

Finange Bot

Como Contribuir

Antes de continuar a leitura, para ter acesso à documentação completa do projeto, links dos repositórios do Front-End e Back-End (este que você está agora é parte do Back-End, contando com o repo da API) e um passo a passo para contribuir, você pode acessar os dois links abaixo:

Documentação completa
Passo a passo para contribuição

Primeiro, você vai precisar criar um Bot no seu telegram. Você ver como faz isso aqui!

"Ah, mas por que eu preciso criar um Bot meu, sendo que quero contribuir pro Finange?"! Muito simples! Cada Bot do Telegram funciona por meio de um Token, então, para que você pudesse contribuir diretamente pro Finange, você precisaria ter o Token OFICIAL do Finange, e, por motivos de segurança, isso NÃO é uma opção.

Logo, a forma mais segura de existir esse projeto no formato Open Source é você criar um Bot de simulação, em que você vai rodar o nosso código no seu próprio Bot, testar, ver tudo bonitinho dentro do seu próprio Bot, e, então, você sobe as features/correções para o Finange, entendeu?! Qualquer dúvida, só abrir um issue aqui no nosso repositorio que vamos tirar suas dúvidas!

Agora que você já criou seu Bot, você vai precisar adicionar o Token em um arquivo .env. Siga os passos abaixo:

Crie um arquivo .env no diretório do projeto.

Adicione a seguinte linha de comando no arquivo.env e cole seu token dentro das aspas:

TOKEN='<seu-token-do-bot>'

Agora é só rodar o bot.py

E dessa forma, você já consegue testar todo nosso código dentro da sua máquina, com seu Bot de simulação.

Próxima etapa, você vai instalar o poetry na sua máquina usando esse link!

Depois de instalado, você vai rodar o comando poetry shell para que seu poetry crie uma máquina virtual para instalar as dependencias do projeto.

Agora, ele vai precisar instalar tais dependências, basta você rodar o comando poetry install.

PRONTO! Agora você já pode contribuir com nosso Finange Bot adicionando features ou corrigindo bugs!

Obrigado pela sua contribuição!

O que preciso saber do código?

Primeiro, você precisa saber que usamos a linguagem de programação python e é tudo codificado sem usar nenhum tipo de framework.

Porém, usamos uma biblioteca para abstrair os metódos de conexão com o Telegram - que usamos para nosso Bot funcionar. E essa biblioteca é a python-telegram-bot. Qualquer dúvida sobre os metódos que usamos para fazer o Bot funcionar, basta ler essa documentação no link anterior ou abrir uma issue no nosso repositorio. Sinta-se a vontade e NÃO precisa ter vergonha.

Toda dúvida é válida!

Onde entrar em contato e obter ajuda sobre o projeto?

Para contribuir e organizar melhor as implementações do projeto você pode entrar em nosso grupo no Telegram.

Para entrar no grupo é só clicar no texto "Telegram" acima.

Todo domingo às 12h (meio dia no horário de Brasília) temos uma call no grupo, para que os contribuidores do projeto possam se comunicar e trocar informações.

finange-bot's People

Contributors

Stargazers

Watchers

Forkers

thehecktour btmluiz michaelfopinheiro annecbsx faelpatrick mathysic-s otabelini luiz-edu0202 hecjin eddyyxxyy

finange-bot's Issues

Adicionar uma função que faz o calculo da rescisão do imposto de renda

Essa função deve calcular quanto o usuario vai receber de rescisão após ser demitido ou pedir demissão do seu emprego clt.

Essa função deve se basear nesse calculo: https://blog.convenia.com.br/calculo-trabalhista/

Fazer conexão com nossa API para que ela receba informações do bot

Aqui precisamos começar uma conexão com nossa API (finange-core) para que enviemos as informações dos usuarios que desejam isso para nossa API e lá possamos manipular essas informações no frontend.

Adicionar uma função de calculo de imposto de renda

Imposto de Renda
Nosso bot precisa de uma calculador de imposto de renda

Adicionar um link para o repositorio de documentação

Colocar essa explicação bem no começo do README para a pessoa saber como contribuir, redirecionando ela para o repositorio de documentação.

Adicionar docstrings no codigo

Aqui a ideia é ter explicação de todas as partes do codigo, detalhando o que cada parte faz.

E a maneira "pythonica" de fazer isso é com uso de "docstrings".

Coloque as explicações em português, uma vez que nosso projeto é br e para iniciantes. E use suas palavras.

Adicionar informações de contato no README.md

A ideia é que coloquemos informações de contato dentro do README.md para pessoas de fora terem acesso às duvidas.

Essas informações são:

Link do nosso grupo do telegram
Data e horário (domingo 12h- horario de brasilia) falando da nossa call semanal dos contribuidores do projeto

Criar função para calcular o FGTS da pessoa.

Aqui o contexto é simples:

Todo mês, quem é funcionário CLT, a empresa coloca 8% do salário da pessoa no FGTS, e, quando a pessoa é demitida ou pede demissão, ela tem direito a esse valor (que fica preso no ambo, dependendo do caso, mas, não é importante aqui). O importante pro nosso bot é fazer o calculo de quanto a pessoa vai ter direito desse FGTS após sair do emprego CLT.

Basicamente, vamos criar uma função para fazer esse calculo seguindo essa logica: https://fdr.com.br/calculadora/fgts/

Perguntar para o usuario se ele deseja que o bot o ajude na sua vida financeira
Caso a resposta seja "SIM", criar uma conta para o usuario (aqui você vai precisar chamar nossa API para criar a conta do usuario)
Receber o salario do usuario
Recebar as depesas do usuario e colocá-las em categorias (sinta-se livre para criar as categorias conforme achar conveniente. Na hora do PR, avaliamos juntos se pode haver melhoria nelas).
Enviar essas informações para nossa API.