Skip to content

Instalação Desenvolvedores

Jump to bottom
Rossi-Luciano edited this page Jun 29, 2026 · 1 revision

Instalação para Desenvolvedores

Esta modalidade de instalação é indicada para quem deseja contribuir com o projeto, inspecionar o código-fonte, executar os testes ou utilizar uma versão ainda não publicada como binário.

Pré-requisitos

  • Python 3.11 ou superior — verifique a versão instalada com python --version ou python3 --version
  • Git — para clonar o repositório
  • Conexão com a internet para baixar as dependências via pip

No Linux, pode ser necessário instalar também o WebKitGTK (necessário para o modo desktop):

# Ubuntu / Debian
sudo apt install libwebkit2gtk-4.0

# Fedora
sudo dnf install webkit2gtk4.0

Passo a passo

1. Clonar o repositório

git clone https://github.com/scieloorg/spsvalidator.git
cd spsvalidator/spsvalidator

2. Criar e ativar o ambiente virtual

Recomenda-se sempre usar um ambiente virtual para isolar as dependências do projeto:

python -m venv .venv

Ativar o ambiente:

# Linux / macOS
source .venv/bin/activate

# Windows (Prompt de Comando)
.venv\Scripts\activate.bat

# Windows (PowerShell)
.venv\Scripts\Activate.ps1

O prefixo (.venv) no terminal confirma que o ambiente está ativo.

3. Instalar as dependências

pip install -e ".[dev]"

O flag -e instala o projeto em modo editável — alterações no código-fonte têm efeito imediato, sem necessidade de reinstalar. O grupo [dev] inclui ferramentas de teste e desenvolvimento.

4. Executar o aplicativo

Com o ambiente virtual ativo:

spsvalidator

Para usar no navegador ao invés da janela desktop:

spsvalidator --browser

Como verificar que a instalação funcionou

A instalação está correta se todos os passos abaixo forem bem-sucedidos:

1. Verificar o comando disponível:

spsvalidator --help

Deve exibir as opções de linha de comando sem erros.

2. Executar a suíte de testes:

pytest

Todos os testes devem passar (ou apresentar apenas falhas conhecidas relacionadas a fixtures ausentes — não relacionadas à instalação em si).

3. Abrir a aplicação:

Execute spsvalidator e verifique se:

  • A janela abre sem mensagens de erro
  • A tela principal exibe o formulário "Validar pacote SPS" com o botão de upload
  • A tabela "Pacotes validados" aparece abaixo do formulário (inicialmente vazia)

Mantendo o ambiente atualizado

Ao atualizar o repositório com git pull, caso novas dependências tenham sido adicionadas, reinstale:

pip install -e ".[dev]"

Próximo passo: Como executar

Clone this wiki locally