다음은 프로젝트를 구성하는 매우 좋은 방법을 보여주는 샘플 프로젝트입니다. https://github.com/kennethreitz/samplemod. 이 프로젝트는 "샘플" 모듈을 만드는 것입니다. 디렉토리 구조는 다음과 같습니다.
README.rst LICENSE setup.py requirements.txt sample/__init__.py sample/core.py sample/helpers.py docs/conf.py docs/index.rst tests/test_basic.py tests/test_advanced.py
README.rst 파일:모듈에 대한 간략한 설명, 설정 방법, 사용 방법 등을 설명하는 파일입니다.
라이센스: 라이센스 텍스트 및 모든 저작권 주장이 포함되어 있습니다.
setup.py: 다중 플랫폼 설치 프로그램에 대한 Python의 답변이며 파일을 만듭니다. 명령줄 설치에 익숙하다면 make &&make install이 python setup.py build &&python setup.py install로 변환됩니다. 따라서 사용자 컴퓨터에서 프로젝트를 빌드하는 데 사용됩니다.
requirements.txt: Pip 요구 사항 파일은 프로젝트에 기여하는 데 필요한 종속성을 지정해야 합니다(테스트, 빌드 및 문서 생성). 프로젝트에 개발 종속성이 없거나 setup.py를 통한 개발 환경 설정을 선호하는 경우 이 파일이 필요하지 않습니다.
문서/: 이 디렉토리에는 프로젝트에 대한 문서가 포함되어 있습니다.
테스트/: 모든 테스트는 이 디렉토리에 있어야 합니다. 처음에는 단일 테스트 파일이 있습니다. 테스트가 커지기 시작하면 모듈 디렉토리처럼 테스트를 구성할 수 있습니다.
샘플/: 이 디렉토리에는 실제 모듈 코드가 포함되어 있습니다. 모듈이 단일 파일로 구성된 경우 리포지토리의 루트에 sample.py로 직접 배치할 수 있습니다. 라이브러리가 모호한 src 또는 python 하위 디렉토리에 속하지 않습니다. 이 모듈을 패키지 내에 포함시키려면 __init__.py 파일을 포함합니다.