파이썬 패키지 배포(pip) 과정 정리

파이썬 패키지를 배포하는 것은 단순히 코드를 공유하는 것을 넘어, 여러분의 아이디어를 세상에 선보이는 중요한 과정입니다.

최근에는 더 쉽고 안전하게 패키지를 배포할 수 있도록 다양한 도구와 방법들이 등장했습니다.

이번 글에서는 파이썬 패키지를 PyPI에 배포하는 전체 과정을 꼼꼼하게 정리하고, 발생 가능한 문제점과 해결책까지 제시하여 여러분의 성공적인 패키지 배포를 돕겠습니다.

 

PyPI 배포 전 준비 사항

 

가장 먼저 패키지를 PyPI에 배포하기 전에 몇 가지 준비해야 할 사항들이 있습니다.

패키지 이름은 PyPI에 등록되지 않은 고유한 이름이어야 하며, 패키지 설명, 라이선스, 의존성 등을 명확하게 정의해야 합니다.

`setup.py` 또는 `pyproject.toml` 파일을 통해 패키지 정보를 설정하고, 필요한 의존성 패키지들을 requirements.txt 파일에 명시하는 것이 일반적입니다.

최근에는 hatch와 같은 빌드 도구를 사용하여 패키지 빌드 과정을 자동화하는 추세입니다.

 

TestPyPI를 활용한 사전 검증

 

실제 PyPI에 배포하기 전에 TestPyPI를 이용하여 패키지가 제대로 동작하는지 확인하는 것이 중요합니다.

TestPyPI는 실제 PyPI와 동일한 환경을 제공하므로, 배포 과정에서 발생할 수 있는 문제점을 미리 발견하고 해결할 수 있습니다.

twine을 사용하여 TestPyPI에 패키지를 업로드하고, pip를 통해 설치하여 정상적으로 작동하는지 테스트합니다.

TestPyPI에서 문제가 없다면 실제 PyPI 배포를 진행해도 안전합니다.

 

twine을 이용한 패키지 업로드

 

twine은 PyPI에 패키지를 안전하게 업로드하기 위한 도구입니다.

twine을 사용하면 패키지를 업로드하는 동안 발생할 수 있는 보안 문제를 최소화할 수 있습니다.

`python setup.py sdist bdist_wheel` 명령어를 사용하여 패키지를 빌드한 후, `twine upload dist/*` 명령어를 통해 PyPI에 업로드합니다.

이때 PyPI 계정과 비밀번호를 입력해야 하며, API 토큰을 사용하여 인증하는 방법도 있습니다.

 

API 토큰 인증 및 2단계 인증 설정

 

최근에는 PyPI 계정 보안을 강화하기 위해 API 토큰 인증과 2단계 인증을 권장하고 있습니다.

API 토큰을 사용하면 계정 비밀번호를 직접 입력하지 않고도 패키지를 업로드할 수 있어 보안 위험을 줄일 수 있습니다.

Google Authenticator와 같은 앱을 사용하여 2단계 인증을 설정하면 계정 보안을 더욱 강화할 수 있습니다.

API 토큰 인증 시 발생할 수 있는 문제점을 해결하고, 2단계 인증을 설정하는 방법을 숙지하는 것이 중요합니다.

 

Github 연동 및 버전 관리

 

패키지 소스 코드를 Github에 올려 버전 관리를 하는 것은 매우 중요합니다.

Github Desktop과 같은 도구를 사용하면 로컬 저장소와 Github 저장소를 쉽게 동기화할 수 있습니다.

패키지 버전을 업데이트할 때마다 Github에 새로운 릴리스를 생성하고, PyPI에 새로운 버전을 배포하는 것이 일반적입니다.

Github Actions를 사용하여 CI/CD 환경을 구축하면 패키지 빌드, 테스트, 배포 과정을 자동화할 수 있습니다.

 

파이썬 패키지 배포는 약간의 노력이 필요하지만, 여러분의 코드를 더 많은 사람들과 공유하고 협업할 수 있는 좋은 방법입니다.

TestPyPI를 활용하여 꼼꼼하게 검증하고, twine과 API 토큰을 사용하여 안전하게 배포하며, Github를 통해 효율적으로 버전 관리를 한다면 성공적인 패키지 배포를 이룰 수 있을 것입니다.

최근에는 더 다양한 빌드 도구와 자동화 방법들이 등장하고 있으니, 꾸준히 학습하고 적용하여 여러분의 개발 워크플로우를 개선해 나가시길 바랍니다.