Tutorial avançado: Como escrever aplicações reutilizáveisLink para este cabeçalho#

Reutilização importaLink para este cabeçalho#

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

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 você estava iniciando um novo projeto que precisava de uma aplicação de enquetes, como a que estávamos trabalhando. Como você torna essa aplicação reusável? Felizmente, você já está no caminho certo. No Tutorial 3, nós vimos como poderíamos desacoplar a aplicação de enquete no URLconf do projeto usando um include. Neste tutorial, vamos tomar novas medidas para tornar a aplicação fácil de usar em novos projetos, e pronta para publicar para outros instalarem e usar.

Seu projeto e sua aplicação reutilizávelLink para este cabeçalho#

Depois dos tutoriais anteriores, nosso projeto deve ficar assim:

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

Você criou mysite/templates em Tutorial 7, e polls/templates en Tutorial 3. Talvez agora fique caro porque escolhemos separar o diretório de templates do de projeto e aplicação: tudo que é parte da aplicação “polls” está em polls. Isso torna a aplicação auto-contida e facilita adicioná-la em um novo projeto.

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.

Instalando alguns pré-requisitosLink para este cabeçalho#

O estado atual do empacotamento Python é um pouco complicado com várias ferramentas. Para este tutorial, vamos estar usando setuptools para construir nosso pacote. É a ferramenta de empacotamento recomendada (mergeado com o fork do distribute). Estaremos usando também o pip para instalar e desinstalá-los. Você deve instalar esses dois pacotes agora. Se precisar de ajuda, você pode consultar o como instalar Django com pip. Você pode instalar o setuptools da mesma maneira.

Empacotando sua aplicaçãoLink para este cabeçalho#

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.

1. Primeiro, crie um diretório pai para polls, fora do seu projeto Django. Nomeie esse diretório de django-polls`.

2. Mova o diretório polls para dentro do diretório django-polls.

3. Crie um arquivo django-polls/README.rst com o seguinte conteúdo:

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

5. Como próximo passo iremos criar um arquivo setup.py o qual fornece detalhes sobre como construir e instalar a “app”. Um expliação completa sobre este arquivo está fora do escopo deste tutorial, mas o documento setuptools docs tem uma boa explicação. Crie um arquivo django-polls/setup.py com o seguinte conteúdo:

   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. Por padrão, apenas módulos e pacotes Python são incluídos no pacote. Para incluir arquivos adicionais, precisaremos criar um arquivo MANIFEST.in. A documentação do setuptools citada no passo anterior, fala deste arquivo em mais detalhes. Para incluir o templates, o README.rst e nosso arquivo LICENSE, crie um arquivo django-polls/MANIFEST.in com o seguinte conteúdo:

   Code

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

7. É opcional, mas recomendado, incluir uma documentação detalhada com sua aplicação. Crie um diretório django-polls/docs vazio, para futura documentação. Adicione uma linha a mais ao

   Code

   recursive-include docs *
   

   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

8. Tente criar seu pacote com python setup.py sdist (execute dentro do diretório django-polls). Esse comando cria um diretório chamado dist e cria seu novo pacote,

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

Utilizando o seu próprio pacoteLink para este cabeçalho#

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

1. Para instalar o pacote, use o pip (você já instalou isso, certo?):

   Code

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

2. Com sorte, seu projeto Django deverá agora funcionar corretamente de novo. Inicie o servidor novamente para confirmar.

3. Para desinstalar o pacote, use o pip:

   Code

   pip uninstall django-polls
   

Publicando sua aplicaçãoLink para este cabeçalho#

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.

• 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 pacotes Python com virtualenvLink para este cabeçalho#

Anteriormente, nós instalamos nosso app de votação como uma biblioteca de usuário. Isso tem algumas desvantagens:

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

Em geral, essas situações somente vem a tona quando se mantém vários projetos Django. Neste caso, a melhor solução é usar o virtualenv. Esta ferramenta permite que você mantenha múltiplos ambientes Python isolados, cada um com sua própria cópia de bibliotecas e “namespaces” de pacotes.