mtcli 3.6.0.dev1__tar.gz → 3.7.0__tar.gz

{mtcli-3.6.0.dev1 → mtcli-3.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mtcli
-Version: 3.6.0.dev1
+Version: 3.7.0
 Summary: Aplicativo CLI para exibir gráficos do MetaTrader 5 screen reader friendly
 License-Expression: MIT
 License-File: LICENSE

mtcli-3.7.0/mtcli/cli.py

@@ -0,0 +1,74 @@
+"""
+CLI principal do mtcli.
+
+Este módulo define o grupo principal `mt`
+e inicializa o carregamento de plugins.
+"""
+
+import click
+
+from mtcli.plugin_loader import load_plugins
+from mtcli.logger import setup_logger
+
+from .commands.bars import bars
+from .commands.doctor import doctor
+
+logger = setup_logger(__name__)
+
+
+@click.group(context_settings={"max_content_width": 120})
+@click.version_option(package_name="mtcli")
+def mt():
+    """
+    CLI principal do mtcli.
+
+    Exibe gráficos e informações de mercado
+    em formato textual compatível com leitores de tela.
+    """
+    pass
+
+
+# ---------------------------------------------------------
+# Comandos internos
+# ---------------------------------------------------------
+
+mt.add_command(doctor, name="doctor")
+mt.add_command(bars, name="bars")
+mt.add_command(doctor, name="dr")
+
+
+# ---------------------------------------------------------
+# Carregamento de plugins
+# ---------------------------------------------------------
+
+loaded_plugins = load_plugins(mt)
+
+logger.info("Plugins carregados: %s", loaded_plugins)
+
+
+# ---------------------------------------------------------
+# Comando utilitário: listar plugins
+# ---------------------------------------------------------
+
+@mt.command(name="plugins")
+def list_plugins():
+    """
+    Lista os plugins atualmente carregados no mtcli.
+    """
+
+    if not loaded_plugins:
+        click.echo("Nenhum plugin carregado.")
+        return
+
+    click.echo("Plugins carregados:\n")
+
+    for name in loaded_plugins:
+        click.echo(f"  {name}")
+
+
+# ---------------------------------------------------------
+# Entry point
+# ---------------------------------------------------------
+
+if __name__ == "__main__":
+    mt()

mtcli-3.7.0/mtcli/commands/conf.py

@@ -0,0 +1,44 @@
+"""
+Comando para exibir configurações disponíveis.
+"""
+
+import click
+
+from mtcli.config_registry import registry
+from mtcli.conf import conf
+
+
+@click.command()
+@click.argument("section", required=False)
+def conf_cmd(section):
+    """
+    Exibe configurações disponíveis.
+
+    Exemplos:
+
+        mt conf
+        mt conf renko
+    """
+
+    if section:
+        options = registry.get_section(section)
+    else:
+        options = registry.get_all()
+
+    if not options:
+        click.echo("Nenhuma configuração registrada.")
+        return
+
+    for opt in options:
+
+        value = conf.get(opt.name, section=opt.section, default=opt.default)
+
+        click.echo(
+            f"{opt.section}.{opt.name} = {value} "
+            f"(default={opt.default})"
+        )
+
+        if opt.description:
+            click.echo(f"  {opt.description}")
+
+        click.echo()

mtcli-3.7.0/mtcli/commands/doctor.py

@@ -0,0 +1,194 @@
+"""
+Comando de diagnóstico do mtcli.
+
+Este comando executa uma série de verificações básicas para ajudar
+a identificar problemas de instalação, configuração ou carregamento
+de plugins no ambiente do mtcli.
+
+As verificações incluem:
+
+- Versão do Python
+- Instalação do mtcli
+- Fonte de dados configurada
+- Caminho de dados CSV
+- Conexão com MetaTrader5
+- Descoberta e carregamento de plugins
+
+Caso algum plugin falhe ao carregar, o erro é exibido e registrado
+no sistema de logs.
+"""
+
+import sys
+import click
+import traceback
+
+from importlib.metadata import version, PackageNotFoundError
+
+import MetaTrader5 as mt5
+
+from mtcli.logger import setup_logger
+from mtcli.conf import conf, DATA_SOURCE_NAME
+from mtcli.mt5_context import mt5_conexao
+from mtcli.plugin_loader import discover_plugins
+
+
+logger = setup_logger(__name__)
+
+
+def status(ok: bool) -> str:
+    """
+    Retorna um marcador visual simples de status.
+
+    Parameters
+    ----------
+    ok : bool
+        Indica se o teste foi bem sucedido.
+
+    Returns
+    -------
+    str
+        Texto representando o status.
+    """
+    return "OK " if ok else "ERRO"
+
+
+@click.command()
+def doctor():
+    """
+    Executa diagnóstico do ambiente mtcli.
+
+    O comando verifica se os componentes essenciais do ambiente
+    estão funcionando corretamente e apresenta um relatório simples
+    no terminal.
+    """
+
+    click.echo("Diagnóstico do ambiente mtcli\n")
+
+    # ---------------------------------------------------------
+    # Python
+    # ---------------------------------------------------------
+
+    python_ok = sys.version_info >= (3, 10)
+
+    click.echo(f"{status(python_ok)} Python: {sys.version.split()[0]}")
+
+    if not python_ok:
+        click.echo("   Versão mínima recomendada: Python 3.10")
+
+    # ---------------------------------------------------------
+    # mtcli
+    # ---------------------------------------------------------
+
+    try:
+
+        mtcli_version = version("mtcli")
+
+        click.echo(f"{status(True)} mtcli: {mtcli_version}")
+
+    except PackageNotFoundError:
+
+        click.echo(f"{status(False)} mtcli não encontrado")
+
+        logger.error("Pacote mtcli não encontrado no ambiente.")
+
+    # ---------------------------------------------------------
+    # Fonte de dados
+    # ---------------------------------------------------------
+
+    click.echo(f"{status(True)} Data source: {DATA_SOURCE_NAME}")
+
+    # ---------------------------------------------------------
+    # CSV path
+    # ---------------------------------------------------------
+
+    try:
+
+        path = conf.get_csv_path()
+
+        click.echo(f"{status(True)} CSV path: {path}")
+
+    except Exception as exc:
+
+        click.echo(f"{status(False)} CSV path inválido")
+
+        logger.exception("Erro ao obter CSV path: %s", exc)
+
+    # ---------------------------------------------------------
+    # MT5 conexão
+    # ---------------------------------------------------------
+
+    try:
+
+        with mt5_conexao():
+
+            info = mt5.terminal_info()
+
+            if info:
+
+                click.echo(f"{status(True)} MetaTrader5 conectado")
+
+            else:
+
+                click.echo(f"{status(False)} MetaTrader5 não respondeu")
+
+    except Exception as exc:
+
+        click.echo(f"{status(False)} Falha na conexão MT5")
+
+        logger.exception("Erro ao conectar MT5: %s", exc)
+
+    # ---------------------------------------------------------
+    # Plugins
+    # ---------------------------------------------------------
+
+    click.echo("\nPlugins:")
+
+    try:
+
+        entry_points = list(discover_plugins())
+
+        if not entry_points:
+
+            click.echo("   Nenhum plugin encontrado.")
+            return
+
+        ok_count = 0
+        fail_count = 0
+
+        for ep in entry_points:
+
+            plugin_name = ep.name
+
+            try:
+
+                ep.load()
+
+                click.echo(f"   OK  {plugin_name}")
+
+                ok_count += 1
+
+            except Exception as exc:
+
+                click.echo(f"   ERRO {plugin_name}")
+
+                click.echo(f"       {exc}")
+
+                logger.error(
+                    "Erro ao carregar plugin %s\n%s",
+                    plugin_name,
+                    traceback.format_exc(),
+                )
+
+                fail_count += 1
+
+        click.echo(
+            f"\nResumo: {ok_count} plugins OK | {fail_count} com erro"
+        )
+
+    except Exception as exc:
+
+        click.echo(f"{status(False)} Falha ao descobrir plugins")
+
+        logger.exception("Erro ao descobrir plugins: %s", exc)
+
+    click.echo("\nDiagnóstico concluído.")

mtcli-3.7.0/mtcli/conf.py

@@ -0,0 +1,309 @@
+"""
+Sistema central de configuração do mtcli.
+
+Fornece leitura de configuração a partir de:
+
+1. Variáveis de ambiente
+2. Arquivo mtcli.ini
+3. Valores default
+
+Também oferece utilidades usadas por plugins como:
+
+- descoberta do diretório MQL5/Files
+- seleção da fonte de dados (CSV ou MT5)
+
+Plugins novos devem acessar a configuração através do objeto global `conf`.
+
+Compatibilidade retroativa:
+---------------------------
+Plugins antigos utilizavam:
+
+    from mtcli.conf import config
+
+onde `config` era um objeto `configparser.ConfigParser`.
+
+Para manter compatibilidade com plugins já publicados,
+o objeto `config` continua sendo exposto.
+
+Essa API é considerada **deprecated** e poderá ser removida
+em versões futuras do mtcli.
+"""
+
+import os
+import configparser
+
+import MetaTrader5 as mt5
+
+from mtcli.mt5_context import mt5_conexao
+
+
+class Config:
+    """
+    Gerenciador central de configurações do mtcli.
+
+    Permite acessar valores a partir de:
+
+    - variáveis de ambiente
+    - arquivo mtcli.ini
+    - valores default
+
+    Plugins devem preferencialmente usar:
+
+        from mtcli.conf import conf
+        conf.get(...)
+    """
+
+    def __init__(self, filename="mtcli.ini"):
+        self.config = configparser.ConfigParser()
+        self.config.read(filename)
+
+    # ---------------------------------------------------------
+    # leitura de valores
+    # ---------------------------------------------------------
+
+    def get(self, key, section="DEFAULT", cast=None, default=None):
+        """
+        Retorna um valor de configuração.
+
+        Prioridade:
+
+        1. Variável de ambiente SECTION_KEY
+        2. Variável de ambiente KEY
+        3. mtcli.ini [section]
+        4. mtcli.ini [DEFAULT]
+        5. default
+
+        Args:
+            key (str):
+                Nome da configuração.
+
+            section (str):
+                Seção do arquivo mtcli.ini.
+
+            cast (type | None):
+                Tipo para conversão do valor.
+
+            default (Any):
+                Valor padrão.
+
+        Returns:
+            Any
+        """
+
+        env_key = f"{section.upper()}_{key.upper()}"
+
+        value = os.getenv(env_key) or os.getenv(key.upper())
+
+        if value is None:
+
+            if self.config.has_option(section, key):
+                value = self.config.get(section, key)
+
+            elif self.config.has_option("DEFAULT", key):
+                value = self.config.get("DEFAULT", key)
+
+            else:
+                value = default
+
+        if cast and value is not None:
+
+            try:
+
+                if cast is bool:
+                    value = str(value).lower() in ("1", "true", "yes")
+
+                else:
+                    value = cast(value)
+
+            except ValueError:
+                value = default
+
+        return value
+
+    # ---------------------------------------------------------
+    # seção helper
+    # ---------------------------------------------------------
+
+    def section(self, section):
+        """
+        Retorna um helper para acessar uma seção específica.
+
+        Example:
+
+            renko = conf.section("renko")
+            brick = renko.get("brick", cast=int, default=10)
+        """
+
+        class Section:
+            def __init__(self, parent, section):
+                self.parent = parent
+                self.section = section
+
+            def get(self, key, cast=None, default=None):
+                return self.parent.get(key, self.section, cast, default)
+
+        return Section(self, section)
+
+    # ---------------------------------------------------------
+    # caminho MT5
+    # ---------------------------------------------------------
+
+    def get_csv_path(self):
+        """
+        Retorna o caminho da pasta MQL5/Files do MetaTrader 5.
+
+        A prioridade é:
+
+        1. mtcli.ini -> mt5_pasta
+        2. descoberta automática via MT5
+
+        Returns:
+            str: caminho normalizado da pasta Files.
+        """
+
+        path = self.get("mt5_pasta")
+
+        if path:
+            return os.path.normpath(path) + os.sep
+
+        with mt5_conexao():
+
+            info = mt5.terminal_info()
+
+            if info is None:
+                raise RuntimeError(
+                    "Não foi possível obter informações do terminal MT5."
+                )
+
+        path = os.path.join(info.data_path, "MQL5", "Files")
+
+        return os.path.normpath(path) + os.sep
+
+    # ---------------------------------------------------------
+    # data source
+    # ---------------------------------------------------------
+
+    def get_data_source(self, source=None):
+        """
+        Retorna a fonte de dados configurada.
+
+        Args:
+            source (str | None):
+                Fonte explícita ("csv" ou "mt5").
+
+        Returns:
+            DataSource
+        """
+
+        from mtcli.data import CsvDataSource, MT5DataSource
+
+        src = (source or self.get("dados", default="mt5")).lower()
+
+        if src == "csv":
+            return CsvDataSource()
+
+        if src == "mt5":
+            return MT5DataSource()
+
+        raise ValueError(f"Fonte de dados desconhecida: {src}")
+
+
+# ---------------------------------------------------------
+# instância global usada por todo o sistema
+# ---------------------------------------------------------
+
+conf = Config()
+
+# ---------------------------------------------------------
+# compatibilidade com plugins antigos
+# ---------------------------------------------------------
+#
+# Plugins antigos utilizam:
+#
+#     from mtcli.conf import config
+#
+# onde `config` era um ConfigParser.
+#
+# Mantemos esse objeto apontando para o ConfigParser interno
+# para evitar quebra de compatibilidade.
+#
+# API DEPRECATED – usar `conf.get()` em novos plugins.
+#
+
+config = conf.config
+
+
+# ---------------------------------------------------------
+# timeframes suportados
+# ---------------------------------------------------------
+
+_HOURS = [12, 8, 6, 4, 3, 2, 1]
+_MINUTES = [30, 20, 15, 12, 10, 6, 5, 4, 3, 2, 1]
+
+TIMEFRAMES = (
+    ["mn1", "w1", "d1"]
+    + [f"h{i}" for i in _HOURS]
+    + [f"m{i}" for i in _MINUTES]
+)
+
+# ---------------------------------------------------------
+# Configurações gerais
+# ---------------------------------------------------------
+
+SYMBOL = conf.get("symbol", default="WIN$N")
+DIGITOS = conf.get("digitos", cast=int, default=2)
+PERIOD = conf.get("period", default="D1")
+BARS = conf.get("count", cast=int, default=999)
+
+VIEW = conf.get("view", default="ch")
+VOLUME = conf.get("volume", default="tick")
+DATE = conf.get("date", default="")
+
+# ---------------------------------------------------------
+# Configurações de leitura de candles
+# ---------------------------------------------------------
+
+LATERAL = conf.get("lateral", default="doji")
+ALTA = conf.get("alta", default="verde")
+BAIXA = conf.get("baixa", default="vermelho")
+
+ROMPIMENTO_ALTA = conf.get("rompimento_alta", default="c")
+ROMPIMENTO_BAIXA = conf.get("rompimento_baixa", default="v")
+
+PERCENTUAL_ROMPIMENTO = conf.get(
+    "percentual_rompimento",
+    cast=int,
+    default=50,
+)
+
+PERCENTUAL_DOJI = conf.get(
+    "percentual_doji",
+    cast=int,
+    default=10,
+)
+
+# ---------------------------------------------------------
+# Configurações de padrões de barra
+# ---------------------------------------------------------
+
+UP_BAR = conf.get("up_bar", default="asc")
+DOWN_BAR = conf.get("down_bar", default="desc")
+
+INSIDE_BAR = conf.get("inside_bar", default="ib")
+OUTSIDE_BAR = conf.get("outside_bar", default="ob")
+
+SOMBRA_SUPERIOR = conf.get("sombra_superior", default="top")
+SOMBRA_INFERIOR = conf.get("sombra_inferior", default="bottom")
+
+# ---------------------------------------------------------
+# Fonte de dados
+# ---------------------------------------------------------
+
+DATA_SOURCE_NAME = conf.get("dados", default="mt5").lower()
+DATA_SOURCE = conf.get_data_source()
+
+# ---------------------------------------------------------
+# caminho inicial do CSV (pode vir do ini/env)
+# ---------------------------------------------------------
+
+_INITIAL_CSV_PATH = conf.get_csv_path()

mtcli-3.7.0/mtcli/config_registre.py

@@ -0,0 +1,41 @@
+"""
+Registry de configurações do mtcli.
+
+Plugins podem registrar suas opções de configuração aqui
+para permitir descoberta automática via CLI.
+"""
+
+
+class ConfigOption:
+    """
+    Representa uma opção de configuração registrada.
+    """
+
+    def __init__(self, section, name, type=str, default=None, description=""):
+        self.section = section
+        self.name = name
+        self.type = type
+        self.default = default
+        self.description = description
+
+
+class ConfigRegistry:
+    """
+    Registro central de opções de configuração.
+    """
+
+    def __init__(self):
+        self._options = []
+
+    def register(self, section, name, type=str, default=None, description=""):
+        option = ConfigOption(section, name, type, default, description)
+        self._options.append(option)
+
+    def get_all(self):
+        return self._options
+
+    def get_section(self, section):
+        return [o for o in self._options if o.section == section]
+
+
+registry = ConfigRegistry()