python-code-style

Visão Geral

O que é python-code-style?

python-code-style é uma skill criada para ajudar desenvolvedores e equipes a aplicarem um estilo consistente no código Python, incluindo linting, formatação, convenções de nomenclatura e padrões de documentação. Integrando ferramentas modernas e boas práticas do Python, essa skill torna as bases de código mais fáceis de manter e colaborar.

Para quem é essa skill?

Essa skill é ideal para desenvolvedores Python, revisores de código e equipes que desejam:

• Configurar linting e formatação para novos projetos
• Revisar código para garantir consistência de estilo
• Configurar ferramentas como ruff, mypy ou pyright
• Estabelecer padrões de codificação para a equipe
• Escrever e manter docstrings claras
• Criar e aplicar documentação do projeto

Problemas resolvidos

python-code-style resolve desafios comuns no desenvolvimento Python:

• Reduz debates manuais sobre formatação ao automatizar a aplicação do estilo
• Garante que o código siga as convenções de nomenclatura do PEP 8
• Mantém a documentação atualizada junto com o código
• Incentiva o uso de anotações de tipo para APIs públicas

Como Usar

Passos para Instalação

1. Instale a skill usando:
   npx skills add https://github.com/wshobson/agents --skill python-code-style
2. Consulte o arquivo SKILL.md para um resumo rápido das práticas recomendadas e ferramentas.
3. Explore arquivos complementares como README.md, AGENTS.md e metadata.json para mais contexto.

Configurando as Ferramentas Python

• Instale ferramentas modernas do Python:

  pip install ruff mypy
  

• Configure seu projeto no pyproject.toml:

  [tool.ruff]
  line-length = 120
  target-version = "py312"
  
  [tool.mypy]
  strict = true
  

• Use o ruff como seu linter e formatador principal. Ele pode substituir flake8, isort e black na maioria dos fluxos de trabalho.

Adaptando ao Seu Fluxo de Trabalho

• Leia primeiro o arquivo SKILL.md para entender os conceitos e padrões principais.
• Ajuste as configurações conforme as necessidades do seu projeto e a versão mínima do Python.
• Integre anotações de tipo e mantenha docstrings como parte do processo de revisão de código.

Perguntas Frequentes

O que o python-code-style cobre?

python-code-style cobre estilo de código Python, linting, formatação, convenções de nomenclatura e padrões de documentação. Oferece orientações e recomendações de ferramentas para manter código Python de alta qualidade.

Quais ferramentas são recomendadas?

A skill recomenda usar ruff para linting e formatação, e mypy para checagem de tipos. Exemplos de configuração estão disponíveis no SKILL.md.

Como posso visualizar as orientações da skill?

Abra a aba Arquivos e comece pelo SKILL.md para um resumo editorial. Referências adicionais e scripts podem estar em pastas aninhadas.

O python-code-style é adequado para todos os projetos Python?

Essa skill é mais indicada para projetos onde qualidade, consistência e manutenção do código são prioridades. Pode não ser necessária para protótipos rápidos ou scripts onde a aplicação rigorosa de estilo é menos importante.