Skip to content

docs: README's PyPI install line is stale ("when published") — package is live, and uvx data-boar works today (undocumented) #1752

Description

@FabioLeitao

Achado

Verificado hoje contra o PyPI real e o pyproject.toml atual — dois pontos de doc desatualizados/faltando, não é uma feature nova a construir.

1. README.md:92 já está desatualizado

| **`pip` from PyPI** | **`pip install data-boar`** when published; until then **git clone** + **`uv sync`** — see [CONTRIBUTING.md ...

O texto trata a publicação no PyPI como futura ("when published"). Já não é — confirmado:

$ curl -s -o /dev/null -w "%{http_code}" https://pypi.org/pypi/data-boar/json
200

pyproject.toml já tem [build-system] (hatchling) e [project.scripts] completo (data-boar, data-boar-report, data-boar-xlsx, data-boar-pdf, data-boar-docx, data-boar-heatmap, data-boar-dsar, data-boar-audit), e o PyPI serve a versão 1.7.4.post12 (esperado ficar 1 release atrás do main, que já está em 1.8.0-beta).

2. uvx data-boar já funciona hoje, zero menção em doc nenhum

Rodado agora, do zero, sem nenhum setup prévio:

$ uvx data-boar --help
Downloading data-boar (2.8MiB)
Installed 84 packages in 251ms
usage: data-boar [-h] [--version] [--demo] [--config CONFIG] [--web] ...

Funciona de verdade — baixa o pacote + as 84 dependências do PyPI e executa o CLI real, sem clone, sem Docker, sem uv sync manual. Busquei em toda a base (gh api search/code?q=uvx+repo:DataBoar/data-boar, 15 arquivos) — todas as menções a uvx são sobre outras ferramentas (semgrep etc.) internas aos scripts de CI/dev; nenhuma é sobre rodar o próprio data-boar via uvx.

Achado extra, relevante pro onboarding/demo

--demo já existe no CLI publicado: "Zero-config demo: generate a synthetic filesystem corpus in a temp directory, run an initial scan, and start the dashboard on loopback... Does not require --config." Combinado com uvx, isso significa:

uvx data-boar --demo

roda uma demonstração completa e funcional — corpus sintético, scan, dashboard local — sem clonar o repo, sem Docker, sem editar nenhum arquivo. Não vi essa combinação documentada em lugar nenhum (README, docs/ops/today-mode, live-demo-sandbox).

Sugestão (documentação apenas — sem AC de código, é achado de doc)

  • Atualizar README.md:92 pra refletir que o PyPI já está publicado (tirar "when published").
  • Documentar uvx data-boar --config config.yaml como via de instalação zero-setup, ao lado das vias já existentes (Docker, git clone).
  • Documentar uvx data-boar --demo explicitamente como o caminho de menor fricção pra alguém experimentar o produto — pode valer citar isso no material de onboarding/demo já existente.

Achado por Claude Code, verificado empiricamente (não é leitura de código só — rodei o comando de verdade).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions