mtcli 3.5.1__tar.gz → 3.6.0.dev0__tar.gz

{mtcli-3.5.1 → mtcli-3.6.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mtcli
-Version: 3.5.1
+Version: 3.6.0.dev0
 Summary: Aplicativo CLI para exibir gráficos do MetaTrader 5 screen reader friendly
 License-Expression: MIT
 License-File: LICENSE
@@ -8,7 +8,7 @@ Keywords: trading,candlestick,metatrader5,mt5,cli,price-action
 Author: Valmir França da Silva
 Author-email: vfranca3@gmail.com
 Requires-Python: >=3.10,<3.14.0
-Classifier: Development Status :: 5 - Production/Stable
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Financial and Insurance Industry
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10

mtcli-3.6.0.dev0/mtcli/cli.py

@@ -0,0 +1,32 @@
+"""
+Comando principal do mtcli.
+"""
+
+import click
+from mtcli.plugin_loader import load_plugins
+
+# --- CLI principal ---
+@click.group(context_settings={"max_content_width": 120})
+@click.version_option(package_name="mtcli")
+def mt():
+    """
+    MTCLI - CLI para gráficos candlestick screen reader friendly.
+
+    Comandos disponíveis:
+        - Subcomandos (bars, conf, logs)
+        - Plugins internos e externos
+    """
+    pass
+
+# --- Carrega subcomandos do mt e plugins ---
+# Os comandos do diretório commands são registrados aqui diretamente
+from mtcli.commands import bars
+
+mt.add_command(bars.bars, name="bars")
+
+# --- Carrega plugins internos e externos via plugin_loader ---
+load_plugins(mt)
+
+# --- Entry point para execução direta ---
+if __name__ == "__main__":
+    mt()

mtcli-3.6.0.dev0/mtcli/conf.py

@@ -0,0 +1,199 @@
+"""
+Configurações principais do mtcli.
+
+Este módulo centraliza a leitura de configurações provenientes de:
+
+1. Variáveis de ambiente
+2. Arquivo mtcli.ini
+
+As variáveis de ambiente sempre têm prioridade sobre o arquivo INI.
+
+Também fornece utilidades para obter o caminho de arquivos do
+terminal MetaTrader5 e selecionar a fonte de dados (CSV ou MT5).
+
+O acesso ao terminal MT5 é realizado apenas sob demanda para evitar
+efeitos colaterais durante a importação do módulo (import side effects),
+facilitando testes automatizados e execução em ambientes CI/CD.
+"""
+
+import os
+import configparser
+
+import MetaTrader5 as mt5
+
+from mtcli.mt5_context import mt5_conexao
+
+# ---------------------------------------------------------
+# Carregamento do arquivo de configuração
+# ---------------------------------------------------------
+
+CONFIG_FILE = "mtcli.ini"
+SECTION = "DEFAULT"
+
+config = configparser.ConfigParser()
+config.read(CONFIG_FILE)
+
+
+def get_config_value(key: str, cast=None, fallback=None):
+    """
+    Retorna um valor de configuração.
+
+    A prioridade de leitura é:
+    1. Variável de ambiente
+    2. Arquivo mtcli.ini
+    3. Valor fallback
+
+    Args:
+        key (str): Nome da chave de configuração.
+        cast (type | None): Tipo de conversão (ex: int, float).
+        fallback (Any): Valor padrão caso não encontrado.
+
+    Returns:
+        Any: valor convertido ou fallback.
+    """
+    value = os.getenv(key)
+
+    if value is None:
+        try:
+            if cast == int:
+                value = config.getint(SECTION, key, fallback=fallback)
+            elif cast == float:
+                value = config.getfloat(SECTION, key, fallback=fallback)
+            else:
+                value = config.get(SECTION, key, fallback=fallback)
+        except (configparser.NoOptionError, ValueError):
+            value = fallback
+    else:
+        if cast:
+            try:
+                value = cast(value)
+            except ValueError:
+                value = fallback
+
+    return value
+
+
+# ---------------------------------------------------------
+# Configurações gerais
+# ---------------------------------------------------------
+
+SYMBOL = get_config_value("symbol", fallback="WIN$N")
+DIGITOS = get_config_value("digitos", cast=int, fallback=2)
+PERIOD = get_config_value("period", fallback="D1")
+BARS = get_config_value("count", cast=int, fallback=999)
+
+VIEW = get_config_value("view", fallback="ch")
+VOLUME = get_config_value("volume", fallback="tick")
+DATE = get_config_value("date", fallback="")
+
+# ---------------------------------------------------------
+# Configurações de leitura de candles
+# ---------------------------------------------------------
+
+LATERAL = get_config_value("lateral", fallback="doji")
+ALTA = get_config_value("alta", fallback="verde")
+BAIXA = get_config_value("baixa", fallback="vermelho")
+
+ROMPIMENTO_ALTA = get_config_value("rompimento_alta", fallback="c")
+ROMPIMENTO_BAIXA = get_config_value("rompimento_baixa", fallback="v")
+
+PERCENTUAL_ROMPIMENTO = get_config_value(
+    "percentual_rompimento", cast=int, fallback=50
+)
+
+PERCENTUAL_DOJI = get_config_value(
+    "percentual_doji", cast=int, fallback=10
+)
+
+# ---------------------------------------------------------
+# Configurações de padrões de barra
+# ---------------------------------------------------------
+
+UP_BAR = get_config_value("up_bar", fallback="asc")
+DOWN_BAR = get_config_value("down_bar", fallback="desc")
+
+INSIDE_BAR = get_config_value("inside_bar", fallback="ib")
+OUTSIDE_BAR = get_config_value("outside_bar", fallback="ob")
+
+SOMBRA_SUPERIOR = get_config_value("sombra_superior", fallback="top")
+SOMBRA_INFERIOR = get_config_value("sombra_inferior", fallback="bottom")
+
+# ---------------------------------------------------------
+# Fonte de dados
+# ---------------------------------------------------------
+
+DATA_SOURCE = get_config_value("dados", fallback="mt5").lower()
+
+# caminho inicial (pode vir do ini/env)
+_INITIAL_CSV_PATH = get_config_value("mt5_pasta", fallback="")
+
+
+def get_csv_path():
+    """
+    Retorna o caminho da pasta de arquivos do MT5 ou CSV.
+
+    Se o caminho não estiver definido no mtcli.ini ou nas
+    variáveis de ambiente, o terminal MT5 é consultado para
+    descobrir automaticamente a pasta MQL5/Files.
+
+    Returns:
+        str: caminho normalizado da pasta de arquivos.
+    """
+    if _INITIAL_CSV_PATH:
+        path = _INITIAL_CSV_PATH
+    else:
+        with mt5_conexao():
+            terminal_info = mt5.terminal_info()
+
+            if terminal_info is None:
+                raise RuntimeError(
+                    "Não foi possível obter as informações do terminal MT5."
+                )
+
+        path = os.path.join(terminal_info.data_path, "MQL5", "Files")
+
+    return os.path.normpath(path) + os.sep
+
+
+# ---------------------------------------------------------
+# Factory de DataSource
+# ---------------------------------------------------------
+
+def get_data_source(source=None):
+    """
+    Retorna a fonte de dados configurada.
+
+    Args:
+        source (str | None): sobrescreve DATA_SOURCE se fornecido.
+
+    Returns:
+        CsvDataSource | MT5DataSource
+
+    Raises:
+        ValueError: se a fonte de dados não for reconhecida.
+    """
+    from mtcli.data import CsvDataSource, MT5DataSource
+
+    src = source.lower() if source else DATA_SOURCE
+
+    if src == "csv":
+        return CsvDataSource()
+
+    if src == "mt5":
+        return MT5DataSource()
+
+    raise ValueError(f"Fonte de dados desconhecida: {src}")
+
+
+# ---------------------------------------------------------
+# 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]
+)

