mtcli 3.5.0.dev0__tar.gz → 4.0.0.dev0__tar.gz

mtcli-4.0.0.dev0/LICENSE

@@ -0,0 +1,17 @@
+GNU GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright (C) 2025 Valmir França da Silva
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.

{mtcli-3.5.0.dev0 → mtcli-4.0.0.dev0}/PKG-INFO

@@ -1,26 +1,22 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.3
 Name: mtcli
-Version: 3.5.0.dev0
-Summary: Aplicativo CLI para exibir gráficos do MetaTrader 5 screen reader friendly
-License-Expression: MIT
-License-File: LICENSE
-Keywords: trading,candlestick,metatrader5,mt5,cli,price-action
+Version: 4.0.0.dev0
+Summary: Aplicativo CLI para exibir gráficos do MetaTrader 5 em texto acessível ao leitor de telas
+License: GPL-3.0
+Keywords: MetaTrader 5,trading,CLI
 Author: Valmir França da Silva
 Author-email: vfranca3@gmail.com
 Requires-Python: >=3.10,<3.14.0
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 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.2.1,<9.0.0)
 Requires-Dist: metatrader5 (>=5.0.5260,<6.0.0)
 Project-URL: Documentation, https://mtcli.readthedocs.io/pt-br/latest
-Project-URL: Homepage, https://github.com:vfranca/mtcli
+Project-URL: Homepage, https://pypi.org/project/mtcli
 Project-URL: Repository, https://github.com/vfranca/mtcli
 Project-URL: issues, https://github.com/vfranca/mtcli/issues
 Description-Content-Type: text/markdown
