Create Django Package 3 - Tirrilee/TechTalk GitHub Wiki

패키징

• https://code.tutsplus.com/ko/tutorials/how-to-share-your-python-packages--cms-26114 다른 패키지 처럼 본인이 생성한 가상환경 폴더 하위에 있는 /lib 폴더에 패키지를 추가하기 위해서 setup.py를 만들어야 한다.

setup.py에는 이름, 버전, 설명, 필요한 패키지와 같은 패키지에 정보가 들어가게 된다.

• setup 옵션 확인

import os
from setuptools import setup

here = os.path.abspath(os.path.dirname(__file__))
README = open(os.path.join(here, 'README.md')).read()

setup(
    name='Tirrilee-Contact-Form',
    version='0.1',
    packages=['Tirrilee_Contact_Form/templates','Tirrilee_Contact_Form/templatetags', 'Tirrilee_Contact_Form'],
    description='Contact Form Package From Tirrilee',
    long_description=README,
    author='Aiden',
    author_email='[email protected]',
    url='https://github.com/Tirrilee/Django-Packages/Contact-Form/',
    license='MIT',
    include_package_data=True, # html 파일
    install_requires=[
        'Django>=2.0',
    ]
)

• name : pip install 할 때 사용되어지는 이름
• version : 해당 패키지의 버전
• packages : 패키지를 위해 생성한 앱의 이름
• description : 패키지에 대한 간단 설명
• long_description : README 파일로부터 읽어온 상세 설명
• author : 패키지 제작자
• author_email : 패키지 제작자 메일
• url : 깃헙 주소
• license : 라이센스 (MIT)
• install_requires : 사용 가능한 Django 버전

setup.py 파일을 만들고나면, 배포할 파일을 지정하는 MANIFEST.in 파일을 생성한다.

include *.txt *.ini *.cfg *.md
include Tirrilee_Contact_Form/templates/tirrilee_contact_form/*.*
recursive-include myapp *.ico *.png *.css *.gif *.jpg *.txt *.js *.html *.xml

설정이 완료되면, 아래 패키지들을 설치한다.

$ pip install setuptools wheel

setup.py 파일이 있는 경로에서 아래와 같이 입력해 패키징을 진행한다.

$ python3 setup.py sdist # bdist_wheel

패키징이 종료되면 dist 폴더에 아래와 같이 2개의 파일이 생성된 것을 확인 할 수 있다.

dist
├──  Tirrilee-Contact-Form-0.1-py3-none-any.whl
└──  Tirrilee-Contact-Form-0.1.tar.gz   

등록

이제 패키지를 PyPI사이트에 등록을 할 것 이다. PyPI는 상용사이트와 테스트사이트로 나눠지며, 우선 테스트 사이트에 패키지를 업로드하고 테스트 해보도록하자.

$ pip install twine

twine은 패키지 업로드를 도와주는 라이브러리이다.

$ twine upload --repository-url https://test.pypi.org/legacy/ dist/*

실제 배포 : twine upload --repository-url https://upload.pypi.org/legacy/ dist/* http 400 오류시 : twine upload --skip-existing --repository-url https://upload.pypi.org/legacy/ dist/*

위와 같이 업로드를 하고, 테스트 사이트에 들어가면 패키지가 등록된 것을 확인 할 수 있다.