Tutorial Avanzado: Cómo escribir aplicaciones reutilizablesLink to this heading#

La reusabilidad importaLink to this heading#

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 just a 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 empezó un nuevo proyecto que necesitaba una aplicación encuestas como en la que hemos estado trabajando. ¿Cómo hace que esta aplicación sea reutilizable? Por suerte va bien encaminado. En el Tutorial 3, 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.

Su proyecto y su aplicación reutilizableLink to this heading#

Después de los tutoriales anteriores, nuestro proyecto debe tener este aspecto:

mysite/
    manage.py
    mysite/
        __init__.py
        settings.py
        urls.py
        wsgi.py
    polls/
        __init__.py
        admin.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 previosLink to this heading#

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 con el fork 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ónLink to this heading#

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.

2. Mueva el directorio polls al directorio django-polls.

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

   Code

   =====
   Polls
   =====
   
   Polls is a simple 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::
   
       url(r'^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 a setup.py file which provides details about how to build and install the app. A full explanation of this file is beyond the scope of this tutorial, but the setuptools docs have a good explanation. Create a file django-polls/setup.py with the following contents:

   Code

   import os
   from setuptools import find_packages, setup
   
   with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme:
       README = readme.read()
   
   # allow setup.py to be run from any path
   os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
   
   setup(
       name='django-polls',
       version='0.1',
       packages=find_packages(),
       include_package_data=True,
       license='BSD License',  # example license
       description='A simple Django app to conduct Web-based polls.',
       long_description=README,
       url='https://www.example.com/',
       author='Your Name',
       author_email='yourname@example.com',
       classifiers=[
           'Environment :: Web Environment',
           'Framework :: Django',
           'Framework :: Django :: X.Y',  # replace "X.Y" as appropriate
           'Intended Audience :: Developers',
           'License :: OSI Approved :: BSD License',  # example license
           'Operating System :: OS Independent',
           'Programming Language :: Python',
           # Replace these appropriately if you are stuck on Python 2.
           'Programming Language :: Python :: 3',
           'Programming Language :: Python :: 3.4',
           'Programming Language :: Python :: 3.5',
           'Topic :: Internet :: WWW/HTTP',
           'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
       ],
   )
   

6. Solo se incluyen módulos y paquetes de Python en el paquete de forma predeterminada. Para incluir archivos adicionales, tendremos que crear un archivo MANIFEST.in. La documentación setuptools referidos en el paso anterior abordan este archivo de forma detallada. Para incluir las plantillas, el README.rst y nuestro archivo LICENSE, cree un archivo django-polls/MANIFEST.in con el siguiente contenido:

   Code

   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:

   Code

   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 paqueteLink to this heading#

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.

1. Para instalar el paquete, use pip (ya lo instaló, ¿cierto?):

   Code

   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:

   Code

   pip uninstall django-polls
   

Publicando su aplicaciónLink to this heading#

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.

Instalando los paquetes Python con virtualenvLink to this heading#

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 virtualenv. This tool allows you to maintain multiple isolated Python environments, each with its own copy of the libraries and package namespace.