[Python] Writing the Setup Script

참고 URL

https://docs.python.org/2/distutils/setupscript.html

간단하게, 흐름을 보면 아래 세 단계로 하면 된다. setup 안에 name, version, py_modules(배포할 파이썬 스크립트 (.py 확장자로된) )를 명시해주고, sdist로 배포를 하고, 설치를 하면 된다. 간단하게 파이썬 한 개의 스크립트를 배포할 땐 편한데, 패키지 형태로 하려면 py_modules 보다 packages 인자를 써주는 것이 더 효율적이다. 

from distutils.core import setup
setup(name='foo',
      version='1.0',
      py_modules=['foo'],
      )

python setup.py sdist

python setup.py install

setup()

- setup.py 는 Distutils에서 제공하는 함수 setup()을 호출하는 것이 전부이고, 인자로 각종 설정을 넘겨주면, 사용자가 명령행으로 전달하는 명령이나 옵션들에 따라 적절한 기능을 제공.

packages

- packages 에는 배포 판에 포함시킬 패키지들이 목록을 나열. 최 상위 패키지 뿐만 아니라 하위 패키지들도 모두 나열해야 함에 주의하고, 패키지에 들어있는 모듈들은 별도로 나열하지 않아도 됨. py_modules 인자를 통해 지정할 수도 있다.

Example

1. setup.py 의 구조이다. 배포할 라이브러리 이름, 버전, 배포하려는 package를 정의하는 구조로 되어있다.

[ setup.py ]

2. 폴더의 구조를 보면 아래와 같다. 배포할 패키지 폴더와 setup.py 를 두고, src 폴더 안에 들어가보면 __init__.py와 배포할 라이브러리를 놓는다.

__init__.py 안에는 버전명과 라이브러리를 import 해주는 것을 정의 해준다. 라이브러리를 정의함으로써 다른 곳에서는 해당 라이브러리에 해당하는 함수를 가져다가 쓸 수 있는 것이다. 아래를 예로 들면 suspect_def 라이브러리 안의 suspect_print 와 suspect_print2 함수를 정의해준 것을 볼 수가 있다.

[ __init__.py ] 

[ suspect_def.py ]

3. 이제 python setup.py sdist 명령으로 배포를 시작 해야한다. 단, 주의할 것은 setup.py와 패키지 폴더가 같은 경로에 있어야 한다.  

4. 배포를 시작하고 같은 경로에 manifest 파일이 생성된 것을 볼 수가 있는 editor로 열어보면 설치가 된 구조를 볼 수가 있다.

5. 배포를 완료하면 dist 폴더에 배포한 이름으로 압축파일이 있다. 사람들은 이제 이 압축파일을 가져가서 setup.py를 하여 자신이 만든 라이브러리를 사용할 수가 있다.

압축 파일을 해제하고 들어가보면 setup.py 파일이 보인다.

6. python setup.py install 명령으로 설치를 해주게 되면, 이제 자신의 컴퓨터에서 라이브러리를 가져다가 쓸 수가 있는 것이다.

7. Editor를 켜서 가져온 라이브러리를 import 시키고, 메소드를 입력해 보면 정상적으로 가져와서 쓸 수 있는 것을 확인할 수가 있다.