[python] 파이썬 패키지 배포를 위한 소스 코드 구성 방법

07 Dec 2023

python

파이썬은 많은 개발자들이 사용하는 인기있는 프로그래밍 언어입니다. 파이썬으로 작성한 코드를 다른 사람과 공유하고 재사용할 수 있도록 패키지로 배포하는 것은 매우 중요합니다. 이번 블로그 포스트에서는 파이썬 패키지 배포를 위한 소스 코드 구성 방법을 알아보겠습니다.

1. 프로젝트 디렉토리 생성

패키지로 배포할 파이썬 프로젝트를 위한 디렉토리를 생성합니다. 일반적인 구성은 다음과 같습니다.

my_package/
    my_module.py
    README.md
    setup.py

my_package: 프로젝트 디렉토리 이름입니다.
my_module.py: 실제로 배포할 모듈의 소스 코드 파일입니다.
README.md: 프로젝트에 대한 설명이 포함된 마크다운 파일입니다.
setup.py: 프로젝트에 대한 메타데이터 및 배포 설정을 담은 스크립트 파일입니다.

이외에도 필요한 추가 파일이 있다면 함께 포함시킬 수 있습니다.

2. 모듈 작성

my_module.py 파일에 실제로 배포할 모듈의 소스 코드를 작성합니다. 이 모듈은 다른 파이썬 프로젝트에서 임포트하여 사용할 수 있어야 합니다. 예를 들어, 다음과 같이 작성할 수 있습니다.

def greet(name):
    print(f"Hello, {name}!")

3. README 작성

README.md 파일에 프로젝트에 대한 설명을 작성합니다. README 파일은 Markdown 형식으로 작성되며, 프로젝트의 목적, 사용법, 예제 등을 포함할 수 있습니다. 다른 사용자들이 프로젝트를 쉽게 이해하고 사용할 수 있도록 자세한 설명을 제공해야 합니다.

# My Package

My Package은 파이썬으로 작성된 사용자 지정 모듈입니다. 이 패키지를 사용하여 간편하게 인사말을 출력할 수 있습니다.

## 사용법

다음과 같이 모듈을 임포트하여 사용할 수 있습니다.

```python
from my_package.my_module import greet

greet("Alice")  # Output: Hello, Alice!

## 4. setup.py 작성

`setup.py` 파일은 프로젝트의 메타데이터 및 배포 설정을 담고 있는 스크립트 파일입니다. 다음과 같이 작성할 수 있습니다.

```python
from setuptools import setup

setup(
    name="my_package",
    version="1.0.0",
    author="Your Name",
    description="A Python package for greeting",
    packages=["my_package"],
)

name: 패키지의 이름입니다.
version: 패키지의 버전입니다.
author: 패키지의 작성자 이름입니다.
description: 패키지에 대한 간단한 설명입니다.
packages: 배포할 패키지를 나타내는 리스트입니다.

5. 패키지 빌드

터미널을 열고 프로젝트 디렉토리로 이동한 후, 다음 명령어를 실행하여 패키지를 빌드합니다.

$ python setup.py sdist

빌드된 패키지는 dist 디렉토리에 생성됩니다.

6. 패키지 배포

빌드된 패키지를 배포하기 위해서는 PyPI(Pyt