# documentación de Django - 5.2.8

# Tutorial Avanzado: Cómo escribir aplicaciones reutilizables

Este tutorial avanzado comienza donde quedó el Tutorial 8. Convertiremos nuestra encuesta web en un paquete de Python independiente que puedas reutilizar en nuevos proyectos y compartir con otras personas.

SI recientemente no ha completado los Tutoriales 1–8, le recomendamos que los revise para que su proyecto de ejemplo coincida con el que se describe a continuación.

## La reusabilidad importa

Requiere 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?

Reusability is the way of life in Python. The Python Package Index (PyPI) has a vast range of packages you can use in your own Python programs. Check out Django Packages for existing reusable apps you could incorporate in your project. Django itself is also a normal Python package. This means that you can take existing Python packages or Django apps and compose them into your own web project. You only need to write the parts that make your project unique.

Digamos 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.

¿Paquete? ¿Aplicación?

Un paquete de Python proporciona una forma de agrupar código Python relacionado para reutilizarlo de forma fácil. Un paquete contiene uno o más archivos de código Python (también conocidos como «módulos»).

Un paquete puede ser importado con `import foo.bar` o `from foo import bar`. Para que un directorio (como `polls`) cree un paquete, debe contener un archivo especial `__init__.py`, incluso si este archivo está vacío.

A Django application is a Python package that is specifically intended for use in a Django project. An application may use common Django conventions, such as having `models`, `tests`, `urls`, and `views` submodules.

Posteriormente, usamos el término empaquetamiento para describir el proceso de hacer que un paquete Python sea fácil de instalar para los demás. Sabemos que puede ser un poco confuso.

## Su proyecto y su aplicación reutilizable

Después de los tutoriales anteriores, nuestro proyecto debería verse así:

    djangotutorial/
        manage.py
        mysite/
            __init__.py
            settings.py
            urls.py
            asgi.py
            wsgi.py
        polls/
            __init__.py
            admin.py
            apps.py
            migrations/
                __init__.py
                0001_initial.py
            models.py
            static/
                polls/
                    images/
                        background.png
                    style.css
            templates/
                polls/
                    detail.html
                    index.html
                    results.html
            tests.py
            urls.py
            views.py
        templates/
            admin/
                base_site.html

You created `djangotutorial/templates` in Tutorial 7, and `polls/templates` in Tutorial 3. Now perhaps it is clearer why we chose to have separate template directories for the project and application: everything that is part of the polls application is in `polls`. It makes the application self-contained and easier to drop into a new project.

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.

## Instalación de algunos requisitos previos

The current state of Python packaging is a bit muddled with various tools. For this tutorial, we’re going to use setuptools to build our package. It’s the recommended packaging tool (merged with the `distribute` fork). We’ll also be using pip to install and uninstall it. You should install these two packages now. If you need help, you can refer to how to install Django with pip. You can install `setuptools` the same way.

## Empaquetando su aplicación

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.

1. Primero, cree un directorio principal para el paquete, fuera de su proyecto Django. Nombre a este directorio `django-polls`.

   Eligir un nombre para su aplicación

   Al elegir un nombre para su paquete, consulte PyPI para evitar conflicto de nombres con los paquetes existentes. Recomendamos utilizar el prefijo `django-` para los nombres de los paquetes, para identificar su paquete como específico de Django, y un prefijo `django_` correspondiente para el nombre de su módulo. Por ejemplo, el paquete `django-ratelimit` contiene el módulo `django_ratelimit`.

   Las etiquetas de la aplicación (es decir, la parte final del camino punteado a los paquetes de las aplicaciones) deben ser únicas en `INSTALLED_APPS`. Evite utilizar la misma etiqueta como las de cualquier paquete contrib de Django:, por ejemplo, `auth`, `admin`, o `messages`.

2. Mueva el directorio `polls` al directorio `django-polls` y cambie el nombre a `django_polls`.

3. Editar `django_polls/apps.py` para que `name` se refiera al nuevo nombre del módulo y `label` para dar un nombre corto para la aplicación:

   `django-polls/django_polls/apps.py`

       from django.apps import AppConfig

       class PollsConfig(AppConfig):
           name = "django_polls"
           label = "polls"

4. Cree un archivo `django-polls/README.rst` con el siguiente contenido:

   `django-polls/README.rst`

       ============
       django-polls
       ============

       django-polls is a Django app to conduct web-based polls. For each
       question, visitors can choose between a fixed number of answers.

       Detailed documentation is in the "docs" directory.

       Quick start
       -----------

       1. Add "polls" to your INSTALLED_APPS setting like this::

           INSTALLED_APPS = [
               ...,
               "django_polls",
           ]

       2. Include the polls URLconf in your project urls.py like this::

           path("polls/", include("django_polls.urls")),

       3. Run ``python manage.py migrate`` to create the models.

       4. Start the development server and visit the admin to create a poll.

       5. Visit the ``/polls/`` URL to participate in the poll.

