Bem-vindo a documentacao do mtcli!¶
mtcli¶
Utilitário de linha de comando para leitura de gráficos do MetaTrader 5.
- Free software: MIT license
- Documentação: https://mtcli.readthedocs.io.
Pré-requisitos¶
- MetaTrader 5 - plataforma de trading.
- GeraCSV.ex5 - robô executado no MetaTrader 5.
Instalação¶
pip install mtcli
Procedimento no MetaTrader 5¶
Faça o download do GeraCSV.ex5.
- Execute o MetaTrader 5 e abra um gráfico.
- Execute o GeraCSV.ex5.
- Selecione a opção “anexar ao gráfico” no menu de contexto do GeraCSV.ex5.
Arquivo .env¶
Crie um arquivo .env na pasta raiz do Windows com o conteúdo abaixo:
DIGITS=”2”
CSV_PATH=[caminho_dos_arquivos_do_metatrader5]
Uso¶
Para exibir as últimas 20 barras do diário do winq19:
mt bars winq19 -p daily -c 20
Para exibir o canal das últimas 20 barras do diário do winq19:
mt bars winq19 -p daily -v ch -c 20
Para exibir o preço de fechamento das últimas 20 barras do diário do winq19:
mt bars winq19 -p daily -v c -c 20
Para exibir o preço máximo das últimas 20 barras do diário do winq19:
mt bars winq19 -p daily -v h -c 20
Para exibir o preço mínimo das últimas 20 barras do diário do winq19
mt bars winq19 -p daily -v l -c 20
Para exibir o range das últimas 20 barras do diário do winq19:
mt bars winq19 -p daily -v r -c 20
Para exibir o volume das últimas 20 barras do diário do winq19:
mt bars winq19 -p daily -v vol -c 20
Para exibir o ATR(14) do diário do winq19:
mt atr winq19 -p daily
Para exibir o ATR(20) do diário do winq19:
mt atr winq19 -p daily -c 20
Para exibir a média móvel aritmética de 20 períodos do diário do winq19:
mt sma winq19 -p daily -c 20
Para exibir a média móvel exponencial de 20 períodos do diário do winq19:
mt ema winq19 -p daily -c 20
Para exibir as retrações e extensões de Fibonacci entre 103900 e 102100 na tendência de alta:
mt fib 103900 102100 h
Para exibir as retrações e extensões de Fibonacci entre 103900 e 102100 na tendência de baixa:
mt fib 103900 102100 l
Instalação¶
Versao estavel¶
Para instalar mtcli, execute o seguinte comando em seu terminal:
pip install mtcli
Este e o metodo preferido para instalar o mtcli, pois sempre instalara a versao estavel mais recente.
Se você nao possui o pip instalado, este guia de instalacao do Python pode orientar durante o processo.
A partir do codigo fonte¶
O codigo fonte do mtcli pode ser baixado do repo Github.
Você pode clonar o repositorio publico:
> git clone git://github.com/vfranca/mtcli
Ou fazer o download do tarball:
> curl -OL https://github.com/vfranca/mtcli/tarball/master
Depois de ter uma copia do codigo fonte, você pode instalá-lo com:
poetry install
Contribuindo¶
Contribuições são bem-vindas e são muito apreciadas! Cada trecho ajuda e sempre será dado crédito.
Você pode contribuir de várias maneiras:
Formas de Contribuição¶
Relatar Bugs¶
Relate bugs em https://github.com/vfranca/mtcli/issues.
Quando você estiver relatando um bug inclua:
- O nome e a versão do seu sistema operacional.
- Quaisquer detalhes sobre a configuração local que possam ser úteis na solução de problemas.
- Passos detalhados para reproduzir o bug.
Correção de Bugs¶
Procure nos issues do GitHub por bugs. Qualquer coisa marcada com “bug” e “help wanted”estará aberto a quem quiser implementá-lo.
Implementar Features¶
Procure nos issues do GitHub para obter features. Qualquer coisa marcada com “enhancement” e “help wanted” está aberta para quem quiser implementá-la.
Escrever Documentação¶
O mtcli sempre poderá usar mais documentação, seja como parte dos documentos oficiais de mtcli, em docstrings ou até na web em postagens de blog, artigos e afins.
Enviar Feedback¶
A melhor maneira de enviar feedback é registrar um issue em https://github.com/vfranca/mtcli/issues.
Se você estiver propondo uma feature:
- Explique em detalhes como funcionaria.
- Mantenha o escopo o mais estreito possível afim de facilitar a implementação.
- Lembre-se de que este é um projeto conduzido por voluntários e que as contribuições são bem-vindas.
Começando!¶
Pronto para contribuir? Veja como configurar o mtcli para desenvolvimento local.
- Bifurque o repositório mtcli no GitHub.
- Clone seu fork localmente:
git clone git@github.com:seu_usuario/mtcli.git
- Instale sua cópia local em um virtualenv. Supondo que você tenha o virtualenvwrapper instalado, é assim que você configura seu fork para desenvolvimento local:
mkvirtualenv mtcli
cd mtcli /
poetry install
- Crie um branch para desenvolvimento local:
git checkout -b nome-do-seu-bugfix-ou-feature
Agora você pode fazer suas alterações localmente.
- Quando terminar de fazer as alterações, verifique se as alterações passam no flake8 e nos testes:
flake8 mtcli tests
pytest
- Comite suas alterações e envie seu branch para o GitHub:
git add .
git commit -m "Descrição detalhada de suas alterações."
git push origin nome-do-seu-bugfix-ou-feature
- Envie um pull request pelo site do GitHub.
Diretrizes de Pull Request¶
Antes de enviar um pull request, verifique se ele atende a estas diretrizes:
- O pull request deve incluir testes.
- Se o pull request adicionar uma funcionalidade, os documentos deverão ser atualizados. Colocar sua nova funcionalidade em uma função com uma string e adicione-o para a lista em README.rst.
Creditos¶
Development Lead¶
- Valmir França <vfranca3@gmail.com>
Colaboradores¶
- Maicon Dinkel Baggio <maiconbaggio@outlook.com>