{mtcli-3.5.1 → mtcli-3.6.0.dev0}/mtcli/data/csv.py

@@ -16,7 +16,7 @@ class CsvDataSource(DataSourceBase):
 
     def get_data(self, symbol, period, count=100):
         """Retorna dados CSV em uma lista de lista."""
-        file_path = os.path.join(conf.csv_path, f"{symbol}{period}.csv")
+        file_path = os.path.join(conf._INITIAL_CSV_PATH, f"{symbol}{period}.csv")
         logger.info(f"Iniciando coleta de dados via CSV: {file_path}.")
         csv_data = []
         try:

{mtcli-3.5.1 → mtcli-3.6.0.dev0}/mtcli/models/bar_model.py

@@ -1,105 +1,105 @@
-"""Módulo da classe model da barra."""
-
-from datetime import datetime
-
-from mtcli import conf
-
-
-class BarModel:
-    """Classe do model da barra."""
-
-    def __init__(self, rate):
-        """Model da barra."""
-        self.datetime = rate[0]
-        self.date = self.__get_date()
-        self.time = self.__get_time()
-        self.open = float(rate[1])
-        self.high = float(rate[2])
-        self.low = float(rate[3])
-        self.close = float(rate[4])
-        self.volume = int(rate[5])
-        self.volume_real = int(rate[6])
-        self.range = self.__get_range()
-        self.body = self.__get_body()
-        self.top = self.__get_top()
-        self.bottom = self.__get_bottom()
-        self.body_range = self.__get_body_range()
-        self.trend = self.__get_trend()
-        self.medium_point = self.__get_medium_point()
-
-    def __get_date(self):
-        """Obtem a data da barra no formato YYYY-MM-DD."""
-        data = datetime.strptime(self.datetime, "%Y.%m.%d %H:%M:%S")
-        return data.date()
-
-    def __get_time(self):
-        """Obtem o horário da barra no formato HH:MM:SS."""
-        hora = datetime.strptime(self.datetime, "%Y.%m.%d %H:%M:%S")
-        hora = hora.time()
-        return hora.strftime("%H:%M")
-
-    def __get_range(self):
-        """Obtem o range da barra."""
-        return self.high - self.low
-
-    def __get_body(self):
-        """Calcula o   range relativo do corpo da barra em porcentagem."""
-        if self.range == 0:
-            return 0
-
-        return round((self.close - self.open) / self.range * 100)
-
-    def __get_top(self):
-        """Calcula o range relativo da sombra superior da barra em porcentagem."""
-        high = self.high
-        open = self.open
-        close = self.close
-        range = self.range
-
-        if close >= open:
-            top = high - close
-        else:
-            top = high - open
-
-        if range == 0:
-            return 0
-
-        return round(top / range * 100)
-
-    def __get_bottom(self):
-        """Obtem o range relativo da sombra inferior da barra em porcentagem."""
-        low = self.low
-        open = self.open
-        close = self.close
-        range = self.range
-
-        if close >= open:
-            bottom = open - low
-        else:
-            bottom = close - low
-
-        if range == 0:
-            return 0
-
-        return round(bottom / range * 100)
-
-    def __get_body_range(self):
-        """Calcula o range do corpo da barra."""
-        return abs(self.close - self.open)
-
-    def __get_trend(self):
-        """Obtem a tendência da barra."""
-        b = self.body
-
-        if b > 0:
-            trend = conf.alta
-        elif b < 0:
-            trend = conf.baixa
-        else:
-            trend = conf.lateral
-
-        return trend
-
-    def __get_medium_point(self):
-        """Obtem o ponto médio da barra."""
-        return round(self.low + self.range / 2, conf.digitos)
+"""Módulo da classe model da barra."""
+
+from datetime import datetime
+
+from mtcli import conf
+
+
+class BarModel:
+    """Classe do model da barra."""
+
+    def __init__(self, rate):
+        """Model da barra."""
+        self.datetime = rate[0]
+        self.date = self.__get_date()
+        self.time = self.__get_time()
+        self.open = float(rate[1])
+        self.high = float(rate[2])
+        self.low = float(rate[3])
+        self.close = float(rate[4])
+        self.volume = int(rate[5])
+        self.volume_real = int(rate[6])
+        self.range = self.__get_range()
+        self.body = self.__get_body()
+        self.top = self.__get_top()
+        self.bottom = self.__get_bottom()
+        self.body_range = self.__get_body_range()
+        self.trend = self.__get_trend()
+        self.medium_point = self.__get_medium_point()
+
+    def __get_date(self):
+        """Obtem a data da barra no formato YYYY-MM-DD."""
+        data = datetime.strptime(self.datetime, "%Y.%m.%d %H:%M:%S")
+        return data.date()
+
+    def __get_time(self):
+        """Obtem o horário da barra no formato HH:MM:SS."""
+        hora = datetime.strptime(self.datetime, "%Y.%m.%d %H:%M:%S")
+        hora = hora.time()
+        return hora.strftime("%H:%M")
+
+    def __get_range(self):
+        """Obtem o range da barra."""
+        return self.high - self.low
+
+    def __get_body(self):
+        """Calcula o   range relativo do corpo da barra em porcentagem."""
+        if self.range == 0:
+            return 0
+
+        return round((self.close - self.open) / self.range * 100)
+
+    def __get_top(self):
+        """Calcula o range relativo da sombra superior da barra em porcentagem."""
+        high = self.high
+        open = self.open
+        close = self.close
+        range = self.range
+
+        if close >= open:
+            top = high - close
+        else:
+            top = high - open
+
+        if range == 0:
+            return 0
+
+        return round(top / range * 100)
+
+    def __get_bottom(self):
+        """Obtem o range relativo da sombra inferior da barra em porcentagem."""
+        low = self.low
+        open = self.open
+        close = self.close
+        range = self.range
+
+        if close >= open:
+            bottom = open - low
+        else:
+            bottom = close - low
+
+        if range == 0:
+            return 0
+
+        return round(bottom / range * 100)
+
+    def __get_body_range(self):
+        """Calcula o range do corpo da barra."""
+        return abs(self.close - self.open)
+
+    def __get_trend(self):
+        """Obtem a tendência da barra."""
+        b = self.body
+
+        if b > 0:
+            trend = conf.ALTA
+        elif b < 0:
+            trend = conf.BAIXA
+        else:
+            trend = conf.LATERAL
+
+        return trend
+
+    def __get_medium_point(self):
+        """Obtem o ponto médio da barra."""
+        return round(self.low + self.range / 2, conf.DIGITOS)

