Skip to content

Commit c0ef1bb

Browse files
authored
Merge pull request #4 from MariaHilmar/docs/readme-portfolio-context
docs: esclarecer README como projeto de portfolio
2 parents 5b91db5 + b5e21de commit c0ef1bb

1 file changed

Lines changed: 25 additions & 5 deletions

File tree

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,30 @@
44
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
66

7-
Pipeline que coleta dados de issues e commits dos repositórios GitLab do MGI,
8-
processa tudo **em memória** (taxonomia, área funcional, tipo, enriquecimento
9-
Dev/Git, qualidade) e sincroniza direto com o Supabase, que alimenta o dashboard
10-
web `mgi-kpi-dashboard`. **O Excel não faz mais parte do fluxo.**
7+
> **Projeto de portfólio pessoal** de [Maria Hilmar](https://github.com/MariaHilmar).
8+
> O pipeline foi desenvolvido a partir da experiência com dados e fluxos do ecossistema
9+
> **MGI** (issues GitLab, commits e KPIs de contratos), mas **este repositório não é
10+
> oficial** nem representa o Ministério ou qualquer órgão público. É uma demonstração
11+
> de engenharia de dados e automação com stack Python + Supabase.
12+
13+
Pipeline que coleta dados de issues e commits de repositórios GitLab (no contexto MGI,
14+
projetos `comprasnet/*`), processa tudo **em memória** (taxonomia, área funcional,
15+
tipo, enriquecimento Dev/Git, qualidade) e sincroniza com o Supabase, que alimenta o
16+
dashboard web [`mgi-kpi-dashboard`](https://github.com/MariaHilmar/mgi-kpi-dashboard)
17+
— também projeto de portfólio. **O Excel não faz mais parte do fluxo.**
18+
19+
## Sobre este projeto
20+
21+
| | |
22+
|---|---|
23+
| **O que é** | ETL/orquestração em Python para KPIs de issues e Git, com testes e CI |
24+
| **Origem dos dados** | APIs e clones Git configuráveis via `.env` (ex.: GitLab `comprasnet/contratos_v2`) |
25+
| **O que não é** | Sistema institucional, deploy governamental ou produto mantido pelo MGI |
26+
| **Para quem** | Portfólio técnico — mostra desenho de pipeline, regras de negócio e integração com banco |
27+
28+
Para rodar localmente você precisa de **seus próprios tokens** (`GITLAB_TOKEN`,
29+
`SUPABASE_*`) e caminhos de repositório (`MGI_REPOS`). Nenhuma credencial ou dado
30+
real do ambiente original está versionado neste repo.
1131

1232
## Fluxo geral
1333

@@ -145,7 +165,7 @@ com `requests` mockado), além das funções puras de taxonomia, datas e chaves.
145165

146166
## Repositório e CI
147167

148-
**Repositório canônico:** [GitHub — MariaHilmar/mgi-kpi-pipeline](https://github.com/MariaHilmar/mgi-kpi-pipeline).
168+
**Repositório canônico (portfólio):** [GitHub — MariaHilmar/mgi-kpi-pipeline](https://github.com/MariaHilmar/mgi-kpi-pipeline).
149169
Detalhes em [docs/08-repositorio-github.md](docs/08-repositorio-github.md).
150170

151171
CI no GitHub Actions: `ruff check` + `pytest` (Python 3.11/3.12). Referência

0 commit comments

Comments
 (0)