Skip to content

Commit

Permalink
Merge pull request #10 from ThiagoPanini/v0.1.x
Browse files Browse the repository at this point in the history
Inclusão dos métodos `__parse_float_cols` e `__parse_pct_cols`
  • Loading branch information
ThiagoPanini authored Feb 12, 2024
2 parents c3fbba3 + 4e15e28 commit b380e21
Show file tree
Hide file tree
Showing 69 changed files with 841 additions and 871 deletions.
26 changes: 20 additions & 6 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,45 @@ assignees: ThiagoPanini

---

:writing_hand: **_Descrição do problema:_**
✍️ **_Descrição do problema:_**

ToDo: proporcione uma visão clara do bug a ser reportado. Adicionalmente, insira blocos de código capazes de facilitar na identificação e reprodução do problema.

```python
# Insira seu código aqui
```
___
:lady_beetle: **_Reproduzindo o problema:_**

🐞 **_Reproduzindo o problema:_**

Para reproduzir o bug, siga os passos abaixo (exemplo):

1. [ ] Importar o módulo ```package.module```
2. [ ] Executar a função ```function()```
3. [ ] Incluir os parâmetros ```(param_a='a', param_b='b')```
4. [ ] Verificar os erros ```Exception e```
___
:gear: **_Comportamento esperado:_**

⚙️ **_Comportamento esperado:_**

ToDo: descreva o comportamento esperado pela função.

___
:earth_americas: **_Informações adicionais:_**

🌎 **_Informações adicionais:_**

ToDo: se aplicável, forneça detalhes adicionais sobre o ambiente utilizado (por exemplo, o sistema operacional, versão da linguagem de programa, versão da biblioteca, entre outras).

___
:camera: **_Screenshots:_** [OPTIONAL]

📷 **_Screenshots:_** [OPCIONAL]

ToDo: se aplicável, forneça algumas capturas de tela para ajudar no entendimento do bug/problema

___
:speech_balloon: **_Possíveis soluções:_** [OPTIONAL]

💬 **_Possíveis soluções:_** [OPCIONAL]

Provavelmente soluções para o problema poderiam ser testadas através dos caminhos:
- Tentativa A
- Tentativa B
9 changes: 7 additions & 2 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,10 @@ assignees: ThiagoPanini

---

:books: **_Aprimoramentos necessários:_**
ToDo: Forneça detalhes sobre os elementos de documentação que precisam ser aprimorados ou inclusos.
📚 **_Aprimoramentos necessários:_**

ToDo: Liste aqui seções, módulos, classes ou funções que precisam melhorar, corrigir ou até mesmo incluir documentações:

- Seção X
- Módulo Y
- Método Z da Classe W
25 changes: 19 additions & 6 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,36 @@ assignees: ThiagoPanini

---

:rocket: **_Feature needed:_**
🚀 **_Funcionalidade requerida:_**

ToDo: forneça detalhes sobre as funcionalidades requeridas.

___
:trophy: **_Feature benefits:_**

🏆 **_Benefícios da nova funcionalidade:_**

Possíveis benefícios atrelados à nova funcionalidade
* Aprimoramento...
* Melhoria...
* Garantia de que...
* Aumento...
* ...

___
:books: **_Complexidade:_**
É provável que esta nova funcionalidade tenha
- [Extreme/High/Medium/Low] complexidade

🧙‍♂️ **_Complexidade:_**

- [ ] Extrema
- [ ] Alta
- [ ] Média
- [ ] Baixa

___
:bulb: **_Ideias de desenvolvimento:_**

💡 **_Ideias de desenvolvimento:_** [OPCIONAL]

Alguns caminhos promissores para o desenvolvimento desta nova funcionalidade seriam:

- Procurar por...
- Aplicar...
- Tentar...
13 changes: 8 additions & 5 deletions .github/ISSUE_TEMPLATE/help-needed.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,15 @@ assignees: ''

