This advanced tutorial begins where Tutorial 7\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.
\nIf you haven’t recently completed Tutorials 1–7, we encourage you to review\nthese so that your example project matches the one described below.
\nÉ 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?
\nReusabilidade é o modo de vida em Python. O Python Package Index (PyPI) tem uma grande variedade de pacotes que você pode usar nos seus programas Python. Confira o Django Packages para aplicações reusáveis existentes que você poderia incorporar no seu projeto. Django em si também é um pacote Python. Isso significa que você pode ter pacotes Python existentes ou aplicações Django e compô-los em seu próprio projeto web. Você então só precisa escrever as partes que tornam seu projeto único.
\nDigamos 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.
Depois dos tutoriais anteriores, nosso projeto deve ficar assim:
\nmysite/\n manage.py\n mysite/\n __init__.py\n settings.py\n urls.py\n wsgi.py\n polls/\n __init__.py\n admin.py\n migrations/\n __init__.py\n 0001_initial.py\n models.py\n static/\n polls/\n images/\n background.gif\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\nVocê 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.
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.
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.
\nPrimeiro, crie um diretório pai para polls, fora do seu projeto Django. Nomeie esse diretório de
Mova o diretório polls para dentro do diretório django-polls.
Crie um arquivo django-polls/README.rst com o seguinte conteúdo:
django-polls/README.rst=====\nPolls\n=====\n\nPolls is a simple 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 'polls',\n ]\n\n2. Include the polls URLconf in your project urls.py like this::\n\n url(r'^polls/', include('polls.urls')),\n\n3. Run `python manage.py migrate` to create the polls models.\n\n4. Start the development server and visit http://127.0.0.1:8000/admin/\n to create a poll (you'll need the Admin app enabled).\n\n5. Visit http://127.0.0.1:8000/polls/ to participate in the poll.\nCrie 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.
Next we’ll create a setup.py file which provides details about how to\nbuild and install the app. A full explanation of this file is beyond the\nscope of this tutorial, but the setuptools docs have a good\nexplanation. Create a file django-polls/setup.py with the following\ncontents:
django-polls/setup.pyimport os\nfrom setuptools import find_packages, setup\n\nwith open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme:\n README = readme.read()\n\n# allow setup.py to be run from any path\nos.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))\n\nsetup(\n name='django-polls',\n version='0.1',\n packages=find_packages(),\n include_package_data=True,\n license='BSD License', # example license\n description='A simple Django app to conduct Web-based polls.',\n long_description=README,\n url='https://www.example.com/',\n author='Your Name',\n author_email='yourname@example.com',\n classifiers=[\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', # example license\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n # Replace these appropriately if you are stuck on Python 2.\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.4',\n 'Programming Language :: Python :: 3.5',\n 'Topic :: Internet :: WWW/HTTP',\n 'Topic :: Internet :: WWW/HTTP :: Dynamic Content',\n ],\n)\nPor 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:
django-polls/MANIFEST.ininclude LICENSE\ninclude README.rst\nrecursive-include polls/static *\nrecursive-include polls/templates *\nÉ 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
recursive-include docs *\nNote 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
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,
Para mais informações sobre empacotamento, veja Tutorial Python sobre Empacotamento e Distribuição de Projetos.
\nUma 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.
Para instalar o pacote, use o pip (você já instalou isso, certo?):
\npip install --user django-polls/dist/django-polls-0.1.tar.gz\nCom sorte, seu projeto Django deverá agora funcionar corretamente de novo. Inicie o servidor novamente para confirmar.
Para desinstalar o pacote, use o pip:
\npip uninstall django-polls\nAgora 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.
Postar o pacote em um repositório público, por exemplo, o Python Package Index (PyPI). No packaging.python.org há `um bom tutorial<https://packaging.python.org/en/latest/distributing.html#uploading-your-project-to-pypi>`_ para você fazer isso.
Anteriormente, nós instalamos nosso app de votação como uma biblioteca de usuário. Isso tem algumas desvantagens:
\nModificar 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).
Tipicamente, essas situações apenas aparecem quando você está mantendo muitos projetos em Django. Quando isso acontece, a melhor solução é utilizar virtualenv. Essa ferramenta permite que você mantenha vários ambientes de Python isolados, cada um com sua própria cópia de bibliotecas e namespace de pacotes.
\n