MeasureSoftGram-CLI

Badges

Este README resume o componente CLI. A documentação completa do produto — incluindo o uso detalhado da CLI, as políticas de contribuição e o código de conduta — é central e vive no MeasureSoftGram Docs.

O que é

O MeasureSoftGram-CLI (pacote msgram) é a interface de linha de comando do MeasureSoftGram. É o módulo responsável por configurar o modelo de qualidade, extrair métricas de exports do SonarQube/SonarCloud e do GitHub, e calcular localmente os valores das medidas, subcaracterísticas e características do modelo algébrico.

Como Executar o Projeto

Requisitos: Python 3.9 ou superior (o CI de testes e lint roda em 3.10).

1. Criar e ativar o ambiente virtual

python3 -m venv .venv
source .venv/bin/activate

2. Instalar as dependências

make install

(Equivale a pip install -r requirements.txt, que instala o próprio pacote em modo editável — o comando msgram fica disponível no terminal).

3. Verificar a instalação

msgram -h

4. Ver a CLI funcionando (demo)

Para executar o fluxo completo (init, extract e calculate) sobre o dataset de exemplo embutido em examples/analytics-raw-data/, sem precisar fornecer dados próprios nem acesso à rede:

msgram demo

O resultado é gerado em ./msgram-demo/.

Principais Comandos

Comandos da CLI

Alvos do Makefile

📖 Flags, valores padrão e o fluxo típico de uso de cada subcomando estão na Referência da CLI.

Como Rodar os Testes

# Testes + lint via tox
make test

# Apenas os linters
make lint

Para rodar um arquivo de teste específico com o pytest:

pip install pytest pytest-cov pytest-mock
pytest tests/unit/test_calculate.py

Documentação

A documentação oficial e completa é central: MeasureSoftGram Docs. Este repositório guarda apenas o código do componente e um resumo. As páginas mais relevantes para esta CLI:

• Primeiros passos — tutorial da instalação até o primeiro relatório de qualidade
• Referência da CLI — subcomandos, flags, valores padrão e fluxo típico
• Como usar — uso da CLI, como subir o sistema completo e problemas comuns
• Componente CLI — pré-requisitos, setup a partir do código-fonte, testes e publicação no PyPI
• Como contribuir — fluxo de issue/branch/PR, padrão de commits e Definition of Done

Informações Adicionais

• PyPI: msgram
• Docker Hub: Core · Service
• Documentação: MeasureSoftGram Docs
• Guia de Contribuição: Veja nosso Guia de Contribuição e o arquivo CONTRIBUTING.md.
• Demais repositórios do produto:
  • Core
  • Service
  • Front Web
  • Action
  • Parser
  • Docs

Contribuição

As políticas de contribuição são as mesmas para todos os repositórios do produto e estão em Guia de Contribuição e Padrões. Consulte também o CONTRIBUTING.md deste repositório.

Código de Conduta

Este projeto segue o Código de Conduta do MeasureSoftGram, único para todos os repositórios. Veja também o code_of_conduct.md.

Licença

Este projeto é distribuído sob a licença AGPL-3.0.