Reescrever o README para o usuário externo - #89
Open
maia-andre wants to merge 1 commit into
Open
Conversation
O README passa a ser escrito para quem instala o colibri para consultar os dados, e aponta para o site (gestaogovbr.github.io/colibri) para o resto. Instalação com ambiente virtual em Mac/Linux e Windows (PowerShell); URL do clone corrigida; os comandos `lake` vêm primeiro, com a explicação do caminho completo no SQL (lake.<schema>.<tabela>) contra o nome simples no download; `lake q` → `lake query`; tabelas citadas passam a ser as que existem em produção; arquitetura com o bucket padrão real (colibri-prod); referência de pipeline/bucket sai do README e vira link para os guias do site. O .segredos_template.yml ganha o perfil colibri-token-visualizador — padrão dos comandos `lake`, que não constava do template. O .gitignore passa a cobrir trains.csv (caderno-exemplo da DuckDB UI) e os .parquet que `lake download` grava na raiz. Resolve #22
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolve #22
O que muda com esse PR
O README passa a ser escrito para o usuário externo — quem instala o colibri para consultar os dados — e aponta para o site (https://gestaogovbr.github.io/colibri/) para tudo o mais. Conferi cada comando e exemplo contra o código da
maine contra o lake de produção (somente leitura).heitorgama/colibri→gestaogovbr/colibri)..segredos_template.ymlganha o perfilcolibri-token-visualizador, que é o padrão dos comandoslakee não constava do template — sem ele o usuário externo não conseguia nem começar. O README explica os dois perfis e quando cada um é necessário. Não é preciso rodarcolibri sincronizar: os comandoslakejá baixam o catálogo sozinhos.lake tables,query,download,years,ui), com a explicação pedida na issue: no SQL o caminho completolake.<schema>.<tabela>, nos outros comandos só o nome — incluindo a mensagem de erro real do DuckDB, que já sugere o nome certo. Tabela dos três schemas e das views demain_martsque existem hoje (mrt_pncp_comprasgov_*,mrt_margem__ncms_*,mrt_tradutor_*); o README antigo citavamrt_pncp_comprasgov__resumo_anualencm_prefixos, que não existem mais.colibri lake q(que não existe) →colibri lake query; exemplo de validação trocado por um que roda hoje (compras por ano de publicação). Link do painel "PNCP em Números" atualizado — o antigo em gov.br devolve 404.pipeline/bucketsai do README: fica o essencial em "Para desenvolver" com links para os guias de instalação, desenvolvedor e analista do site. Arquitetura corrigida (colibri-dev→colibri-prod, que é o padrão do código).trains.csvde 33 MB na pasta atual;trains.csve/*.parquet(saída padrão delake downloadna raiz) entram no.gitignorepara não virarem commit acidental.Como testar
Seguir o README do zero, com só o
colibri-token-visualizadorpreenchido:Links do README conferidos (todos respondem 200, inclusive a âncora do "S3 próprio" no site).
Checklist antes de mesclar na main
yamlfix .—pre-commit run --all-filespassa (yamlfix, ruff check, ruff format)pytest— 38 passam