Skip to main content

Aplicativo CLI para exibir gráficos do MetaTrader 5 screen reader friendly

Project description

mtcli

mtcli é um aplicativo de linha de comando (CLI) acessível para leitura e análise de gráficos do MetaTrader 5, desenvolvido com foco em acessibilidade para usuários com deficiência visual.

O projeto é modular e extensível por meio de plugins.


Instalação

Você pode instalar o mtcli diretamente via pip:

pip install mtcli

Ou diretamente a partir do código-fonte:

git clone https://github.com/vfranca/mtcli.git
cd mtcli
pip install .

Como usar

Após a instalação, o comando principal é:

mt

Você verá uma lista de comandos e plugins disponíveis.

Para executar um plugin específico, use:

mt nome-do-plugin [opções]

Exemplo com o plugin de média móvel:

mt mm --symbol WIN$N --periodo 14

Documentação

A documentação completa está disponível em:

https://vfranca.github.io/mtcli

Inclui guias de uso, instalação de plugins, exemplos e estrutura do projeto.


Como contribuir

Contribuições são bem-vindas!

Clonar o repositório

git clone https://github.com/vfranca/mtcli.git
cd mtcli

Instalar dependências para desenvolvimento

pip install -e ".[dev]"

Rodar os testes

pymake test

Estilo de código

  • black para formatação
  • isort para ordenação de imports
  • pydocstyle para formatação de docstrings
  • ruff e mypy para linting e verificação estática

Criando plugins para o mtcli

Plugins permitem estender a funcionalidade do mtcli.

Estrutura básica de um plugin

pyproject.toml
[project.entry-points."mtcli.plugins"]
nome_do_plugin = "modulo.caminho:funcao_principal"

Exemplo

[project.entry-points."mtcli.plugins"]
volume_medio = "mtcli.plugins.volume_medio:vm"

No código Python:

def vm():
    print("Plugin de volume médio executado.")

Como empacotar

Crie um projeto separado com sua lógica e registre o plugin no pyproject.toml ou setup.py como acima.

Depois, instale com:

pip install .

O mtcli reconhecerá o plugin automaticamente.


Contato

Autor: Valmir França da Silva

Email: vfranca3@gmail.com

GitHub: @vfranca


Licença

Distribuído sob a licença MIT. Veja LICENSE para mais informações.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mtcli-3.7.3.tar.gz (23.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mtcli-3.7.3-py3-none-any.whl (43.7 kB view details)

Uploaded Python 3

File details

Details for the file mtcli-3.7.3.tar.gz.

File metadata

  • Download URL: mtcli-3.7.3.tar.gz
  • Upload date:
  • Size: 23.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.13.12 Windows/11

File hashes

Hashes for mtcli-3.7.3.tar.gz
Algorithm Hash digest
SHA256 5ad6b4edff737a93ff7a9a7894114506869f3cb50da5fadb180038e5e4152097
MD5 10281f4fd489bf2e2c6992cf092475a6
BLAKE2b-256 e07ad263ca3e3a3c808e819ee064ac17c01e82fda513ebccc7e56a50e4ff6875

See more details on using hashes here.

File details

Details for the file mtcli-3.7.3-py3-none-any.whl.

File metadata

  • Download URL: mtcli-3.7.3-py3-none-any.whl
  • Upload date:
  • Size: 43.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.13.12 Windows/11

File hashes

Hashes for mtcli-3.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1fcb62961e9f581cdb667a0e42a2d2e539a995e69e9a18022f875bb5445153ff
MD5 1130ae80326c7566e915c5e4695d1b79
BLAKE2b-256 e8e09507b77ef2aa465adddb88feaff68ed890eb9bf40f1526f4bb8411b2159d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page