mtcli-renko 1.0.0.dev3__tar.gz → 1.1.0.dev0__tar.gz

mtcli_renko-1.1.0.dev0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Valmir França
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mtcli_renko-1.1.0.dev0/PKG-INFO

@@ -0,0 +1,240 @@
+Metadata-Version: 2.4
+Name: mtcli-renko
+Version: 1.1.0.dev0
+Summary: Renko plugin institucional para mtcli (MetaTrader 5)
+License-Expression: MIT
+License-File: LICENSE
+Keywords: trading,renko,metatrader5,mt5,cli,price-action
+Author: Valmir França
+Author-email: vfranca3@gmail.com
+Requires-Python: >=3.10,<3.14
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Requires-Dist: click (>=8.3.0,<9.0.0)
+Requires-Dist: metatrader5 (>=5.0.5370,<6.0.0)
+Requires-Dist: mtcli (>=3.2.0)
+Project-URL: Documentation, https://vfranca.github.io/mtcli-renko
+Project-URL: Homepage, https://github.com/vfranca/mtcli-renko
+Project-URL: Issues, https://github.com/vfranca/mtcli-renko/issues
+Project-URL: Repository, https://github.com/vfranca/mtcli-renko
+Description-Content-Type: text/markdown
+
+# mtcli-renko
+
+Renko institucional para MetaTrader 5 integrado ao ecossistema `mtcli`.
+
+Geração de gráfico Renko em modo texto (terminal), com:
+
+- Renko simples
+- Renko clássico (reversão 2x)
+- Ancoragem real no último pregão
+- Controle de barras por sessão
+- Compatível com B3, Forex e ativos 24h
+- Ideal para uso via CLI e automação
+
+---
+
+## Instalação
+
+Via pip:
+
+```bash
+pip install mtcli-renko
+````
+
+Ou via Poetry:
+
+```bash
+poetry add mtcli-renko
+```
+
+---
+
+## Requisitos
+
+* Python 3.10+
+* MetaTrader 5 instalado
+* Conta conectada ao terminal MT5
+* Plugin `mtcli` configurado
+
+---
+
+## Uso
+
+Após instalar, o comando fica disponível dentro do `mt`:
+
+```bash
+mt renko --symbol WINJ26 --brick 50
+```
+
+---
+
+## Parâmetros
+
+| Opção                | Descrição                         |
+| -------------------- | --------------------------------- |
+| `--symbol`, `-s`     | Ativo (ex: WINJ26)                |
+| `--brick`, `-b`      | Tamanho do brick                  |
+| `--timeframe`, `-t`  | Timeframe (m1, m5, m15, h1, etc.) |
+| `--bars`, `-n`       | Quantidade de barras base         |
+| `--modo`             | `simples` ou `classico`           |
+| `--ancorar-abertura` | Ancora no último pregão           |
+
+---
+
+## Exemplos
+
+### Renko simples padrão
+
+```bash
+mt renko -s WINJ26 -b 50
+```
+
+### Renko clássico (reversão 2x)
+
+```bash
+mt renko -s WINJ26 -b 50 --modo classico
+```
+
+### Ancorado no último pregão
+
+```bash
+mt renko -s WINJ26 -b 50 --ancorar-abertura
+```
+
+### Todas as barras do último pregão
+
+```bash
+mt renko -s WINJ26 -b 50 --ancorar-abertura --bars 0
+```
+
+### Últimas 20 barras do último pregão
+
+```bash
+mt renko -s WINJ26 -b 50 --ancorar-abertura --bars 20
+```
+
+---
+
+## Timeframes aceitos
+
+Use valores simplificados:
+
+* m1
+* m5
+* m15
+* m30
+* h1
+* h4
+* d1
+
+O sistema faz o mapeamento automático para as constantes do MetaTrader 5.
+
+---
+
+## Ancoragem Institucional
+
+Quando `--ancorar-abertura` é ativado:
+
+* Detecta o último candle disponível
+* Descobre a data do último pregão real
+* Filtra manualmente apenas aquele dia
+* Ignora histórico anterior
+* Funciona inclusive em domingos e feriados
+
+Comportamento:
+
+* `--bars 0` → todas as barras do último pregão
+* `--bars N` → últimas N barras daquele pregão
+
+---
+
+## Modos de Construção
+
+### Simples
+
+Cria bricks contínuos sem regra de reversão 2x.
+
+### Clássico
+
+Implementa reversão apenas quando o preço move 2x o tamanho do brick na direção oposta.
+
+---
+
+## Estrutura do Projeto
+
+```
+mtcli_renko/
+│
+├── commands/
+├── controllers/
+├── models/
+├── views/
+├── conf.py
+└── enums.py
+```
+
+Arquitetura baseada em MVC, alinhada ao padrão do `mtcli-trade`.
+
+---
+
+## Casos de Uso
+
+* Leitura de estrutura (H1, H2, H3, L1, L2)
+* Identificação de BRF / BLF
+* Automação de análise
+* Backtesting via script
+* Operação institucional via terminal
+
+---
+
+## Compatibilidade
+
+* B3 (ex: WIN, WDO)
+* Forex
+* Cripto
+* Ativos 24h
+
+---
+
+## Roadmap
+
+* [ ] Múltiplas sessões
+* [ ] Filtro de horário (09:00–18:00)
+* [ ] VWAP integrada
+* [ ] Detecção automática de estrutura (H1/H2/L2)
+* [ ] Exportação CSV
+
+---
+
+## Licença
+
+MIT License
+
+---
+
+## Autor
+
+Valmir França
+
+---
+
+## Contribuição
+
+Pull requests são bem-vindos.
+Para mudanças maiores, abra uma issue antes para discussão.
+
+---
+
+## Aviso
+
+Este software não constitui recomendação de investimento.
+Uso por conta e risco do operador.
+

mtcli_renko-1.1.0.dev0/README.md

@@ -0,0 +1,211 @@
+# mtcli-renko
+
+Renko institucional para MetaTrader 5 integrado ao ecossistema `mtcli`.
+
+Geração de gráfico Renko em modo texto (terminal), com:
+
+- Renko simples
+- Renko clássico (reversão 2x)
+- Ancoragem real no último pregão
+- Controle de barras por sessão
+- Compatível com B3, Forex e ativos 24h
+- Ideal para uso via CLI e automação
+
+---
+
+## Instalação
+
+Via pip:
+
+```bash
+pip install mtcli-renko
+````
+
+Ou via Poetry:
+
+```bash
+poetry add mtcli-renko
+```
+
+---
+
+## Requisitos
+
+* Python 3.10+
+* MetaTrader 5 instalado
+* Conta conectada ao terminal MT5
+* Plugin `mtcli` configurado
+
+---
+
+## Uso
+
+Após instalar, o comando fica disponível dentro do `mt`:
+
+```bash
+mt renko --symbol WINJ26 --brick 50
+```
+
+---
+
+## Parâmetros
+
+| Opção                | Descrição                         |
+| -------------------- | --------------------------------- |
+| `--symbol`, `-s`     | Ativo (ex: WINJ26)                |
+| `--brick`, `-b`      | Tamanho do brick                  |
+| `--timeframe`, `-t`  | Timeframe (m1, m5, m15, h1, etc.) |
+| `--bars`, `-n`       | Quantidade de barras base         |
+| `--modo`             | `simples` ou `classico`           |
+| `--ancorar-abertura` | Ancora no último pregão           |
+
+---
+
+## Exemplos
+
+### Renko simples padrão
+
+```bash
+mt renko -s WINJ26 -b 50
+```
+
+### Renko clássico (reversão 2x)
+
+```bash
+mt renko -s WINJ26 -b 50 --modo classico
+```
+
+### Ancorado no último pregão
+
+```bash
+mt renko -s WINJ26 -b 50 --ancorar-abertura
+```
+
+### Todas as barras do último pregão
+
+```bash
+mt renko -s WINJ26 -b 50 --ancorar-abertura --bars 0
+```
+
+### Últimas 20 barras do último pregão
+
+```bash
+mt renko -s WINJ26 -b 50 --ancorar-abertura --bars 20
+```
+
+---
+
+## Timeframes aceitos
+
+Use valores simplificados:
+
+* m1
+* m5
+* m15
+* m30
+* h1
+* h4
+* d1
+
+O sistema faz o mapeamento automático para as constantes do MetaTrader 5.
+
+---
+
+## Ancoragem Institucional
+
+Quando `--ancorar-abertura` é ativado:
+
+* Detecta o último candle disponível
+* Descobre a data do último pregão real
+* Filtra manualmente apenas aquele dia
+* Ignora histórico anterior
+* Funciona inclusive em domingos e feriados
+
+Comportamento:
+
+* `--bars 0` → todas as barras do último pregão
+* `--bars N` → últimas N barras daquele pregão
+
+---
+
+## Modos de Construção
+
+### Simples
+
+Cria bricks contínuos sem regra de reversão 2x.
+
+### Clássico
+
+Implementa reversão apenas quando o preço move 2x o tamanho do brick na direção oposta.
+
+---
+
+## Estrutura do Projeto
+
+```
+mtcli_renko/
+│
+├── commands/
+├── controllers/
+├── models/
+├── views/
+├── conf.py
+└── enums.py
+```
+
+Arquitetura baseada em MVC, alinhada ao padrão do `mtcli-trade`.
+
+---
+
+## Casos de Uso
+
+* Leitura de estrutura (H1, H2, H3, L1, L2)
+* Identificação de BRF / BLF
+* Automação de análise
+* Backtesting via script
+* Operação institucional via terminal
+
+---
+
+## Compatibilidade
+
+* B3 (ex: WIN, WDO)
+* Forex
+* Cripto
+* Ativos 24h
+
+---
+
+## Roadmap
+
+* [ ] Múltiplas sessões
+* [ ] Filtro de horário (09:00–18:00)
+* [ ] VWAP integrada
+* [ ] Detecção automática de estrutura (H1/H2/L2)
+* [ ] Exportação CSV
+
+---
+
+## Licença
+
+MIT License
+
+---
+
+## Autor
+
+Valmir França
+
+---
+
+## Contribuição
+
+Pull requests são bem-vindos.
+Para mudanças maiores, abra uma issue antes para discussão.
+
+---
+
+## Aviso
+
+Este software não constitui recomendação de investimento.
+Uso por conta e risco do operador.

