Scaffold Templates¶

A CLI aptdata scaffold gera um esqueleto de projeto a partir de templates pré-configurados (Architectural Patterns), acelerando o desenvolvimento e garantindo padronização.

aptdata scaffold <project-name> [--template TEMPLATE] [--output DIR]

Opção	Default	Descrição
`project-name`	(obrigatório)	Nome do projeto (apenas letras, números e underscores)
`--template`, `-t`	`hello-world`	Nome do template a ser gerado
`--output`, `-o`	`.`	Diretório de destino

Templates Disponíveis¶

hello-world (Default)medallionrag-ingestiondata-quality-testjob-wheeldocker-compose-app

Pipeline minimalista em Pandas. Lê um JSON, aplica uma transformação simples e salva um CSV. Ideal para testes iniciais.

aptdata scaffold meu_projeto

Arquivos Gerados:

meu_projeto/
├── data/
│   └── selecao_brasileira.json
├── main.py
└── requirements.txt

Padrão de arquitetura Data Lakehouse em três camadas: Bronze (Raw) → Silver (Clean) → Gold (Agregado).

aptdata scaffold meu_lakehouse --template medallion

flowchart LR
    Bronze["🥉 Bronze\nIngestão Raw"]
    Silver["🥈 Silver\nLimpeza + Qualidade"]
    Gold["🥇 Gold\nAgregação + Parquet"]

    Bronze --> Silver --> Gold

Pipeline de ingestão ponta-a-ponta para Retrieval-Augmented Generation (RAG).

aptdata scaffold rag_app --template rag-ingestion

flowchart LR
    Extract["1️⃣ Extract\n(Docs Brutos)"]
    Chunk["2️⃣ Chunk\n(Divisão)"]
    Embed["3️⃣ Embed\n(Vetorização)"]
    Load["4️⃣ Load\n(Vector Store)"]

    Extract --> Chunk --> Embed --> Load

Pipeline focado em governança, utilizando SchemaContract e Expectations rigorosas para barrar dados sujos (QualityValidator).

aptdata scaffold dq_suite --template data-quality-test

Template focado em portabilidade. Cria um projeto empacotável como um Python Wheel (.whl), com metadados pyproject.toml configurados para entry-points de CLI.

aptdata scaffold my_job --template job-wheel

Serviço conteinerizado pronto para orquestração. Inclui Dockerfile otimizado para Python e docker-compose.yml para infraestrutura anexada.

aptdata scaffold my_service --template docker-compose-app

Mesh CLI (Orquestração de Artefatos)¶

O subcomando aptdata mesh orquestra infraestrutura local descrita em arquivos mesh.yaml encontrados dentro do projeto.

# Lista todos os componentes mesh
aptdata mesh list [--dir DIR] [--json]

# Constrói o componente (Wheel ou Docker Image)
aptdata mesh build COMPONENT

# Executa o artefato final
aptdata mesh run COMPONENT [--dry-run]

Tipos de Componentes Suportados¶

Tipo (`type` no mesh.yaml)	Ação `build`	Ação `run`
`job-wheel`	`pip wheel .`	Invoca o entrypoint do wheel gerado
`docker-compose-app`	`docker compose build`	`docker compose up`

Saídas Machine-Readable

Todas as ações de scaffolding e mesh emitem JSON Lines estruturados (.model_dump_json()), facilitando a automação de logs CI/CD ou integração com o Servidor MCP. Falhas críticas saem em stderr com exit code 1.