This advanced tutorial begins where Tutorial 8\nleft off. We’ll be turning our web-poll into a standalone Python package\nyou can reuse in new projects and share with other people.
\nIf you haven’t recently completed Tutorials 1–8, we encourage you to review\nthese so that your example project matches the one described below.
\nÉ um grande trabalho projetar, contruir, testar e manter uma aplicação web. Muitos projetos Python e Django compartilham problemas em comum. Não seria ótimo se nós pudessemos economizar um pouco desse trabalho repetido?
\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.
\nVamos dizer que você está iniciando um projeto que precisa de uma aplicação de enquetes como a que estivemos trabalhando. Como fazer essa aplicação reutilizável? Sua sorte é que é que você já está no caminho. Em Tutorial, vimos como podemos desacoplar a enquete do URLconf do projeto usando um include. Neste tutorial, iremos adiante para tornar a aplicação fácil de usar em novos projetos e pronta para publicar para outros instalarem e usarem.
After the previous tutorials, our project should look like this:
\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\nYou created djangotutorial/templates in Tutorial 7, and polls/templates in\nTutorial 3. Now perhaps it is clearer why we chose\nto have separate template directories for the project and application:\neverything that is part of the polls application is in polls. It makes the\napplication self-contained and easier to drop into a new project.
O diretório polls poderia agora ser copiado em um novo projeto Django, e imediatamente reusada. Embora não esteja já pronta para ser publicada. Para isso, nós precisamos empacotar a aplicação para tornar fácil para outros instalarem.
The current state of Python packaging is a bit muddled with various tools. For\nthis tutorial, we’re going to use setuptools to build our package. It’s\nthe recommended packaging tool (merged with the distribute fork). We’ll\nalso be using pip to install and uninstall it. You should install these\ntwo packages now. If you need help, you can refer to how to install\nDjango with pip. You can install setuptools\nthe same way.
Empacotamento Python refere-se a preparar sua aplicação num formato específico que possa ser facilmente instalado e usado. O próprio Django é empacotado de uma maneira muito parecida. Para aplicações pequenas, como a de enquetes, esse processo não é tão difícil.
\nFirst, create a parent directory for the package, outside of your Django\nproject. Call this directory django-polls.
Move the polls directory into django-polls directory, and rename it\nto django_polls.
Edit django_polls/apps.py so that name refers to the\nnew module name and add label to give a short name for\nthe app:
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"\nCrie um arquivo django-polls/README.rst com o seguinte conteúdo:
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.\nCrie um arquivo django-polls/LICENSE. Escolher uma licença está fora do escopo deste tutorial, mas é suficiente dizer que código distribuído publicamente sem uma licença é inútil. Djando e muitas aplicações compatíveis com o Django são distribuídas sob a licença BSD; no entanto, você é livre para escolher sua própria licença. Apenas esteja ciente que a escolha da sua licença afetará quem pode usar seu código.
Next we’ll create the pyproject.toml file which details how to build and\ninstall the app. A full explanation of this file is beyond the scope of this\ntutorial, but the Python Packaging User Guide has a good\nexplanation. Create the django-polls/pyproject.toml file with the\nfollowing contents:
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/"\nMany common files and Python modules and packages are included in the\npackage by default. To include additional files, we’ll need to create a\nMANIFEST.in file. To include the templates and static files, create a\nfile django-polls/MANIFEST.in with the following contents:
django-polls/MANIFEST.inrecursive-include django_polls/static *\nrecursive-include django_polls/templates *\nIt’s optional, but recommended, to include detailed documentation with your\napp. Create an empty directory django-polls/docs for future\ndocumentation.
Note que o diretório docs não será incluido no seu pacote a menos que você adicione alguns arquivos para ele. Muitas aplicações Django fornecem sua documentação online através de sites como
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.
Para mais informações sobre empacotamente, veja o Tutorial sobre Empacotamento e Distribuição de Projetos.
\nUma vez que movemos o diretório polls para fora do projeto, ele não funciona mais. Vamos consertar isso agora ao instalar nosso novo pacote django-polls.
To install the package, use pip (you already installed it, right?):
\npython -m pip install --user django-polls/dist/django_polls-0.1.tar.gz\nUpdate mysite/settings.py to point to the new module name:
INSTALLED_APPS = [\n "django_polls.apps.PollsConfig",\n ...,\n]\nUpdate mysite/urls.py to point to the new module name:
urlpatterns = [\n path("polls/", include("django_polls.urls")),\n ...,\n]\nRun the development server to confirm the project continues to work.
Agora que nós empacotamos e testamos django-polls, ele está pronto para ser compartilhado com o mundo! Se isso não foi apenas um exemplo, você pode agora:
Enviar o pacote por email para um amigo.
Enviar o pacote para seu site.
Colocar o pacote em um repositório público, tal como the Python Package Index (PyPI). packaging.python.org tem um bom tutorial para fazer isso.
Earlier, we installed django-polls as a user library. This has some\ndisadvantages:
Modificar as bibliotecas de usuário pode afetar outros softwares em Python do seu sistema.
Você não poderá rodar versões diferentes do seu pacote (ou outros pacotes com o mesmo nome).
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