この高度なチュートリアルは、チュートリアル その8 が終わったところから始まります。Web投票アプリケーションを、新しいプロジェクトで再利用でき、他の人に共有できる独立した Python のパッケージへと変えていきましょう。
\n最近、チュートリアル 1〜8 を完了したのではない場合は、以下に記載されている内容と一致するように、例題プロジェクトを見直すことをお勧めします。
\nWeb アプリケーションの設計、開発、テスト、そしてメンテナンスには多大な労力が必要です。そして多くの Python プロジェクト、 Django プロジェクトは共通の問題を抱えています。この繰り返し作業を減らせたら良いと思いませんか？
\n再利用可能性はPythonの生き様とも言えるものです。Python Package Index (PyPI) にはあなたの Pythonプログラムに使用できる非常に幅広いパッケージが揃っています。あなたのプロジェクトに組み込むことのできる再利用可能なアプリについては、Django Packages を見てみてください。Django そのものも、普通のPython パッケージのひとつです。あなたは既存のPythonパッケージや Django アプリを選んで、自分の Web プロジェクトに組み込むことができます。つまり、あなたは自分のプロジェクトに特有の部分にだけ取り組めば良いのです。
\n例えば、投票アプリケーション（ちょうど今まで作ってきたものと似たようなもの）を必要とするプロジェクトを新しく開始したとしましょう。どうやって投票アプリケーションを再利用可能にしますか？運のいいことに、その方法はすでに会得済みです。 チュートリアル1 では、 include を使ってプロジェクトレベルの URLconf から投票アプリを分離する方法を学びました。このチュートリアルでは、アプリケーションを新規のプロジェクトで使いやすいようにし、いつでも別の場所でインストール/利用できるようにします。
前のチュートリアルを終えると、プロジェクトはこのようになっているはずです:
\ndjangotutorial/\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.png\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\ndjangotutorial/templates は チュートリアル7 で作成し、polls/templates は チュートリアル3 で作成しました。今は、なぜプロジェクトとアプリケーションに別々のテンプレートディレクトリを設けることにしたのかが、より明確になったかもしれません。pollsアプリケーションに関連するすべてのものは polls フォルダ内にあります。これにより、アプリケーションは自己完結型となり、新しいプロジェクトに簡単に組み込むことができます。
今、 polls ディレクトリは新規の Django プロジェクトにコピーでき、すぐに再利用できる状態です。しかし公開するための準備が完璧というわけではありません。そのために、アプリをパッケージにして別の場所でインストールしやすいようにする必要があります。
Python のパッケージングの現状は、複数のツールがあることで少しややこしいです。このチュートリアルでは setuptools をパッケージに使用します。これはおすすめのパッケージングツールです( forkされていた distribute はマージされました)。終わった後にアンインストールするために pip も使います。今はこの 2 つのパッケージをインストールしておいてください。分からなければ Django をpip でインストールする. を参照してください。 setuptools も同じ方法でインストールできます。
Python において パッケージング とは、特定のフォーマットでアプリを作っておくことです。このフォーマットは簡単にインストールして使えます。 Django 自体もこのようにパッケージ化されています。投票アプリのような小さなものでは、このプロセスはそれほど難しいものではありません。
\nまず、Django プロジェクトの外に、パッケージのための親ディレクトリを作成します。以降、このディレクトリを django-polls と呼びます。
polls ディレクトリを django-polls ディレクトリに移動し、名前を django_polls に変更します。
django_polls/apps.py を編集して name が新しいモジュール名を指すようにし、 label を追加してアプリの短い名前を付けます:
django-polls/django_polls/apps.pyfrom django.apps import AppConfig\n\n\nclass PollsConfig(AppConfig):\n default_auto_field = "django.db.models.BigAutoField"\n name = "django_polls"\n label = "polls"\n以下の内容の django-polls/README.rst という名前のファイルを作成します:
django-polls/README.rst============\ndjango-polls\n============\n\ndjango-polls is a Django app to conduct web-based polls. For each\nquestion, visitors 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 "django_polls",\n ]\n\n2. Include the polls URLconf in your project urls.py like this::\n\n path("polls/", include("django_polls.urls")),\n\n3. Run ``python manage.py migrate`` to create the models.\n\n4. Start the development server and visit the admin to create a poll.\n\n5. Visit the ``/polls/`` URL to participate in the poll.\ndjango-polls/LICENSE ファイルを作成します。ライセンスの選択はこのチュートリアルの範疇を超えていますが、ライセンスなしで公にリリースされたコードは 役立たず であると言えば十分です。 Django と多くの Django 互換アプリケーションはBSDライセンスの元に配布されます。でもどのライセンスを選択するかは自由です。ライセンスの選択は、誰がコードを使え得るかに影響すると注意してください。
次に、アプリケーションのビルドおよびインストール方法を詳細に記述した pyproject.toml ファイルを作成します。このファイルの詳細な説明は本チュートリアルの範囲を超えますが、Pythonパッケージユーザーガイド に良い説明があります。以下の内容で django-polls/pyproject.toml ファイルを作成してください。
django-polls/pyproject.toml[build-system]\nrequires = ["setuptools>=77.0.3"]\nbuild-backend = "setuptools.build_meta"\n\n[project]\nname = "django-polls"\nversion = "0.1"\ndependencies = [\n "django>=X.Y", # Replace "X.Y" as appropriate\n]\ndescription = "A Django app to conduct web-based polls."\nreadme = "README.rst"\nlicense = "BSD-3-Clause"\nrequires-python = ">= 3.10"\nauthors = [\n {name = "Your Name", email = "yourname@example.com"},\n]\nclassifiers = [\n "Environment :: Web Environment",\n "Framework :: Django",\n "Framework :: Django :: X.Y", # Replace "X.Y" as appropriate\n "Intended Audience :: Developers",\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.10",\n "Programming Language :: Python :: 3.11",\n "Programming Language :: Python :: 3.12",\n "Programming Language :: Python :: 3.13",\n "Topic :: Internet :: WWW/HTTP",\n "Topic :: Internet :: WWW/HTTP :: Dynamic Content",\n]\n\n[project.urls]\nHomepage = "https://www.example.com/"\n多くの一般的なファイルやPythonモジュール、パッケージは、デフォルトでパッケージに含まれています。追加のファイルを含めるには、MANIFEST.in ファイルを作成する必要があります。テンプレートや静的ファイルを含めるために、以下の内容で django-polls/MANIFEST.in ファイルを作成してください。
django-polls/MANIFEST.inrecursive-include django_polls/static *\nrecursive-include django_polls/templates *\nこれは必須ではありませんが、アプリケーションには詳細なドキュメントを含めることが推奨されます。将来のドキュメント用に、空のディレクトリ django-polls/docs を作成してください。
MANIFEST.in に対象のファイルを追加しないと docs ディレクトリがパッケージに含まれないことに注意してください。多くの Django アプリではドキュメントを readthedocs.org のようなサイトを通して提供しています。
Many Python projects, including Django and Python itself, use Sphinx to build\ntheir documentation. If you choose to use Sphinx you can link back to the\nDjango documentation by configuring Intersphinx\nand including a value for Django in your project's intersphinx_mapping\nvalue:
intersphinx_mapping = {\n # ...\n "django": (\n "https://docs.djangoproject.com/en/stable/",\n None,\n ),\n}\nWith that in place, you can then cross-link to specific entries, in the\nsame way as in the Django docs, such as\n":attr:`django.test.TransactionTestCase.databases`".
Check that the build package is installed (python -m pip install\nbuild) and try building your package by running python -m build inside\ndjango-polls. This creates a directory called dist and builds your\nnew package into source and binary formats, django_polls-0.1.tar.gz and\ndjango_polls-0.1-py3-none-any.whl.
パッケージングに関するより豊富な情報は プロジェクトのパッケージ化と配布に関するチュートリアル にあります。
\npolls ディレクトリはプロジェクト外に移動したので、これはもう動きません。代わりにできたての django-polls パッケージを使ってみましょう。
パッケージをインストールするためには、pip を利用してください (すでに インストール していますよね?):
\npython -m pip install --user django-polls/dist/django_polls-0.1.tar.gz\n新しいモジュール名を指すように mysite/settings.py を更新します:
INSTALLED_APPS = [\n "django_polls.apps.PollsConfig",\n ...,\n]\n新しいモジュール名を指すように mysite/urls.py を更新します:
urlpatterns = [\n path("polls/", include("django_polls.urls")),\n ...,\n]\n開発サーバーを実行して、プロジェクトが引き続き動作することを確認します。
django-polls のパッケージを作り、テストしました。世界に共有するときです！これが単なる例でなければこうします:
パッケージを友人にメールで送る
自身の Web サイトにアップロードする
公開されているリポジトリに投稿する。例えば the Python Package Index (PyPI). packaging.python.org には よくできたチュートリアル があります。
先ほど、 django-polls をユーザライブラリとしてインストールしました。これにはいくつかの欠点があります:
ユーザーライブラリの変更はシステム上の他の Python ソフトウェアに影響を与えるおそれがあります
このパッケージの複数バージョン (もしくは同じ名前の別のもの) を実行できません
通常、このような状況は複数の Django プロジェクトを管理している場合にのみ発生します。このような場合、最良の解決策は venv を使うことです。このツールを使うと、複数の分離されたPython環境を管理することができ、それぞれが独自のライブラリとパッケージの名前空間のコピーを持っています。
\n