-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathREADME.html
109 lines (79 loc) · 4.91 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<h1>DENET</h1>
<p>Denet é uma plataforma para análise fundamentalista das companhias de capital aberto cadastradas na CVM (Brasil). </p>
<h2>Página principal</h2>
<p>Mais informações incluindo <em>screenshots</em> e instruções de utilização podem se encontrar <a href="http://www.potuz.net/denet">na página principal</a>. </p>
<h2>Principais Funcionalidades</h2>
<p>Neste momento o programa consta de três partes principais</p>
<ol>
<li>Uma Biblioteca <code>C++</code> <code>libdfp</code> que nesta versão suporta:
<ul>
<li>Listar arquivos disponíveis na CVM para download.</li>
<li>Baixar arquivos automaticamente da CVM.</li>
<li>Importar ITR e DFP para uma base de dados MySQL (local ou externa).</li>
<li>Reportar indicadores fundamentalistas de uma empresa dada.</li>
<li>Criar e iniciar a base de dados no servidor indicado (precisa acesso root ao servidor MySQL).</li>
</ul></li>
<li>Ferramentas CLI escritas em <code>C++</code> <code>denet</code> e <code>cvmfetch</code> que são clientes de <code>libdfp</code> na linha de comando.</li>
<li>Um GUI <code>genet</code> escrito em <code>C++</code> utilizando <code>QT5</code> que além de implementar todas as funcionalidades de <code>libdfp</code> também suporta:
<em>Resumo dos indicadores fundamentalistas principais, trimestrais e anualizados das companhias.
</em>Visualização e edição do balanço completo, correção das entradas na base de dados.
<em>Gráficos de evolução dos principais indicadores fundamentalistas
</em>Reportes dos resultados das companhias.</li>
</ol>
<h2>Requisitos</h2>
<ol>
<li><code>libdfp</code> requere de
<ul>
<li><code>MySql</code>.</li>
<li><code>MySql Connector++</code>.</li>
<li><a href="http://www.libarchive.org">libarchive</a> - Para descomprimir os archivos da CVM.</li>
<li><a href="https://curl.haxx.se/libcurl/">libcurl</a> - Para baixar os archivos da CVM e obter preços do <a href="https://finance.yahoo.com/q?s=API">Yahoo!</a></li>
<li><a href="http://pugixml.org/">pugixml</a> - Para ler os documentos <code>XML</code> da CVM (incluído nesta distribuição).</li>
</ul></li>
<li><code>denet</code> e <code>cvmfetch</code> precisam além de
<ul>
<li><a href="http://ezoptionparser.sourceforge.net">ezOptionParser</a> - Para analisar os argumentos no CLI (incluído nesta distribuição).</li>
</ul></li>
<li><code>genet</code> precisa de
<ul>
<li><a href="http://qt-project.org/qt5">Qt5>=5.7</a> incluindo <code>QtWidgets</code>, <code>QtConcurrent</code> e <code>QtCharts</code>.</li>
</ul></li>
<li>Para compilar precisa de pelo menos um compilador que possa interpretar <code>-std=c++14</code>. O sistema de instalação precisa de <code>CMake>=3.1.0</code></li>
<li>Antes de correr o programa pela primeira vez certifique que sua instalação de <code>MySQL</code> está funcionando e que você tem acesso ao usuário administrador (geralmente <em>root</em>).</li>
</ol>
<h2>Instalação a partir do código fonte:</h2>
<h3>Linux</h3>
<p>Desde o diretório base (onde <code>CMakeLists.txt</code> se encontra)</p>
<pre><code>mkdir build && cd $_
cmake ../
make
sudo make install
</code></pre>
<h3>Windows</h3>
<ul>
<li>Abra o GUI de <code>CMake</code></li>
<li>Escolha o diretório onde você descompactou as fontes e o diretório onde vai compilar (pode ser o mesmo das fontes, mas preferivelmente um novo diretório por exemplo <code>build</code>).</li>
<li>Clique em <code>Configure</code>.</li>
<li>Abra o projeto em visual studio e compile.</li>
</ul>
<h2>Autor</h2>
<p><strong>Potuz</strong> <a href="mailto:potuz@potuz.net">potuz@potuz.net</a></p>
<h2>Contato</h2>
<p>Normalmente estou em <code>#denet</code> <a href="http://webchat.freenode.net">@freenode</a>, se não estou pode deixar uma mensagem lá ou por e-mail. </p>
<p>Também estou regularmente no <a href="http://clubinvest.boards.net">ClubInvest</a>. </p>
<h2>Como ajudar</h2>
<p>A lista seguinte não é exaustiva, qualquer ajuda é bem-vinda.</p>
<ul>
<li>Código em forma de patches contra <code>master</code> ou <em>pull requests</em>.</li>
<li>Testar o aplicativo e informar de erros recebidos, erros de compilação, erros de <em>runtime</em>.</li>
<li>Solicitar funcionalidades que você considere úteis.</li>
<li>Escrever um manual ou ajudar a documentar o projeto.</li>
<li>Português não é a minha primeira língua, correções nos textos tanto da página como nos aplicativos serão bem-vindas.</li>
</ul>
<h2>Licencia</h2>
<p>O projeto está distribuído sob a proteção do Gnu GPL v3. Veja o documento <a href="COPYING">COPYING</a> para mais informação. </p>
<h2>Agradecimentos</h2>
<ul>
<li><em>rufuslenhador</em> que ajudou em versões prévias com a base de dados <code>SQLite</code>.</li>
<li>Ao pessoal do <a href="http://clubinvest.boards.net">ClubeInvest</a>.</li>
</ul>