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.4.tar.gz (24.0 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.4-py3-none-any.whl (43.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mtcli-3.7.4.tar.gz
  • Upload date:
  • Size: 24.0 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.4.tar.gz
Algorithm Hash digest
SHA256 c48cd1dd2fac380d6c8bed608fa90d9e488fcf3e2e2b614e17a97054a7977710
MD5 f305ac86d8d29e83b1a9ff0bbc9f08eb
BLAKE2b-256 ee2c5611a5351f951030ac774b46bb5e86aacadc26b137dc379c63be469d48d8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mtcli-3.7.4-py3-none-any.whl
  • Upload date:
  • Size: 43.8 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d5ce6d0c9f32f8a384085a998296b2131e7d76695c0bc1e9fe289138f1b36dd3
MD5 d823845fc7d29f3ea1236f3142ffba6c
BLAKE2b-256 58f4974388f8bac444d3bab068106fa0d9164df4795fda78e85e8a97e2af59f6

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