위키득계정 ↗
기술

Check-manifest

Check-manifest기술
주요 대상
Python 소스 배포본
비교 기준
버전 관리의 파일 목록
주요 기능
파일 누락과 구성 차이 검사
설정 연계
MANIFEST.in과 프로젝트 설정
Check-manifest는 버전 관리에 포함된 파일과 Python 소스 배포본의 내용을 비교하는 도구다. 배포에 필요한 파일이 빠지는 실수를 찾고 MANIFEST.in의 포함 규칙을 작성하거나 갱신하는 작업을 도울 수 있다.

저장소와 배포본의 차이

저장소에 파일이 있다고 해서 소스 배포본에도 자동으로 들어가는 것은 아니다. Check-manifest는 버전 관리의 파일 목록과 생성한 소스 배포본을 비교해 차이를 알려준다. 개발 기계에서는 보이던 파일이 배포 과정에서 빠지는 문제를 확인하는 데 초점을 둔다.

포함 규칙 작성 지원

검사 결과에서 빠진 파일을 확인하고 MANIFEST.in에 추가할 규칙을 제안받을 수 있다. 별도 옵션으로 해당 파일을 생성하거나 제안 내용을 덧붙이는 작업도 가능하다. 검사 결과를 표시하는 동작과 패키징 설정을 실제로 변경하는 동작을 구분해 사용할 수 있다.

의도적으로 제외하는 파일

버전 관리에는 CI 설정처럼 배포하지 않을 파일도 들어갈 수 있다. 프로젝트 설정에서 제외 패턴을 지정해 이런 차이를 반영한다. 커밋 전 검사에 연결할 수도 있지만 소스 배포본의 파일 구성을 확인하는 검사와 wheel 설치 및 실행 테스트는 서로 다른 검증 단계다.

관련 문서

Check-wheel-contents / Python Build / Setuptools / Twine / Pre-commit