setup.py 파일은 Python 패키지를 빌드하고 배포하기 위한 설정 파일입니다. 이 파일을 커맨드 라인 인터페이스(CLI)에서 실행하는 것은 패키지 개발 과정의 중요한 부분입니다. 여러분은 setup.py를 사용하여 패키지를 설치하거나, 개발 모드로 설치하거나, 패키지를 배포할 준비를 할 수 있습니다. 아래는 setup.py 파일을 CLI에서 사용하는 몇 가지 기본적인 방법입니다:
패키지 설치
패키지를 로컬 시스템에 직접 설치하려면, 다음 명령어를 사용합니다:
python setup.py install이 명령은 setup.py 파일이 있는 디렉토리에서 실행해야 합니다. 이 과정에서 install_requires에 명시된 의존성들도 함께 설치됩니다.
개발 모드로 설치
개발 중에는 패키지를 "개발 모드"(editable 모드)로 설치하는 것이 유용할 수 있습니다. 이 모드에서는 패키지의 코드를 변경할 때마다 재설치 없이 변경사항이 반영됩니다. 개발 모드로 설치하려면 다음 명령어를 사용합니다:
python setup.py develop또는 pip를 사용하는 방법도 있습니다:
pip install -e .- 여기서
-e옵션은--editable의 축약형이며, 현재 디렉토리(.)에 있는 패키지를 개발 모드로 설치하라는 의미입니다. - 중요! pip으로 설치하는 방법이 훨씬 권장된다.
소스 배포와 바이너리 배포 생성
패키지를 PyPI 같은 패키지 인덱스에 배포할 준비를 하려면, 먼저 배포 가능한 형태의 파일을 생성해야 합니다. 소스 배포(sdist)와 바이너리 배포(wheel)를 생성할 수 있습니다.
소스 배포 생성:
python setup.py sdist이 명령은 dist/ 디렉토리에 .tar.gz 형식의 소스 배포 파일을 생성합니다.
바이너리 배포(휠) 생성:
python setup.py bdist_wheel이 명령을 실행하기 전에 wheel 패키지를 설치해야 할 수도 있습니다(pip install wheel). 이 명령은 dist/ 디렉토리에 .whl 형식의 바이너리 배포 파일을 생성합니다.
주의사항
- Python 패키징 표준은 시간이 지남에 따라 발전하고 있으며, 최신의 패키징 및 배포 관련 작업에는
setuptools와wheel,twine과 같은 도구를 사용하는 것이 권장됩니다. - PyPI에 패키지를 배포할 때는
twine upload dist/*명령을 사용하는 것이 안전합니다. (twine은 별도로 설치해야 합니다:pip install twine)
이러한 명령들을 통해 setup.py 파일을 사용하여 패키지를 빌드하고, 설치하며, 배포 준비를 할 수 있습니다.
