Comandos

Esta página reúne a referência completa de comandos utilizados na operação do coletor de dados, no desenvolvimento do projeto e na execução do website.

O pacote disponibiliza o comando principal open-journals-data e o alias simplificado ojd.

Comandos do Coletor (CLI)

Todos os comandos do coletor devem ser executados através do gerenciador uv.

1. Listar revistas configuradas

Lista todas as revistas científicas cadastradas no arquivo config/journals.json, exibindo acrônimo, plataforma (ojs ou scielo) e área temática.

uv run open-journals-data list-journals

Você também pode utilizar o alias curto:

uv run ojd list-journals

---

2. Validar arquivo de configuração

Verifica a consistência do arquivo config/journals.json, validando se todas as URLs, acrônimos e plataformas obrigatórias estão preenchidos corretamente.

uv run open-journals-data validate-config

Exemplo de retorno esperado:

OK — 24 revistas válidas

---

3. Executar a coleta de metadados (crawl)

Inicia o processo de raspagem com Scrapy e Playwright.

Coleta completa

Coleta todas as revistas cadastradas:

uv run open-journals-data crawl

Filtrar por plataforma

Executa a extração apenas para portais OJS ou apenas SciELO:

# Apenas revistas OJS
uv run open-journals-data crawl --platform ojs

# Apenas revistas SciELO
uv run open-journals-data crawl --platform scielo

Filtrar por acrônimo de revista

Executa a coleta em uma única revista cadastrada:

uv run open-journals-data crawl --acronym BRA_REV_DE_HISTORIA

Limitar a quantidade de entradas

Útil para testes rápidos de validação:

uv run open-journals-data crawl --acronym BRA_REV_DE_HISTORIA --limit 5

---

Comandos de Desenvolvimento e Qualidade

Comandos utilizados para validação local antes do envio de Pull Requests.

Testes automatizados (pytest)

Executa a suíte de testes unitários offline:

uv run pytest -m "not e2e"

Formatação e linter de código (Ruff)

Verifica e corrige a conformidade do código Python:

# Verificar conformidade
uv run ruff check . && uv run ruff format --check .

# Aplicar correções automáticas
uv run ruff check --fix . && uv run ruff format .

Verificação estática de tipos (Mypy)

Verifica a consistência de tipos no diretório src/:

uv run mypy src/

Hooks de pré-commit

Executa todos os hooks configurados em todos os arquivos:

uv run pre-commit run --all-files

---

Comandos do Website (Astro / Starlight)

Comandos executados a partir do diretório website/.

# Entrar no diretório do site
cd website

# Instalar dependências
npm install

# Iniciar servidor local de desenvolvimento
npm run dev

# Compilar o site estático para produção
npm run build

# Visualizar a versão compilada localmente
npm run preview