---

:heavy_check_mark: **_Checklist útil antes da oficialização do pedido:_**
⚠️ **_Pedido de ajuda:_**

ToDo: descreva aqui o pedido de ajuda

___

**_Checklist útil antes da oficialização do pedido:_**

- [ ] Eu já li a documentação do projeto
- [ ] Já levantei a possibilidade de conflitos de ambiente, como sistema operacional, versão do Python, versão da biblioteca, entre outros
- [ ] Já consumi as demonstrações das funcionalidades existentes na documentação
- [ ] Já procurei por issues similares no repositório do projeto

___

:red_circle: **_Pedido de ajuda:_**
38 changes: 25 additions & 13 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,28 @@
:bookmark_tabs: **_PR details:_**
ToDo: provide a detailed description for the Pull Request opened and ensure users can understand the main changes considered.
📑 **_Detalhes do Pull Request:_**

ToDo: forneça uma breve descrição sobre o PR aberto e garanta que os demais usuários interessados possam entender facilmente as alterações propostas.

___
:link: **_Chained issues_**
This PR eventually will close the following issues:
- #.
___
:hammer: **_Tasks done:_**
- Task A
- Task B

🔨 **_Atividades/features contempladas:_**

- Atividade A
- Melhoria B
- ...

___

🔗 **_Issues vinculadas_**

Este PR eventualmente está atrelado às seguintes *issues*:

- [ ] Nenhuma *issue vinculada*
- [ ] #

___
:heavy_check_mark: **_Checklist:_**
- [ ] New code followed the best practices
- [ ] New features were tested properly
- [ ] There is no chance new features would compromise the project

**_Checklist:_**

- [ ] As novas parcelas de código seguiram as boas práticas de desenvolvimento
- [ ] Novas funcionalidades foram testadas adequadamente
- [ ] Espera-se que as novas funcionalidades não comprometam a solução como um todo
59 changes: 43 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,51 @@
<div align="center">
<br><img src="https://github.com/ThiagoPanini/pynvest/blob/docs/atualizacao-de-documentacao/docs/assets/gifs/logo-animated-intro-v2.gif?raw=true" alt="pynvest-animated-intro">
<br><img src="https://github.com/ThiagoPanini/pynvest/blob/v0.1.x/docs/assets/imgs/logo/logo-com-nome.png?raw=true" width=200 alt="pynvest-logo">
</div>

<div align="center">
<br>

<a href="https://pypi.org/project/pynvest/">
<img src="https://img.shields.io/pypi/v/pynvest?style=flate&logo=python&logoColor=FFFFFF&color=22C7FF" alt="PyPi shield">
</a>

<a href="">
<img src="https://img.shields.io/pypi/dm/pynvest?logo=pypi&logoColor=FFFFFF&color=B252D0">
</a>