{mtcli-3.5.1 → mtcli-3.6.0.dev0}/mtcli/models/consecutive_bars_model.py

@@ -1,77 +1,77 @@
-"""Módulo da classe model de leituras de barras consecutivas."""
-
-from mtcli import conf
-
-
-class ConsecutiveBarsModel:
-    """Classe model da leitura de barras consecutivas."""
-
-    def __init__(self, bodys, opens, closes, highs, lows, volumes=[]):
-        """Model da leitura de barras consecutivas."""
-        self.bodys = bodys
-        self.opens = opens
-        self.closes = closes
-        self.highs = highs
-        self.lows = lows
-        self.volumes = volumes
-
-    def gap(self):
-        """Leitura do gap de rompimento de duas barras."""
-        if self.__is_gap():
-            if self.bodys[1] > 0:
-                gap = self.closes[1] - self.highs[0]
-            if self.bodys[1] < 0:
-                gap = self.lows[0] - self.closes[1]
-            return gap
-        return ""
-
-    def __is_gap(self):
-        """Verifica se existe gap de rompimento entre duas barras."""
-        if self.bodys[1] == 0:
-            return False
-        if self.bodys[1] > 0 and self.closes[1] <= self.highs[0]:
-            return False
-        if self.bodys[1] < 0 and self.closes[1] >= self.lows[0]:
-            return False
-        return True
-
-    def sequencia(self):
-        """Leitura da tendência da sequência de duas barras."""
-        if self.highs[1] > self.highs[0] and self.lows[1] > self.lows[0]:
-            return conf.up_bar
-        if self.highs[1] < self.highs[0] and self.lows[1] < self.lows[0]:
-            return conf.down_bar
-        if self.highs[1] <= self.highs[0] and self.lows[1] >= self.lows[0]:
-            return conf.inside_bar
-        if self.highs[1] > self.highs[0] and self.lows[1] < self.lows[0]:
-            return conf.outside_bar
-        return ""
-
-    def volume(self):
-        """Comparação entre volumes consecutivos."""
-        sequencia = ""
-        anterior = self.volumes[0]
-        posterior = self.volumes[1]
-        if posterior > anterior:
-            sequencia = conf.alta
-        if posterior < anterior:
-            sequencia = conf.baixa
-        return sequencia
-
-    def continuacao(self):
-        """Verifica se há continuação de movimento com corpo na mesma direção."""
-        return self.bodys[0] * self.bodys[1] > 0 and abs(self.bodys[1]) > abs(
-            self.bodys[0]
-        )
-
-    def reversao(self):
-        """Verifica reversão pelo corpo oposto com maior intensidade."""
-        return self.bodys[0] * self.bodys[1] < 0 and abs(self.bodys[1]) > abs(
-            self.bodys[0]
-        )
-
-    def volume_spike(self, fator=2):
-        """Detecta clímax de volume (volume da segunda barra bem maior)."""
-        if len(self.volumes) < 2:
-            return False
-        return self.volumes[1] > self.volumes[0] * fator
+"""Módulo da classe model de leituras de barras consecutivas."""
+
+from mtcli import conf
+
+
+class ConsecutiveBarsModel:
+    """Classe model da leitura de barras consecutivas."""
+
+    def __init__(self, bodys, opens, closes, highs, lows, volumes=[]):
+        """Model da leitura de barras consecutivas."""
+        self.bodys = bodys
+        self.opens = opens
+        self.closes = closes
+        self.highs = highs
+        self.lows = lows
+        self.volumes = volumes
+
+    def gap(self):
+        """Leitura do gap de rompimento de duas barras."""
+        if self.__is_gap():
+            if self.bodys[1] > 0:
+                gap = self.closes[1] - self.highs[0]
+            if self.bodys[1] < 0:
+                gap = self.lows[0] - self.closes[1]
+            return gap
+        return ""
+
+    def __is_gap(self):
+        """Verifica se existe gap de rompimento entre duas barras."""
+        if self.bodys[1] == 0:
+            return False
+        if self.bodys[1] > 0 and self.closes[1] <= self.highs[0]:
+            return False
+        if self.bodys[1] < 0 and self.closes[1] >= self.lows[0]:
+            return False
+        return True
+
+    def sequencia(self):
+        """Leitura da tendência da sequência de duas barras."""
+        if self.highs[1] > self.highs[0] and self.lows[1] > self.lows[0]:
+            return conf.UP_BAR
+        if self.highs[1] < self.highs[0] and self.lows[1] < self.lows[0]:
+            return conf.DOWN_BAR
+        if self.highs[1] <= self.highs[0] and self.lows[1] >= self.lows[0]:
+            return conf.INSIDE_BAR
+        if self.highs[1] > self.highs[0] and self.lows[1] < self.lows[0]:
+            return conf.OUTSIDE_BAR
+        return ""
+
+    def volume(self):
+        """Comparação entre volumes consecutivos."""
+        sequencia = ""
+        anterior = self.volumes[0]
+        posterior = self.volumes[1]
+        if posterior > anterior:
+            sequencia = conf.ALTA
+        if posterior < anterior:
+            sequencia = conf.BAIXA
+        return sequencia
+
+    def continuacao(self):
+        """Verifica se há continuação de movimento com corpo na mesma direção."""
+        return self.bodys[0] * self.bodys[1] > 0 and abs(self.bodys[1]) > abs(
+            self.bodys[0]
+        )
+
+    def reversao(self):
+        """Verifica reversão pelo corpo oposto com maior intensidade."""
+        return self.bodys[0] * self.bodys[1] < 0 and abs(self.bodys[1]) > abs(
+            self.bodys[0]
+        )
+
+    def volume_spike(self, fator=2):
+        """Detecta clímax de volume (volume da segunda barra bem maior)."""
+        if len(self.volumes) < 2:
+            return False
+        return self.volumes[1] > self.volumes[0] * fator