5. Cree 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.

6. Next we’ll create the `pyproject.toml` file which details how to build and install the app. A full explanation of this file is beyond the scope of this tutorial, but the Python Packaging User Guide has a good explanation. Create the `django-polls/pyproject.toml` file with the following contents:

   `django-polls/pyproject.toml`

       [build-system]
       requires = ["setuptools>=77.0.3"]
       build-backend = "setuptools.build_meta"

       [project]
       name = "django-polls"
       version = "0.1"
       dependencies = [
           "django>=X.Y",  # Replace "X.Y" as appropriate
       ]
       description = "A Django app to conduct web-based polls."
       readme = "README.rst"
       license = "BSD-3-Clause"
       requires-python = ">= 3.12"
       authors = [
           {name = "Your Name", email = "yourname@example.com"},
       ]
       classifiers = [
           "Environment :: Web Environment",
           "Framework :: Django",
           "Framework :: Django :: X.Y",  # Replace "X.Y" as appropriate
           "Intended Audience :: Developers",
           "Operating System :: OS Independent",
           "Programming Language :: Python",
           "Programming Language :: Python :: 3",
           "Programming Language :: Python :: 3 :: Only",
           "Programming Language :: Python :: 3.12",
           "Programming Language :: Python :: 3.13",
           "Programming Language :: Python :: 3.14",
           "Topic :: Internet :: WWW/HTTP",
           "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
       ]

       [project.urls]
       Homepage = "https://www.example.com/"

7. Many common files and Python modules and packages are included in the package by default. To include additional files, we’ll need to create a `MANIFEST.in` file. To include the templates and static files, create a file `django-polls/MANIFEST.in` with the following contents:

   `django-polls/MANIFEST.in`

       recursive-include django_polls/static *
       recursive-include django_polls/templates *

8. Es opcional, pero recomendado, incluir documentación detallada con su aplicación. Cree un directorio vacío `django-polls/docs` para una documentación futura.

   Tenga 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.

   Many Python projects, including Django and Python itself, use Sphinx to build their documentation. If you choose to use Sphinx you can link back to the Django documentation by configuring Intersphinx and including a value for Django in your project’s `intersphinx_mapping` value:

       intersphinx_mapping = {
           # ...
           "django": (
               "https://docs.djangoproject.com/en/stable/",
               None,
           ),
       }

   With that in place, you can then cross-link to specific entries, in the same way as in the Django docs, such as «`:attr:`django.test.TransactionTestCase.databases``».

9. Check that the build package is installed (`python -m pip install build`) and try building your package by running `python -m build` inside `django-polls`. This creates a directory called `dist` and builds your new package into source and binary formats, `django_polls-0.1.tar.gz` and `django_polls-0.1-py3-none-any.whl`.

For more information on packaging, see Python’s Tutorial on Packaging and Distributing Projects.

## Usando su propio paquete

Dado 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`.

Instalando como una librería de usuario

Los siguientes pasos instalan `django-polls` como una librería de usuario. La instalación a nivel de usuario tiene muchas ventajas con respecto a instalar el paquete a nivel de sistema, como poder ser usado en sistemas donde no se tiene acceso de administrador así como impedir que el paquete afecte servicios del sistema y a otros usuarios del ordenador.

Note that per-user installations can still affect the behavior of system tools that run as that user, so using a virtual environment is a more robust solution (see below).

1. To install the package, use pip (you already installed it, right?):

       python -m pip install --user django-polls/dist/django_polls-0.1.tar.gz

2. Actualice `mysite/settings.py` para que apunte al nuevo nombre del módulo:

       INSTALLED_APPS = [
           "django_polls.apps.PollsConfig",
           ...,
       ]

3. Actualice `mysite/urls.py` para que apunte al nuevo nombre del módulo:

       urlpatterns = [
           path("polls/", include("django_polls.urls")),
           ...,
       ]

4. Run the development server to confirm the project continues to work.

## Publicando su aplicación

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 (PyPI). There is a good tutorial for doing this.

## Instalando paquetes de Python con un entorno virtual

Earlier, we installed `django-polls` as a user library. This has some disadvantages:

- 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 projects. When they do, the best solution is to use venv. This tool allows you to maintain multiple isolated Python environments, each with its own copy of the libraries and package namespace.