@@ -169,5 +165,5 @@ GitHub: [@vfranca](https://github.com/vfranca)
   
 ## Licença
   
-Distribuído sob a licença MIT. Veja `LICENSE` para mais informações.
+Distribuído sob a licença GPL-3.0. Veja `LICENSE` para mais informações.
 

{mtcli-3.5.0.dev0 → mtcli-4.0.0.dev0}/README.md

@@ -1,145 +1,145 @@
-# 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*:
-  
-```bash
-pip install mtcli
-```
-  
-Ou diretamente a partir do código-fonte:
-  
-```bash
-git clone https://github.com/vfranca/mtcli.git
-cd mtcli
-pip install .
-```
-  
----
-  
-## Como usar
-  
-Após a instalação, o comando principal é:
-  
-```bash
-mt
-```
-  
-Você verá uma lista de comandos e plugins disponíveis.
-  
-Para executar um plugin específico, use:
-  
-```bash
-mt nome-do-plugin [opções]
-```
-  
-Exemplo com o plugin de média móvel:
-  
-```bash
-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
-  
-```bash
-git clone https://github.com/vfranca/mtcli.git
-cd mtcli
-```
-  
-Instalar dependências para desenvolvimento
-  
-```bash
-pip install -e ".[dev]"
-```
-Rodar os testes
-  
-```bash
-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
-  
-```toml
-pyproject.toml
-[project.entry-points."mtcli.plugins"]
-nome_do_plugin = "modulo.caminho:funcao_principal"
-```
-  
-Exemplo
-  
-```toml
-[project.entry-points."mtcli.plugins"]
-volume_medio = "mtcli.plugins.volume_medio:vm"
-```
-  
-No código Python:
-  
-```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:
-  
-```bash
-pip install .
-```
-  
-O `mtcli` reconhecerá o plugin automaticamente.
-  
----
-  
-## Contato
-  
-Autor: *Valmir França da Silva*  
-  
-Email: vfranca3@gmail.com  
-  
-GitHub: [@vfranca](https://github.com/vfranca)
-  
----
-  
-## Licença
-  
-Distribuído sob a licença MIT. Veja `LICENSE` para mais informações.
+# 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*:
+  
+```bash
+pip install mtcli
+```
+  
+Ou diretamente a partir do código-fonte:
+  
+```bash
+git clone https://github.com/vfranca/mtcli.git
+cd mtcli
+pip install .
+```
+  
+---
+  
+## Como usar
+  
+Após a instalação, o comando principal é:
+  
+```bash
+mt
+```
+  
+Você verá uma lista de comandos e plugins disponíveis.
+  
+Para executar um plugin específico, use:
+  
+```bash
+mt nome-do-plugin [opções]
+```
+  
+Exemplo com o plugin de média móvel:
+  
+```bash
+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
+  
+```bash
+git clone https://github.com/vfranca/mtcli.git
+cd mtcli
+```
+  
+Instalar dependências para desenvolvimento
+  
+```bash
+pip install -e ".[dev]"
+```
+Rodar os testes
+  
+```bash
+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
+  
+```toml
+pyproject.toml
+[project.entry-points."mtcli.plugins"]
+nome_do_plugin = "modulo.caminho:funcao_principal"
+```
+  
+Exemplo
+  
+```toml
+[project.entry-points."mtcli.plugins"]
+volume_medio = "mtcli.plugins.volume_medio:vm"
+```
+  
+No código Python:
+  
+```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:
+  
+```bash
+pip install .
+```
+  
+O `mtcli` reconhecerá o plugin automaticamente.
+  
+---
+  
+## Contato
+  
+Autor: *Valmir França da Silva*  
+  
+Email: vfranca3@gmail.com  
+  
+GitHub: [@vfranca](https://github.com/vfranca)
+  
+---
+  
+## Licença
+  
+Distribuído sob a licença GPL-3.0. Veja `LICENSE` para mais informações.

{mtcli-3.5.0.dev0 → mtcli-4.0.0.dev0}/mtcli/commands/bars.py

@@ -1,147 +1,153 @@
-"""Exibe o gráfico de barras."""
-
-import click
-
-from mtcli.conf import (
-    BARS,
-    DATE,
-    PERIOD,
-    TIMEFRAMES,
-    VIEW,
-    VOLUME,
-)
-from mtcli.models.bars_model import BarsModel
-from mtcli.models.rates_model import RatesModel
-from mtcli.views.close_view import CloseView
-from mtcli.views.full_view import FullView
-from mtcli.views.high_view import HighView
-from mtcli.views.low_view import LowView
-from mtcli.views.min_view import MinView
-from mtcli.views.open_view import OpenView
-from mtcli.views.ranges_view import RangesView
-from mtcli.views.rates_view import RatesView
-from mtcli.views.vars_view import VarsView
-from mtcli.views.volumes_view import VolumesView
-
-
-@click.command(
-    "bars",
-    help="Mostra o gráfico de candles em texto para o ativo e período especificados.",
-)
-@click.argument("symbol")
-@click.option(
-    "--view",
-    "-v",
-    type=click.Choice(
-        [
-            "ch",
-            "m",
-            "hl",
-            "f",
-            "full",
-            "r",
-            "range",
-            "v",
-            "volume",
-            "va",
-            "percentual",
-            "oh",
-            "ohlc",
-            "o",
-            "open",
-            "h",
-            "high",
-            "l",
-            "low",
-            "c",
-            "close",
-        ],
-        case_sensitive=False,
-    ),
-    default=VIEW,
-    show_default=True,
-    help="Formato de exibicao. Opcoes: minima ou HL - minima; f - completa; r - ranges; v - volumes; va - variações percentuais; oh - OHLC; o - aberturas; h - maximas; l - minimas; c - fechamentos.",
-)
-@click.option(
-    "--period",
-    "-p",
-    type=click.Choice(TIMEFRAMES, case_sensitive=False),
-    default=PERIOD,
-    show_default=True,
-    help="Timeframe das barras.",
-)
-@click.option(
-    "--count",
-    "-c",
-    type=int,
-    default=BARS,
-    show_default=True,
-    help="Numero de barras.",
-)
-@click.option(
-    "--date",
-    "-d",
-    default=DATE,
-    show_default=True,
-    help="Data para intraday, formato AAAA-MM-DD.",
-)
-@click.option(
-    "--numerator",
-    "-n",
-    is_flag=True,
-    default=False,
-    show_default=True,
-    help="Ativa a numeracao das barras.",
-)
-@click.option(
-    "--show-date",
-    "-sd",
-    is_flag=True,
-    default=False,
-    show_default=True,
-    help="Ativa a datacao das barras.",
-)
-@click.option(
-    "--volume",
-    "-vo",
-    type=click.Choice(["tick", "real"], case_sensitive=False),
-    default=VOLUME,
-    show_default=True,
-    help="Tipo de volume.",
-)
-def bars(symbol, view, period, count, date, numerator, show_date, volume):
-    """Exibe o grafico do MetaTrader 5."""
-    period = period.lower()
-    view = view.lower()
-    rates = RatesModel(symbol, period, count).get_data()
-    bars = BarsModel(rates, date).get_bars()
-    views = []
-    if view in ["m", "ch", "hl"]:  # máximas e mínimas
-        views = MinView(bars, count, period, date, numerator, show_date).views()
-    elif view in ["r", "range"]:  # ranges
-        views = RangesView(bars, count, period, date, numerator, show_date).views()
-    elif view in ["oh", "ohlc"]:  # OHLC
-        views = RatesView(bars, count, period, date, numerator, show_date).views()
-    elif view in ["va", "percentual"]:  # variações percentuais
-        views = VarsView(bars, count, period, date, numerator, show_date).views()
-    elif view in ["o", "open"]:  # abertura
-        views = OpenView(bars, count, period, date, numerator, show_date).views()
-    elif view in ["h", "high"]:  # máximas
-        views = HighView(bars, count, period, date, numerator, show_date).views()
-    elif view in ["l", "low"]:  # mínimas
-        views = LowView(bars, count, period, date, numerator, show_date).views()
-    elif view in ["c", "close"]:  # fechamentos
-        views = CloseView(bars, count, period, date, numerator, show_date).views()
-    elif view in ["v", "volume"]:  # volumes
-        views = VolumesView(
-            bars, count, period, date, numerator, show_date, volume
-        ).views()
-    else:  # completo
-        views = FullView(bars, count, period, date, numerator, show_date).views()
-    if views:
-        for view in views:
-            click.echo(view)
-
-
-if __name__ == "__main__":
-    bars()
+"""Exibe o gráfico de barras."""
+
+import click
+
+from mtcli.conf import (
+    DATE,
+    PERIOD,
+    PERIODOS,
+    SYMBOL,
+    TIMEFRAMES,
+    VIEW,
+    VOLUME,
+)
+from mtcli.models.bars_model import BarsModel
+from mtcli.models.rates_model import RatesModel
+from mtcli.views.close_view import CloseView
+from mtcli.views.full_view import FullView
+from mtcli.views.high_view import HighView
+from mtcli.views.low_view import LowView
+from mtcli.views.min_view import MinView
+from mtcli.views.open_view import OpenView
+from mtcli.views.ranges_view import RangesView
+from mtcli.views.rates_view import RatesView
+from mtcli.views.vars_view import VarsView
+from mtcli.views.volumes_view import VolumesView
+
+
+@click.command(
+    help="Mostra o gráfico de candles em texto para o ativo e período especificados.",
+)
+@click.option(
+    "--symbol",
+    "-s",
+    default=SYMBOL,
+    show_default=True,
+    help="Codigo ou ticker do ativo.",
+)
+@click.option(
+    "--view",
+    "-v",
+    type=click.Choice(
+        [
+            "ch",
+            "m",
+            "hl",
+            "f",
+            "full",
+            "r",
+            "range",
+            "v",
+            "volume",
+            "va",
+            "percentual",
+            "oh",
+            "ohlc",
+            "o",
+            "open",
+            "h",
+            "high",
+            "l",
+            "low",
+            "c",
+            "close",
+        ],
+        case_sensitive=False,
+    ),
+    default=VIEW,
+    show_default=True,
+    help="Formato de exibicao. Opcoes: minima ou HL - minima; f - completa; r - ranges; v - volumes; va - variações percentuais; oh - OHLC; o - aberturas; h - maximas; l - minimas; c - fechamentos.",
+)
+@click.option(
+    "--period",
+    "-p",
+    type=click.Choice(TIMEFRAMES, case_sensitive=False),
+    default=PERIOD,
+    show_default=True,
+    help="Timeframe do grafico.",
+)
+@click.option(
+    "--count",
+    "-c",
+    type=int,
+    default=PERIODOS,
+    show_default=True,
+    help="Quantidade de periodos a serem exibidos.",
+)
+@click.option(
+    "--date",
+    "-d",
+    default=DATE,
+    show_default=True,
+    help="Data para intraday, formato AAAA-MM-DD.",
+)
+@click.option(
+    "--numerator",
+    "-n",
+    is_flag=True,
+    default=False,
+    show_default=True,
+    help="Ativa a numeracao das barras.",
+)
+@click.option(
+    "--show-date",
+    "-sd",
+    is_flag=True,
+    default=False,
+    show_default=True,
+    help="Ativa a datacao das barras.",
+)
+@click.option(
+    "--volume",
+    "-vo",
+    type=click.Choice(["tick", "real"], case_sensitive=False),
+    default=VOLUME,
+    show_default=True,
+    help="Tipo de volume.",
+)
+def bars(symbol, view, period, count, date, numerator, show_date, volume):
+    """Exibe o grafico do MetaTrader 5."""
+    period = period.lower()
+    view = view.lower()
+    rates = RatesModel(symbol, period, count).get_data()
+    bars = BarsModel(rates, date).get_bars()
+    views = []
+    if view in ["m", "ch", "hl"]:  # máximas e mínimas
+        views = MinView(bars, count, period, date, numerator, show_date).views()
+    elif view in ["r", "range"]:  # ranges
+        views = RangesView(bars, count, period, date, numerator, show_date).views()
+    elif view in ["oh", "ohlc"]:  # OHLC
+        views = RatesView(bars, count, period, date, numerator, show_date).views()
+    elif view in ["va", "percentual"]:  # variações percentuais
+        views = VarsView(bars, count, period, date, numerator, show_date).views()
+    elif view in ["o", "open"]:  # abertura
+        views = OpenView(bars, count, period, date, numerator, show_date).views()
+    elif view in ["h", "high"]:  # máximas
+        views = HighView(bars, count, period, date, numerator, show_date).views()
+    elif view in ["l", "low"]:  # mínimas
+        views = LowView(bars, count, period, date, numerator, show_date).views()
+    elif view in ["c", "close"]:  # fechamentos
+        views = CloseView(bars, count, period, date, numerator, show_date).views()
+    elif view in ["v", "volume"]:  # volumes
+        views = VolumesView(
+            bars, count, period, date, numerator, show_date, volume
+        ).views()
+    else:  # completo
+        views = FullView(bars, count, period, date, numerator, show_date).views()
+    if views:
+        for view in views:
+            click.echo(view)
+
+
+if __name__ == "__main__":
+    bars()