Python Project Template 🤖

Um modelo enxuto de projeto Python pensado para desenvolvimento assistido por IA — seja com agentes, copilotos ou ferramentas como o Antigravity/Gemini.

Sobre este template

Este repositório fornece uma estrutura mínima, porém sólida, para iniciar projetos Python com boas práticas desde o primeiro commit. Ele é especialmente adequado para fluxos de trabalho em que uma IA participa ativamente do desenvolvimento, pois já vem configurado com:

• Tipagem estática — uso de type hints em todo o código para facilitar a compreensão e análise automática.
• Testes automatizados — diretório tests/ pronto para uso com pytest.
• Documentação — pasta docs/ destinada a arquivos .md que descrevem funcionalidades e decisões de projeto.
• Regras para agentes — arquivo AGENTS.md com diretrizes que orientam o comportamento de IAs ao contribuir com o projeto.
• Ambiente virtual — dependências isoladas via venv, evitando conflitos entre projetos.

Estrutura do projeto

.
├── AGENTS.md          # Regras e diretrizes para agentes de IA
├── README.md          # Este arquivo
├── pyproject.toml     # Configuração do projeto (metadados, ferramentas)
├── requirements.txt   # Dependências do projeto
├── docs/              # Documentação de funcionalidades
├── skills/            # Skills/utilitários reutilizáveis
├── src/               # Código-fonte principal
└── tests/             # Testes automatizados

Como usar

1. Clone ou crie um repositório a partir deste template

git clone <url-deste-repositorio> meu-projeto
cd meu-projeto

2. Crie e ative o ambiente virtual

python -m venv .venv
# Windows
.venv\Scripts\activate
# Linux/macOS
source .venv/bin/activate

3. Instale as dependências

pip install -r requirements.txt

4. Execute os testes

pytest tests/

Convenções

• Todo código novo deve incluir type hints.
• Novas funcionalidades devem ter testes e documentação em docs/.
• Siga as diretrizes do arquivo AGENTS.md ao trabalhar com agentes de IA.