Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Nova versão da documentação no readthedocs #11

Merged
merged 17 commits into from
Feb 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
c080a67
doc: incluindo tip de explicação dos scrappers
ThiagoPanini Feb 12, 2024
84c9358
docs: corrigindo link na home para seção de scrappers
ThiagoPanini Feb 12, 2024
18cf6ec
docs: ajustando docs da página de scrappers
ThiagoPanini Feb 12, 2024
fd4bec2
feat: removendo coluna date_exec do método coleta_indicadores_de_ativo
ThiagoPanini Feb 12, 2024
a22a352
fix: alterando o nome de alguns atributos do DataFrame de FIIs em MET…
ThiagoPanini Feb 12, 2024
7262c05
docs: ajustando referências de links em novas páginas de documentação
ThiagoPanini Feb 13, 2024
01283c4
fix: retirando duplo underline do nome dos métodos de parse
ThiagoPanini Feb 16, 2024
d8ef717
docs: finalizando documentação sobre recursos provisionados e inician…
ThiagoPanini Feb 23, 2024
90ce68d
docs: complementando a documentação do módulo tools
ThiagoPanini Feb 24, 2024
7436d2f
feat: alterando metadados do processamento para deixar a coleta de in…
ThiagoPanini Feb 24, 2024
6836747
chore: removendo comentários antigos
ThiagoPanini Feb 27, 2024
f304fc7
feat: release v0.1.1
ThiagoPanini Feb 29, 2024
9466d0b
fix: ajustando hiperlinks na doc
ThiagoPanini Feb 29, 2024
5228e49
docs: enriquecendo página de contribuição
ThiagoPanini Feb 29, 2024
4ee5404
feat: gerando ícones SVG para customização de logo no menu da doc
ThiagoPanini Feb 29, 2024
bba5252
docs: referenciando ferramentas de conversão de imagens
ThiagoPanini Feb 29, 2024
085c678
docs: incluindo ícone customizado e favicon
ThiagoPanini Feb 29, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/contribuindo/contribuindo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contribuindo com o pynvest

Curtiu o projeto e encontrou alguma oportunidade de contribuir com ele de alguma forma? Vai fundo! Sendo uma iniciativa *open source*, qualquer um interessado em deixar sua contribuição será extremamente bem vindo.

???+ question "Para contribuir eu preciso necessariamente escrever linhas de código?"
Não necessariamente! Uma contribuição pode ser desde um módulo adicional na biblioteca, como também o apontamento de alguma *issue* ou *feature request*. Sua interação é extremamente válida para manter a ideia viva!


O pacote surgiu de forma despretensiosa e com o simples objetivo de facilitar a gestão financeira pessoal do criador. Ao longo do tempo, percebeu-se que tais funcionalidades poderiam facilmnente ajudar outras pessoas dentro do mesmo escopo e propósito. Assim, a biblioteca tomou forma e, hoje, o resultado atual se mostra dentro de tudo o que está consolidado nesta documentação.


## Como Contribuir?

Bom, em primeiro lugar, é importante que os potenciais contribuidores tenham a ciência completa sobre a biblioteca *pynvest* e o seu propósito. Dessa forma, as ideias de contribuição poderão ser moldadas e adaptadas para encaixar no escopo da biblioteca.

Dito isso, os potenciais contribuidores podem acessar o repositório oficial da biblioteca e iniciar seus respectivos desenvolvimentos.

