# documentación de Django - 3.2.11.dev

# Tutorial Avanzado: Cómo escribir aplicaciones reutilizables

Este tutorial avanzado comienza donde quedó el : doc:Tutorial 7 </intro/tutorial07>. Vamos a convertir nuestra encuesta Web en un paquete independiente Python que puedes reutilizar en nuevos proyectos y compartir con otras personas.

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

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

Let’s say you were starting a new project that needed a polls app like the one we’ve been working on. How do you make this app reusable? Luckily, you’re well on the way already. In Tutorial 1, we saw how we could decouple polls from the project-level URLconf using an `include`. In this tutorial, we’ll take further steps to make the app easy to use in new projects and ready to publish for others to install and use.

¿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 debe tener este aspecto:

    mysite/
        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.gif
                    style.css
            templates/
                polls/
                    detail.html
                    index.html
                    results.html
            tests.py
            urls.py
            views.py
        templates/
            admin/
                base_site.html

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

## Instalación de algunos requisitos previos

El estado actual del empaquetamiento de Python se ha vuelto confuso a causa de varias herramientas. Para este tutorial, vamos a utilizar setuptools para generar nuestro paquete. Es la herramienta de empaquetamiento recomendada (combinada la bifurcación `distribute`). También vamos a utilizar pip para instalar y desinstalarlo. Debe ahora instalar estos dos paquetes. Si necesita ayuda puede consultar Cómo instalar Django con pip. Del mismo modo, puede instalar el paquete `setuptools`.

## 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. En primer lugar, cree un directorio principal para `polls` fuera de su proyecto Django. Nombre este directorio como `django-polls`.

   Eligir un nombre para su aplicación

   Al momento de elegir un nombre para su paquete, revise recursos como PyPI para evitar conflictos de nombres con los paquetes existentes. Con frecuencia es útil anteponer `django-` a su nombre de módulo cuando crea un paquete para distribuir. Esto ayuda a otros que estén buscando aplicaciones Django identificar su aplicación como particular de Django.

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

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

   django-polls/README.rst

       =====
       Polls
       =====

       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 = [
               ...
               'polls',
           ]

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

           path('polls/', include('polls.urls')),

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

       4. Start the development server and visit http://127.0.0.1:8000/admin/
          to create a poll (you'll need the Admin app enabled).

       5. Visit http://127.0.0.1:8000/polls/ to participate in the poll.

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

5. Next we’ll create `setup.cfg` and `setup.py` files which detail how to build and install the app. A full explanation of these files is beyond the scope of this tutorial, but the setuptools documentation has a good explanation. Create the files `django-polls/setup.cfg` and `django-polls/setup.py` with the following contents:

   django-polls/setup.cfg

       [metadata]
       name = django-polls
       version = 0.1
       description = A Django app to conduct Web-based polls.
       long_description = file: README.rst
       url = https://www.example.com/
       author = Your Name
       author_email = yourname@example.com
       license = BSD-3-Clause  # Example license
       classifiers =
           Environment :: Web Environment
           Framework :: Django
           Framework :: Django :: X.Y  # Replace "X.Y" as appropriate
           Intended Audience :: Developers
           License :: OSI Approved :: BSD License
           Operating System :: OS Independent
           Programming Language :: Python
           Programming Language :: Python :: 3
           Programming Language :: Python :: 3 :: Only
           Programming Language :: Python :: 3.6
           Programming Language :: Python :: 3.7
           Programming Language :: Python :: 3.8
           Topic :: Internet :: WWW/HTTP
           Topic :: Internet :: WWW/HTTP :: Dynamic Content

       [options]
       include_package_data = true
       packages = find:
       python_requires = >=3.6
       install_requires =
           Django >= X.Y  # Replace "X.Y" as appropriate

   django-polls/setup.py

       from setuptools import setup

       setup()

6. Only Python modules and packages are included in the package by default. To include additional files, we’ll need to create a `MANIFEST.in` file. The setuptools docs referred to in the previous step discuss this file in more detail. To include the templates, the `README.rst` and our `LICENSE` file, create a file `django-polls/MANIFEST.in` with the following contents:

   django-polls/MANIFEST.in

       include LICENSE
       include README.rst
       recursive-include polls/static *
       recursive-include polls/templates *

7. Es opcional pero recomendado incluir documentación detallada con su aplicación. Cree un directorio `django-polls/docs` vacío para la documentación futura . Agregue una línea adicional al archivo `django-polls/MANIFEST.in`:

       recursive-include docs *

   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.

8. Intente generar su paquete con `python setup.py sdist` (ejecute desde dentro de `django-polls`). Esto crea un directorio llamado `dist` y crea su nuevo paquete, `django-polls-0.1.tar.gz`.

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. Para instalar el paquete, use pip (ya lo instaló, ¿cierto?):

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

2. Con suerte, su proyecto Django ahora debería funcionar de nuevo correctamente. Ejecute el servidor de nuevo para confirmar esto.

3. Para desinstalar el paquete, utilice pip:

       python -m pip uninstall django-polls

## 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). packaging.python.org has a good tutorial for doing this.

## Installing Python packages with a virtual environment

Anteriormente, instalamos la aplicación polls como una librería de usuario. Esto presenta algunas desventajas:

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