1. Configuration

1.1 먼저 할일

다음의 PyPI Package 웹싸이트에서 가입을 합니다.
https://pypi.org/

Requirements 를 설치 합니다.

sudo pip3 install twine wheel

1.2 setup.py

다음은 setup.py의 예제 입니다.
실제 pewsql 이라는 제가 만든 Python package의 설정입니다.

from setuptools import setup, find_packages

setup(
    name='pewsql',
    version='0.0.1',
    packages=['pewsql'],
    url='',
    license='',
    classifiers=[
        "Intended Audience :: Science/Research",
        "Intended Audience :: System Administrators",
        "Topic :: Database",
        "Topic :: Scientific/Engineering",
        "Topic :: Scientific/Engineering :: Information Analysis"
    ],
    install_requires=['pony', 'pandas', 'numpy', 'psycopg2'],
    entry_points={
        'console_scripts': ['command=package.python_file:function']
    },
    scripts=['package.python_file'],
    python_requires='>=3',
    author='anderson',
    author_email='a141890@gmail.com',
    description='Analytics Tools for RDBMS',
    keywords=['sql', 'analytics'],
)

package: 실제 package가 사용하는 디렉토리 이름과 동일해야 합니다.
url: 보통 GIT 주소
license: 개인적으로 MIT
classifiers: Classifiers 총 정리 를 참고합니다. package를 분류하는데 사용됩니다.
install_requires: Package를 사용하기 위해서 필요한 최소한의 dependencies.
entry_points.console_scripts:
- 어디에서든지 파이썬 함수를 실행할 수 있도록 도와줌
- command: 실행 명령어. 예를 들어 tycoon 이라고 적으면, 어디서든지 ‘tycoon’ 실행시 파이썬 함수가 실행
- package.python_file:function : 실행할 함수 위치
scripts: entry_points 에서 설정한 파이썬 파일을 추가하면 됨

1.3 setup.cfg

PyPI에 REAME파일이 어디 있는지 알려줍니다.

[metadata]
description-file = README.md

2. Development Mode

프로젝트의 설치 그리고 테스트를 해볼 필요가 있습니다.
다음의 명령어는 실제로 설치를 진행하며, install_requires에 있는 라이브러리들을 non-editable mode로 설치합니다.
-e (editable) 옵션은 프로젝트는 편집할 수 있도록 합니다.

sudo pip3 install -e .

3. Packaging Your Project

3.1 Source Distribution

아래의 명령어로 distribute한후, pip로 설치하면 build과정을 거치게 됩니다. (설치가 느려짐)

python3.6 setup.py sdist

3.2 Wheel

wheel로 설치시에는 sdist처럼 build과정을 거치지 않고 바로 설치가 됨으로 빠릅니다. 즉 built package.
wheel을 사용시 몇가지 옵션이 있습니다.

Mode	Description	Command
Universial Wheel	Pure Python으로 만들어졌으며, Python 2 그리고 3 모두 지원.	python setup.py bdist_wheel –universal
Pure Python Wheel	Pure Python으로 만들어졌지만, Python 2.x 또는 3.x 모두 지원하지는 않음	python setup.py bdist_wheel
Platform Wheel	Compiled extensions등을 포함시 사용 bdist_wheel 명령어는 자동으로 Pure Python Code인지 감지함	python setup.py bdist_wheel

추가적으로 –universal 명령어 대신에 setup.cfg 파일안에 다음과 같이 설정할 수 있습니다.

[bdist_wheel]
universal=1

4. Uploading Your Package to PyPI

4.1 ~/.pypirc

~/.pypirc 파일을 생생한후 다음을 설정합니다.

vi ~/.pypirc

[pypi]
username = <username>
password = <password>

파일의 소유자만 읽기, 쓰기를 할 수 있도록 다음과 같이 권한을 변경합니다.

chmod 600 ~/.pypirc

4.2 Uploading Your Distributions

twine upload dist/*

https://pypi.org 에 들어가서 확인합니다.

4.3 References

https://github.com/pypa/sampleproject 에서 예제를 볼 수 있습니다.
https://packaging.python.org/tutorials/distributing-packages/#initial-files 에서 Package 설치에 관한 공식 문서를 볼 수 있습니다.