mtcli_renko-1.1.0.dev0/mtcli_renko/commands/renko.py

@@ -0,0 +1,77 @@
+"""
+Comando CLI para geração de gráfico Renko.
+"""
+
+import click
+
+from ..controllers.renko_controller import RenkoController
+from ..views.renko_view import exibir_renko
+from ..domain.timeframe import Timeframe
+from mtcli.logger import setup_logger
+from ..conf import SYMBOL, BRICK, PERIOD, BARS, DATA_MODE, MAX_TICKS
+
+log = setup_logger(__name__)
+
+
+@click.command()
+@click.version_option(package_name="mtcli-renko")
+@click.option("--symbol", "-s", default=SYMBOL, show_default=True)
+@click.option("--brick", "-b", default=BRICK, show_default=True, type=float)
+@click.option("--timeframe", "-t", default=PERIOD, show_default=True)
+@click.option("--bars", "-n", default=BARS, show_default=True, type=int)
+@click.option("--numerar/--no-numerar", default=False, show_default=True)
+@click.option(
+    "--modo",
+    type=click.Choice(["simples", "classico"], case_sensitive=False),
+    default="simples",
+    show_default=True,
+)
+@click.option(
+    "--ancorar-abertura",
+    is_flag=True,
+    default=False,
+    show_default=True,
+)
+@click.option(
+    "--data-mode",
+    type=click.Choice(["candle", "tick"], case_sensitive=False),
+    default=DATA_MODE,
+    show_default=True,
+)
+@click.option(
+    "--max-ticks",
+    default=MAX_TICKS,
+    show_default=True,
+    type=int,
+    help="Limite máximo de ticks processados no modo tick.",
+)
+def renko(
+    symbol,
+    brick,
+    timeframe,
+    bars,
+    numerar,
+    modo,
+    ancorar_abertura,
+    data_mode,
+    max_ticks,
+):
+
+    try:
+        tf_enum = Timeframe.from_string(timeframe)
+    except ValueError as e:
+        raise click.BadParameter(str(e))
+
+    controller = RenkoController(
+        symbol,
+        brick,
+        tf_enum.mt5_const,
+        bars,
+        modo,
+        ancorar_abertura,
+        data_mode,
+        max_ticks,
+    )
+
+    bricks = controller.executar()
+    exibir_renko(bricks, numerar=numerar)

