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.
\nSi recientemente no ha completado los Tutoriales 1-7, le recomendamos que los revise para que su proyecto de ejemplo coincida con el que se describe abajo.
\nRequiere mucho trabajo diseñar, crear, probar y mantener una aplicación web. Muchos proyectos de Python y Django comparten problemas comunes. ¿No sería genial si pudiéramos ahorrarnos algo de este trabajo 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.
\nDigamos que ha empezado un nuevo proyecto que necesitaba una aplicación de encuestas como la que hemos estado trabajando. ¿Cómo hace que esta aplicación sea reutilizable? Por suerte va bien encaminado. En el Tutorial 1, vimos como podíamos separar las encuestas de la URLconf a nivel de proyecto utilizando un include. En este tutorial, adoptaremos las medidas para hacer que la aplicación sea fácil de utilizar en nuevos proyectos y quede lista para su publicación de manera que otros la instalen y usen.
After the previous tutorials, our project should look like this:
\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.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\nHa creado mysite/templates en Tutorial 7, y polls/templates en Tutorial 3. Ahora quizá queda más claro por qué se separan los directorios de plantillas en el proyecto y la aplicación: todo lo que forma parte de la applicación de encuestas está en polls. Esto hace que la aplicación esté auto-contenida y sea más sencillo incluirla en un nuevo proyecto.
El directorio polls ahora se podría copiar en un nuevo proyecto de Django e inmediatamente ser reutilizado. Sin embargo, no está listo para ser publicado. Para ello, necesitamos empaquetar la aplicación para hacer más fácil que otros la instalen.
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.
El empaquetamiento en Python se refiere a la preparación de su aplicación en un formato específico que pueda ser fácilmente instalado y utilizado. Django mismo está empaquetado de forma muy similar a esta. Para una aplicación pequeña como polls este proceso no es muy complejo.
\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"\nCree un archivo django-polls/README.rst con el siguiente contenido:
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.\nCree un archivo django-polls/LICENSE. Elegir una licencia está fuera del alcance de este tutorial, pero basta con señalar que el código liberado públicamente sin ninguna licencia es inútil. Django y muchas aplicaciones compatibles con Django se distribuyen bajo la licencia BSD, sin embargo, usted es libre de elegir su propia licencia. Sólo tenga en cuenta que la elección de su licencia repercutirá sobre quién podrá utilizar su código.
Next we’ll create pyproject.toml, setup.cfg, and setup.py files\nwhich detail how to build and install the app. A full explanation of these\nfiles is beyond the scope of this tutorial, but the setuptools\ndocumentation has a good\nexplanation. Create the django-polls/pyproject.toml,\ndjango-polls/setup.cfg, and django-polls/setup.py files with the\nfollowing contents:
django-polls/pyproject.toml[build-system]\nrequires = ['setuptools>=40.8.0']\nbuild-backend = 'setuptools.build_meta'\ndjango-polls/setup.cfg[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.10\n Programming Language :: Python :: 3.11\n Programming Language :: Python :: 3.12\n Topic :: Internet :: WWW/HTTP\n Topic :: Internet :: WWW/HTTP :: Dynamic Content\n\n[options]\ninclude_package_data = true\npackages = find:\npython_requires = >=3.10\ninstall_requires =\n Django >= X.Y # Replace "X.Y" as appropriate\ndjango-polls/setup.pyfrom setuptools import setup\n\nsetup()\nOnly Python modules and packages are included in the package by default. To\ninclude additional files, we’ll need to create a MANIFEST.in file. The\nsetuptools docs referred to in the previous step discuss this file in\nmore detail. To include the templates, the README.rst and our\nLICENSE file, create a file django-polls/MANIFEST.in with the\nfollowing contents:
django-polls/MANIFEST.ininclude LICENSE\ninclude README.rst\nrecursive-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. Add an additional line to django-polls/MANIFEST.in:
recursive-include docs *\nTenga en cuenta que el directorio docs no se incluirá en su paquete a menos que usted agregue algunos archivos a este. Muchas aplicaciones Django proporcionan también su documentación online a través de sitios como readthedocs.org.
Try building your package by running python setup.py sdist inside\ndjango-polls. This creates a directory called dist and builds your\nnew package, django-polls-0.1.tar.gz.
For more information on packaging, see Python’s Tutorial on Packaging and\nDistributing Projects.
\nDado que movimos el directorio polls fuera del proyecto, ya no funciona. Vamos a solucionar esto mediante la instalación de nuestro nuevo paquete 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.
Ahora que hemos empaquetado y probado django-polls, está lista para compartir con el mundo! Si esto no era más que un ejemplo, usted ahora podría:
Enviar por correo electrónico el paquete a un amigo.
Cargar el paquete en su sitio web.
Post the package on a public repository, such as the Python Package Index\n(PyPI). packaging.python.org has a good\ntutorial\nfor doing this.
Earlier, we installed django-polls as a user library. This has some\ndisadvantages:
Modificar las librerías de usuario puede afectar a otro programa Python en su sistema.
Usted no podrá ejecutar distintas versiones de este paquete (u otros con el mismo nombre).
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