python-code-style

개요

python-code-style이란?

python-code-style은 개발자와 팀이 일관된 Python 코드 스타일을 적용하도록 돕는 스킬로, 린팅, 포맷팅, 명명 규칙, 문서화 기준을 포함합니다. 최신 Python 도구와 모범 사례를 통합하여 코드베이스를 더 유지보수하기 쉽고 협업에 적합하게 만듭니다.

누가 사용해야 하나요?

이 스킬은 다음과 같은 분들에게 적합합니다:

• 새 프로젝트에 린팅과 포맷팅을 설정하려는 Python 개발자
• 코드 스타일 일관성을 검토하는 코드 리뷰어
• ruff, mypy, pyright 같은 도구를 구성하려는 팀
• 팀 코딩 표준을 확립하려는 경우
• 명확한 docstring 작성 및 유지 관리
• 프로젝트 문서화를 만들고 적용하려는 경우

해결하는 문제

python-code-style은 Python 개발에서 흔히 겪는 문제를 해결합니다:

• 스타일 적용을 자동화해 수동 포맷팅 논쟁 감소
• PEP 8 명명 규칙 준수 보장
• 코드와 함께 문서 유지
• 공개 API에 타입 주석 권장

사용 방법

설치 단계

1. 다음 명령어로 스킬을 설치하세요:
   npx skills add https://github.com/wshobson/agents --skill python-code-style
2. 권장 관행과 도구 요약을 위해 SKILL.md 파일을 검토하세요.
3. 추가 정보를 위해 README.md, AGENTS.md, metadata.json 파일도 살펴보세요.

Python 도구 설정

• 최신 Python 도구 설치:

  pip install ruff mypy
  

• pyproject.toml에 프로젝트 설정 추가:

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

• ruff를 기본 린터 및 포맷터로 사용하세요. 대부분의 워크플로우에서 flake8, isort, black을 대체할 수 있습니다.

워크플로우에 맞게 조정하기

• 핵심 개념과 패턴을 이해하려면 먼저 SKILL.md 파일을 미리 보세요.
• 프로젝트 요구사항과 최소 Python 버전에 맞춰 설정을 조정하세요.
• 코드 리뷰 과정에서 타입 힌트와 docstring 유지를 통합하세요.

자주 묻는 질문

python-code-style은 무엇을 다루나요?

python-code-style은 Python 코드 스타일, 린팅, 포맷팅, 명명 규칙, 문서화 기준을 다룹니다. 고품질 Python 코드를 유지하기 위한 가이드와 도구 추천을 제공합니다.

어떤 도구를 추천하나요?

이 스킬은 린팅과 포맷팅에 ruff, 타입 검사에 mypy 사용을 권장합니다. 설정 예시는 SKILL.md에 포함되어 있습니다.

스킬 가이드를 어떻게 미리 볼 수 있나요?

파일 탭에서 SKILL.md를 열어 편집 요약을 확인하세요. 추가 참고 자료와 스크립트는 하위 폴더에 있을 수 있습니다.

python-code-style은 모든 Python 프로젝트에 적합한가요?

이 스킬은 코드 품질, 일관성, 유지보수가 중요한 프로젝트에 가장 적합합니다. 빠른 프로토타입이나 스타일 적용이 덜 중요한 스크립트에는 필요하지 않을 수 있습니다.