{mtcli_renko-1.0.0.dev3 → mtcli_renko-1.1.0.dev0}/mtcli_renko/conf.py

@@ -70,3 +70,20 @@ DIGITS = int(os.getenv(
     "DIGITS",
     _get_config_value("RENKO", "digits", 2)
 ))
+
+# Hora oficial de abertura do pregão (HH:MM)
+SESSION_OPEN = os.getenv(
+    "SESSION_OPEN",
+    _get_config_value("RENKO", "session_open", "09:00")
+)
+
+DATA_MODE = os.getenv(
+    "DATA_MODE",
+    _get_config_value("RENKO", "data_mode", "candle")
+)
+
+MAX_TICKS = int(os.getenv(
+    "MAX_TICKS",
+    _get_config_value("RENKO", "max_ticks", 10000)
+))
+

mtcli_renko-1.1.0.dev0/mtcli_renko/controllers/renko_controller.py

@@ -0,0 +1,66 @@
+"""
+Renko controller.
+"""
+
+from ..models.renko_model import RenkoModel
+from mtcli.logger import setup_logger
+
+log = setup_logger(__name__)
+
+
+class RenkoController:
+
+    def __init__(
+        self,
+        symbol,
+        brick_size,
+        timeframe,
+        quantidade,
+        modo="simples",
+        ancorar_abertura=False,
+        data_mode="candle",
+        max_ticks=3000,
+    ):
+        self.model = RenkoModel(symbol, brick_size)
+        self.timeframe = timeframe
+        self.quantidade = quantidade
+        self.modo = modo
+        self.ancorar_abertura = ancorar_abertura
+        self.data_mode = data_mode
+        self.max_ticks = max_ticks
+
+    def executar(self):
+
+        # -------------------------------------------------
+        # TICK MODE
+        # -------------------------------------------------
+
+        if self.data_mode == "tick":
+
+            ticks = self.model.obter_ticks(
+                timeframe=self.timeframe,
+                max_ticks=self.max_ticks,
+            )
+
+            if ticks is None or len(ticks) == 0:
+                return []
+
+            return self.model.construir_renko_ticks(ticks)
+
+        # -------------------------------------------------
+        # CANDLE MODE
+        # -------------------------------------------------
+
+        rates = self.model.obter_rates(
+            self.timeframe,
+            self.quantidade,
+            ancorar_abertura=self.ancorar_abertura,
+        )
+
+        if rates is None or len(rates) == 0:
+            return []
+
+        return self.model.construir_renko(
+            rates,
+            modo=self.modo,
+        )