[![PyPI](https://img.shields.io/pypi/v/pynvest?style=flate&logo=python&logoColor=yellow&color=blue)](https://pypi.org/project/pynvest/)
![PyPI - Downloads](https://img.shields.io/pypi/dm/pynvest?logo=pypi&logoColor=white)
![CI workflow](https://img.shields.io/github/actions/workflow/status/ThiagoPanini/pynvest/ci-main.yml?label=ci&logo=github)
[![codecov](https://codecov.io/github/ThiagoPanini/pynvest/branch/main/graph/badge.svg?token=L4KO1RM63H)](https://codecov.io/github/ThiagoPanini/pynvest)
[![Documentation Status](https://readthedocs.org/projects/pynvest/badge/?version=latest)](https://pynvest.readthedocs.io/en/latest/?badge=latest)

[![Python](https://img.shields.io/badge/python-grey?style=for-the-badge&logo=python&logoColor=ffdd54)](https://www.python.org/)
[![Pytest](https://img.shields.io/badge/pytest-grey?style=for-the-badge&logo=pytest&logoColor=DF2815)](https://www.python.org/)
[![Mkdocs](https://img.shields.io/badge/mkdocs-grey?style=for-the-badge&logo=markdown&logoColor=009FE3)](https://www.mkdocs.org/)
[![Read the Docs](https://img.shields.io/badge/readthedocs-grey?style=for-the-badge&logo=readthedocs&logoColor=FFFFFF)](https://readthedocs.org/)
[![GitHub](https://img.shields.io/badge/github-grey?style=for-the-badge&logo=github&logoColor=FFFFFF)](https://github.com/)
<a href="">
<img src="https://img.shields.io/github/actions/workflow/status/ThiagoPanini/pynvest/ci-main.yml?label=ci&logo=github&logoColor=FFFFFF">
</a>

<a href="https://codecov.io/github/ThiagoPanini/pynvest">
<img src="https://codecov.io/github/ThiagoPanini/pynvest/branch/main/graph/badge.svg?token=L4KO1RM63H">
</a>

<a href="https://pynvest.readthedocs.io/en/latest/?badge=latest">
<img src="https://readthedocs.org/projects/pynvest/badge/?version=latest">
</a>

<br>

<a href="https://www.python.org/">
<img src="https://img.shields.io/badge/python-grey?style=for-the-badge&logo=python&logoColor=22C7FF">
</a>

<a href="https://docs.pytest.org/">
<img src="https://img.shields.io/badge/pytest-grey?style=for-the-badge&logo=pytest&logoColor=22C7FF">
</a>

<a href="https://www.mkdocs.org/">
<img src="https://img.shields.io/badge/mkdocs-grey?style=for-the-badge&logo=markdown&logoColor=22C7FF">
</a>

<a href="https://readthedocs.org/">
<img src="https://img.shields.io/badge/readthedocs-grey?style=for-the-badge&logo=readthedocs&logoColor=22C7FF">
</a>

<a href="https://github.com/">
<img src="https://img.shields.io/badge/github-grey?style=for-the-badge&logo=github&logoColor=22C7FF">
</a>

</div>

Expand All @@ -26,9 +56,6 @@ ___
</div>


> **Note**
> Uma página completa de documentação da `pynvest` está disponível no [readthedocs](https://pynvest.readthedocs.io/pt/latest/). Acesse e não perca as últimas novidades da biblioteca!
## Visão Geral

A biblioteca `pynvest` foi criada para facilitar o processo de extração e análise de indicadores financeiros da bolsa de valores brasileira (B3). Isto é obtido através de *web scrappings* aplicados a plataformas/sites financeiros para extração de atributos e valores capazes de proporcionar, aos usuários, uma jornada interessante de análise de dados.
Expand Down Expand Up @@ -63,7 +90,7 @@ df_itub3 = pynvest_scrapper.coleta_indicadores_de_ativo("itub3")

## Readthedocs

🚨 Reforçando pois vale o reforço: existe uma [página oficial de documentação da biblitoeca](https://pynvest.readthedocs.io/pt/latest/) criada com carinho e dedicação para todos os interessados em saber mais a respeito da solução. Viva o open source!
📚 Para saber mais sobre essa iniciativa, acesse a [página oficial de documentação da biblitoeca](https://pynvest.readthedocs.io/pt/latest/) criada com carinho e dedicação para todos os interessados na solução. Viva o open source!


## Entre em Contato
Expand Down
3 changes: 0 additions & 3 deletions docs/assets/.icons/bootstrap/boxes.svg

This file was deleted.

3 changes: 0 additions & 3 deletions docs/assets/.icons/bootstrap/envelope-paper.svg

This file was deleted.

1 change: 0 additions & 1 deletion docs/assets/.icons/custom/custom-icon-alt-version.svg

This file was deleted.

Binary file removed docs/assets/.icons/custom/custom-icon.png
Binary file not shown.
Loading

0 comments on commit b380e21

Please sign in to comment.