이 심화 튜토리얼은 튜토리얼 7장의 완료 지점에서 시작합니다. 이제 우리의 Web-poll을 새 프로젝트에서 재사용하거나 다른 사람들과 공유할 수 있는 독립적인 파이썬 패키지로 만들 것입니다.
\n아직 튜토리얼 1~7장을 완료하지 않았다면, 읽어보고 당신의 예제 프로젝트를 아래에 설명하는 것과 일치시킬 것을 권장합니다.
\n웹 어플리케이션을 설계, 빌드, 테스트, 유지하는 것은 꽤나 큰 일입니다. 수많은 Python과 Django 프로젝트들에는 공통적인 문제가 있습니다. 만약 우리가 이러한 반복적인 작업들 중에서 몇몇을 구해낼 수 있다면 정말 멋지지 않을까요?
\nReusability is the way of life in Python. The Python Package Index (PyPI) has a vast range of packages you can use in your own\nPython programs. Check out Django Packages for\nexisting reusable apps you could incorporate in your project. Django itself is\nalso a normal Python package. This means that you can take existing Python\npackages or Django apps and compose them into your own web project. You only\nneed to write the parts that make your project unique.
\n이제 우리가 작업했던 것과 같은 설문조사 앱이 필요하여 새로운 프로젝트를 시작했다고 가정해봅시다. 어떻게 이 앱을 재사용할 수 있게 만들 수 있을까요? 운 좋게도, 여러분은 이미 방법을 알고 있습니다. 튜토리얼 1장 에서, 우리는 include 를 이용하여 프로젝트 수준의 URLconf에서 설문조사를 분리하는 방법을 배웠습니다. 이 튜토리얼에서는, 새로운 프로젝트에서 사용하기 쉬운 앱을 만들고 이 앱을 설치하고 사용할 다른 사람들을 위해 게시할 준비를 하기 위한 추가적인 작업을 진행할 것입니다.
이전 프로젝트를 마치면, 프로젝트는 아래와 같을 것입니다:
\nmysite/\n manage.py\n mysite/\n __init__.py\n settings.py\n urls.py\n asgi.py\n wsgi.py\n polls/\n __init__.py\n admin.py\n apps.py\n migrations/\n __init__.py\n 0001_initial.py\n models.py\n static/\n polls/\n images/\n background.gif\n style.css\n templates/\n polls/\n detail.html\n index.html\n results.html\n tests.py\n urls.py\n views.py\n templates/\n admin/\n base_site.html\n여러분은 튜토리얼 7 에서 mysite/templates 나 Tutorial 3 에서 polls/templates 를 생성하였습니다. 이제 프로젝트와 어플리케이션으로 분리한 이유가 명확합니다. polls 어플리케이션의 부분들은 polls에 모두 있습니다. It makes the application self-contained and easier to drop into a new project.
polls 디렉토리가 이제 새 Django 프로젝트로 복사되었고, 바로 재사용할 수 있습니다. 그래도 게시 할 준비가 되지 않았습니다. 이를 위해, 다른 사람들이 쉽게 설치할 수 있도록 앱을 패키지화해야합니다.
파이썬 패키징의 현재상태는 다양한 도구들로 인해 약간 혼란스럽습니다. 이 튜토리얼에서, 우리의 패키지를 빌드하는데 setuptools 를 사용할 것입니다. 권장 패키징 도구(distribute 포크와 병합된)입니다. 설치하고 재설치하는데 pip 를 사용할 수도 있습니다. 이제 이 두 패키지들을 설치해야합니다. 도움이 필요하면 pip로 Django 설치하는 법 을 참조할 수 있습니다. 같은 방법으로 setuptools 도 설치할 수 있습니다.
파이썬 패키징 은 쉽게 설치하고 사용할 수 있는 특별한 형식으로 앱을 준비하는 것을 의미합니다. 장고 자체도 이와 같이 패키지화되어 있습니다. 설문조사처럼 작은 앱은 이 과정이 어렵지 않습니다.
\n먼저, Django 프로젝트 외부에 polls 의 상위 디렉토리를 만듭니다. 이 디렉토리를 django-polls라 부르겠습니다.
django-polls 디렉토리의 polls 디렉토리로 이동하세요.
다음과 같은 내용으로 django-polls/README.rst를 생성합니다:
=====\nPolls\n=====\n\nPolls is a Django app to conduct Web-based polls. For each question,\nvisitors can choose between a fixed number of answers.\n\nDetailed documentation is in the "docs" directory.\n\nQuick start\n-----------\n\n1. Add "polls" to your INSTALLED_APPS setting like this::\n\n INSTALLED_APPS = [\n ...\n 'polls',\n ]\n\n2. Include the polls URLconf in your project urls.py like this::\n\n path('polls/', include('polls.urls')),\n\n3. Run ``python manage.py migrate`` to create the polls models.\n\n4. Start the development server and visit http://127.0.0.1:8000/admin/\n to create a poll (you'll need the Admin app enabled).\n\n5. Visit http://127.0.0.1:8000/polls/ to participate in the poll.\ndjango-polls/LICENSE 파일을 생성합니다. 라이선스 선택은 이 튜토리얼의 범위를 벗어나므로, 라이선스 없이 공개된 코드는 쓸모없음 을 의미한다는 것만 말해두겠습니다. Django와 많은 Django 호환 앱들이 BSD 라이센스로 배포되고 있습니다; 그러나 자신의 라이센스를 자유롭게 선택할 수 있습니다. 라이선스 선택이 누군가 여러분의 코드를 사용하는데 영향이 미칠수 있다는 사실은 알고 있어야합니다.
Next we’ll create setup.cfg and setup.py files which detail how to\nbuild and install the app. A full explanation of these files is beyond the\nscope of this tutorial, but the setuptools documentation has a good explanation.\nCreate the files django-polls/setup.cfg and django-polls/setup.py\nwith the following contents:
[metadata]\nname = django-polls\nversion = 0.1\ndescription = A Django app to conduct Web-based polls.\nlong_description = file: README.rst\nurl = https://www.example.com/\nauthor = Your Name\nauthor_email = yourname@example.com\nlicense = BSD-3-Clause # Example license\nclassifiers =\n Environment :: Web Environment\n Framework :: Django\n Framework :: Django :: X.Y # Replace "X.Y" as appropriate\n Intended Audience :: Developers\n License :: OSI Approved :: BSD License\n Operating System :: OS Independent\n Programming Language :: Python\n Programming Language :: Python :: 3\n Programming Language :: Python :: 3 :: Only\n Programming Language :: Python :: 3.6\n Programming Language :: Python :: 3.7\n Programming Language :: Python :: 3.8\n Topic :: Internet :: WWW/HTTP\n Topic :: Internet :: WWW/HTTP :: Dynamic Content\n\n[options]\ninclude_package_data = true\npackages = find:\nfrom setuptools import setup\n\nsetup()\n기본적으로 파이썬 모듈들과 패키지들만 패키지에 포함되어 있습니다. 추가 파일을 포함 시키기위해선 MANIFEST.in 파일을 만들어야합니다. 이전 단계에서 나온 setuptools 문서에 이 파일에 대해 자세한 설명이 있습니다. 템플릿들, README.rst , 우리의 LICENSE 파일을 포함 시키려면, 다음 내용으로 django-polls/MANIFEST.in 파일을 만듭니다.
include LICENSE\ninclude README.rst\nrecursive-include polls/static *\nrecursive-include polls/templates *\n선택사항입니다만, 자세한 문서를 포함시키는 것을 추천합니다. 장래의 문서들을 위해 django-polls/docs 라는 빈 디렉토리를 생성합니다. django-polls/MANIFEST.in 에 다음 한줄을 추가합니다:
recursive-include docs *\n파일을 추가하지 않으면 docs 디렉토리는 패키지에 포함되지 않을 것입니다. 많은 Django 앱들이 readthedocs.org 같은 사이트들을 통해 온라인 문서를 제공합니다.
python setup.py sdist 로 패키지를 빌드해보세요 (django-polls 내에서 실행). 이 명령은 dist 디렉토리를 생성하고, 새 패키지 django-polls-0.1.tar.gz 를 빌드합니다.
패키징에 관한 더 자세한 정보는 파이썬의 `프로젝트 패키징 및 배포에 관한 튜토리얼 <https://packaging.python.org/distributing/>`_을 참조하십시오.
\n우리가 polls 디렉토리를 프로젝트 바깥으로 이동했으므로, 작동하지 않을것입니다. 우리의 새 django-polls 패키지를 설치하여 이 문제를 해결할 것입니다.
pip를 이용하여 패키지를 설치하세요(여러분은 이미 설치 하였습니다, 맞죠?):
\npython -m pip install --user django-polls/dist/django-polls-0.1.tar.gz\n운이 따라준다면, 여러분의 Django 프로젝트는 이제 잘 작동할 것입니다. 확인해보기위해 서버를 다시 실행하세요.
pip를 사용해 패키지를 삭제
\npython -m pip uninstall django-polls\n우리는 django-polls 를 패키지화하고 테스트했기에, 세계와 공유할 준비가 되었습니다. 단순한 예제가 아니면, 여러분은 이제 아래와 같은 것들을 할 수 있습니다:
친구에게 패키지를 이메일로 보내기
웹사이트에 패키지 업로드
`Python 패키지 색인 (PyPI)<https://pypi.org/>`_과 같은 공용 저장소에 패키지를 게시하십시오. `packaging.python.org <https://packaging.python.org>`_에는 앱 퍼플리싱을 위한 `좋은 튜토리얼 <https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives>`_이 있습니다.
앞에서, 우리는 설문 조사 앱을 사용자 라이브러리로 설치했습니다. 여기에는 몇 가지 단점이 있습니다:
\n사용자 라이브러리를 수정하면 시스템의 다른 파이썬 소프트웨어에 영향을 미칠 수 있습니다.
이 패키지의 여러 버전 (또는 이름이 같은 다른 버전)을 실행할 수 없습니다.
Typically, these situations only arise once you’re maintaining several Django\nprojects. When they do, the best solution is to use venv. This tool allows you to maintain multiple isolated\nPython environments, each with its own copy of the libraries and package\nnamespace.
\n