Repolode
mgedmin

mgedmin/check-manifest

Python 패키지의 sdist에 버전 관리 대상 파일이 모두 포함됐는지 확인하고, 누락된 파일을 보완하도록 MANIFEST.in을 업데이트할 수 있는 CLI 도구입니다.

스타
293
포크
44
열린 이슈
29
마지막 커밋
19일 전

어떤 프로젝트인가요?

check-manifest는 Python 패키지 작성자를 위한 CLI 도구입니다. Git이나 Mercurial 등 버전 관리 시스템에서 추적하는 파일과 빌드된 소스 배포본(sdist)의 내용을 비교해 패키지에서 빠진 파일을 알려줍니다. 이를 통해 테스트, 설정 또는 데이터 파일이 Python Package Index에 업로드하는 릴리스에서 누락되는 흔한 패키징 실수를 찾아낼 수 있습니다.

update 옵션을 지정해 실행하면 다음 빌드에서 누락된 파일이 포함되도록 추천 include 규칙을 MANIFEST.in에 덧붙입니다. MANIFEST.in이 없으면 새로 만들 수도 있고, pyproject.toml, setup.cfg 또는 tox.ini의 설정을 통해 특정 파일이나 패턴을 제외할 수도 있습니다.

셸에서 직접 실행하거나 pre-commit hook으로 사용할 수 있어 커밋 전에 자동으로 검사할 수 있습니다. 명령줄 플래그와 pyproject.toml의 [tool.check-manifest] 섹션, 또는 setup.cfg나 tox.ini의 [check-manifest] 섹션에서 설정합니다.

핵심 기능

  • 01버전 관리 대상 파일과 빌드된 sdist를 비교해 누락된 파일을 나열합니다.
  • 02추천 include 규칙을 MANIFEST.in에 자동으로 덧붙일 수 있습니다.
  • 03MANIFEST.in이 없으면 새로 만듭니다.
  • 04pyproject.toml, setup.cfg 또는 tox.ini를 통해 파일이나 패턴을 제외할 수 있습니다.
  • 05pre-commit hook으로 사용할 수 있습니다.

활용 사례

  • PyPI에 업로드하는 Python 패키지에 모든 테스트 및 데이터 파일이 포함됐는지 확인합니다.
  • pre-commit을 통해 git 커밋 전에 패키징 검사를 자동으로 실행합니다.
  • 프로젝트 구조를 변경한 뒤 불완전한 MANIFEST.in을 수정합니다.

빠른 시작

  1. 1

    PyPI에서 check-manifest를 설치합니다

    pip install check-manifest
  2. 2

    Python 패키지의 소스 디렉터리로 이동합니다

    cd ~/src/mygreatpackage
  3. 3

    check-manifest를 실행해 버전 관리 중인 파일과 sdist를 비교합니다

    check-manifest

토픽

자주 묻는 질문

check-manifest은(는) 무엇인가요?
Python 패키지의 sdist에 버전 관리 대상 파일이 모두 포함됐는지 확인하고, 누락된 파일을 보완하도록 MANIFEST.in을 업데이트할 수 있는 CLI 도구입니다. check-manifest는 Python 패키지 작성자를 위한 CLI 도구입니다. Git이나 Mercurial 등 버전 관리 시스템에서 추적하는 파일과 빌드된 소스 배포본(sdist)의 내용을 비교해 패키지에서 빠진 파일을 알려줍니다. 이를 통해 테스트, 설정 또는 데이터 파일이 Python Package Index에 업로드하는 릴리스에서 누락되는 흔한 패키징 실수를 찾아낼 수 있습니다.
check-manifest은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
check-manifest은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
check-manifest은(는) 아직 유지보수되고 있나요?
활발히 유지보수 중. check-manifest의 마지막 커밋은 2026년 10월 18일입니다.
check-manifest은(는) 어디에 사용할 수 있나요?
PyPI에 업로드하는 Python 패키지에 모든 테스트 및 데이터 파일이 포함됐는지 확인합니다. pre-commit을 통해 git 커밋 전에 패키징 검사를 자동으로 실행합니다. 프로젝트 구조를 변경한 뒤 불완전한 MANIFEST.in을 수정합니다.
check-manifest는 어떻게 설치하나요?
PyPI에서 check-manifest를 설치합니다: pip install check-manifest Python 패키지의 소스 디렉터리로 이동합니다: cd ~/src/mygreatpackage check-manifest를 실행해 버전 관리 중인 파일과 sdist를 비교합니다: check-manifest
check-manifest은(는) 어디서 받을 수 있나요?
소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/mgedmin/check-manifest

요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.

관련 프로젝트