- :fontawesome-brands-github: [Repositório com código fonte](https://github.com/ThiagoPanini/pynvest)
- :fontawesome-brands-python: [Página da biblioteca no PyPI](https://pypi.org/project/pynvest/)

## Issues

Abrir uma *issue* também é uma forma de contribuir com o projeto. Atualmente, existem alguns modelos específicos de *issues* que podem ser utilizados pelos usuários para fornecer insumos específicos sobre o projeto:

- 🐞 Report de *bugs* da biblioteca
- 📄 Aprimorando de documentações já existentes ou inclusão de novas páginas
- 🚀 Requisição de novas funcionalidades para o projeto
- 😵‍💫 Pedido de ajuda para tarefas no geral
- 🤔 Questões ou dúvidas sobre o projeto
Binary file added docs/overrides/.icons/custom/custom-icon-32px.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/overrides/.icons/custom/custom-icon-32px.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/overrides/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ <h1>
<a href="{{ page.next_page.url | url }}" title="{{ page.next_page.title | e }}" class="md-button md-button--primary">
Quick start
</a>
<a href="{{ 'quickstart/instalacao/' | url }}" title="Material for MkDocs Insiders" class="md-button">
<a href="{{ 'scrappers/' | url }}" title="Material for MkDocs Insiders" class="md-button">
Scrappers
</a>
</div>
Expand Down
5 changes: 4 additions & 1 deletion docs/quickstart/arquitetura.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,7 @@ Apresentada a estratégia de funcionamento, a biblioteca possui essa árvore de
└───__init__.py
```

> Aqui, é possível entender claramente a relação entre *scrappers* e portais de indicadores financeiros. O submódulo `fundamentus.py` contém funções, classes e métodos especialmente construídos para contemplar toda a dinâmica de extração e tratamento de dados contidos no site Fundamentus.
<small>
:octicons-light-bulb-16:
**Dica:** Aqui, é possível entender claramente a relação entre *scrappers* e portais de indicadores financeiros. O submódulo `fundamentus.py` contém funções, classes e métodos especialmente construídos para contemplar toda a dinâmica de extração e tratamento de dados contidos no site Fundamentus.
</small>
9 changes: 8 additions & 1 deletion docs/quickstart/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ Referências visuais para construção do logo:

A imagem na [home](../index.md) da documentação foi criada utilizando a ilustração [Financial Data Isometric](https://storyset.com/illustration/financial-data/amico) da página [storyset](https://storyset.com/).

???+ tip "Sobre a conversão das imagens para a geração de ícones customizados"
Para conseguir gerar os logos customizados no cabeçalho da página, foi preciso realizar algumas etapas:

1. Converter a imagem PNG em um formato ICO utilizando as dimensões 32x32px ([cloudconvert](https://cloudconvert.com/png-to-ico))
2. Converter o arquivo ICO gerado para o formato SVG mantendo os *presets* de cores ([pixelied](https://pixelied.com/convert/png-converter/png-to-svg))

## Fontes

Expand Down Expand Up @@ -56,4 +61,6 @@ A imagem na [home](../index.md) da documentação foi criada utilizando a ilustr
- [Dafont.com](https://www.dafont.com/)
- [slidesgo](https://slidesgo.com/pt/)
- [storyset](https://storyset.com/)
- [Power Point](https://www.microsoft.com/en-us/microsoft-365/powerpoint)
- [Power Point](https://www.microsoft.com/en-us/microsoft-365/powerpoint)
- [cloudconvert](https://cloudconvert.com/png-to-ico)
- [pixelied](https://pixelied.com/convert/png-converter/png-to-svg)
3 changes: 1 addition & 2 deletions docs/quickstart/instalacao.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
<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>
<div align="center">

<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">
Expand Down
2 changes: 0 additions & 2 deletions docs/scrappers/fundamentus/about.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/scrappers/fundamentus/indicadores/acoes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Fundamentus: Indicadores de Ações

De forma objetiva, a tabela abaixo contempla uma lista de indicadores financeiros (e suas respectivas definições/descrições) disponíveis no site e obtidos como resultado do método [coleta_indicadores_de_ativo()](../../../mkdocstrings/scrappers/fundamentus.md/#pynvest.scrappers.fundamentus.Fundamentus.coleta_indicadores_de_ativo).
De forma objetiva, a tabela abaixo contempla uma lista de indicadores financeiros (e suas respectivas definições/descrições) disponíveis no site e obtidos como resultado do método [coleta_indicadores_de_ativo()](../mkdocstrings/fundamentus.md/#pynvest.scrappers.fundamentus.Fundamentus.coleta_indicadores_de_ativo).

| **Nome Original** | **Atributo DataFrame** | **Descrição** |
| :-- | :-- | :-- |
Expand Down
2 changes: 1 addition & 1 deletion docs/scrappers/fundamentus/indicadores/fiis.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Fundamentus: Indicadores de FIIs

No portal Fundamentus, Fundos Imobiliários possuem seus próprios indicadores fundamentalistas. A tabela abaixo traz a visão daquilo que também é obtido pela chamada do método [coleta_indicadores_de_ativo()](../../../mkdocstrings/scrappers/fundamentus.md/#pynvest.scrappers.fundamentus.Fundamentus.coleta_indicadores_de_ativo) com *tickers* de FIIs.
No portal Fundamentus, Fundos Imobiliários possuem seus próprios indicadores fundamentalistas. A tabela abaixo traz a visão daquilo que também é obtido pela chamada do método [coleta_indicadores_de_ativo()](../mkdocstrings/fundamentus.md/#pynvest.scrappers.fundamentus.Fundamentus.coleta_indicadores_de_ativo) com *tickers* de FIIs.

| **Nome Original** | **Atributo DataFrame** | **Descrição** |
| :-- | :-- | :-- |
Expand Down
2 changes: 1 addition & 1 deletion docs/scrappers/about.md → docs/scrappers/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Organização das Páginas
# Scrappers

A proposta desta seção é propor uma visão consolidada contendo todos os detalhes relacionados aos *scrappers* disponíveis para uso na biblioteca. A ideia é que cada *scrapper* tenha o seu próprio combo de documentação composto por:

Expand Down
19 changes: 19 additions & 0 deletions docs/tools/arquitetura.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Arquitetura de Solução

Agora que temos uma noção sobre o que é o módulo `pynvest-tools` e os principais benefícios atrelados ao seu uso, vamos iniciar um aprofundamento técnico sobre o que está por trás da solução.

Iniciando pela arquitetura, a imagem abaixo traz uma visão detalhada da solução contendo toda a dinâmica de serviços e integrações disponibilizadas para o usuário.

<small>
:octicons-light-bulb-16:
**Dica:** clique na imagem para uma melhor visualização dos elementos.
</small>

![Arquitetura de Solução](https://github.com/ThiagoPanini/pynvest-tools/blob/v0.2.x/docs/drawio/pynvest-tool-diagram-print.png?raw=true)

Em essência, o diagrama acima contempla todos os serviços AWS entregues pelo módulo Terraform e, além disso, traz a visão de todas as integrações entre os recursos.

Toda a dinâmica de implantação do módulo é baseada em **6 macro etapas** que, em linhas gerais, contemplam toda a lógica de extração, preparação e atualização agendada dos dados financeiros disponibilizados ao usuário em seu próprio ambiente AWS.

Ao longo desta seção de detalhamento, será possível observar todas as nuances e particularidades dos [recursos provisionados](./recursos.md) e das [etapas de processamento da solução](./processo.md).

Loading
Loading