Questo tutorial avanzato inizia dove :doc: Tutorial</intro/tutorial07> era rimasto.\nTrasformeremo il nostro Web-poll in un pacchetto python indipendente che potrai riutilizzare in nuovi progetti e condividere con altre persone.
\nSe non hai completato di recente i Tutorial 1–7, ti invitiamo a rivederli in modo che il tuo progetto di esempio corrisponda a quello descritto di seguito.
\nCi vuole molto lavoro per progettare, costruire, testare e manutenere una applicazione web. Alcuni progetti in Python e Django condividono problemi comuni.\nNon sarebbe fantastico se potessimo risparmiare parte di questo lavoro ripetuto?
\nLa riusabilità è uno stile di vita in Python. Il Python Package Index (PyPI) <https://pypi.org/> offre una vasta gamma di package che puoi usare nei tuoi programmi Python. Dai un’occhiata agli Django Packages per trovare app riutilizzabili da incorporare nei tuoi progetti. Django stesso è un normale package. Questo significa che puoi prendere package Django esistenti o app Django e comporli nel tuo progetto web. Devi solo scrivere le parti che rendono il tuo progetto unico.
\nDiciamo che tu stia iniziando un nuovo progetto che necessita di una applicazione di questionari come quella su cui abbiamo lavorato. Come rendi quest’app riutilizzabile? Fortunatamente, sei già un passo avanti. Nel Tutorial 1, abbiamo detto come disaccoppiare polls dalla configurazione delle URL a livello di progetto usando include. In questo tutorial, faremo altri passi per rendere l’app facilmente utilizzabile in progetti nuovi e pronta da pubblicare affinchè altri possano installarla ed usarla.
Dopo i tutorial precedenti, il nostro progetto dovrebbe essere cosi
\nmysite/\n manage.py\n mysite/\n __init__.py\n settings.py\n urls.py\n asgi.py\n wsgi.py\n polls/\n __init__.py\n admin.py\n apps.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\nHai creato mysite/templates in Tutorial 7 </intro/tutorial07> e `polls/templates` in :doc:`Tutorial 3 </intro/tutorial03>. Ora forse è più chiaro perchè abbiamo scelto di separare le directories con i template tra progetto e applicazione: tutto ciò che fa parte dell’applicazione «polls» è dentro «polls». Questo rende l’applicazione più facile da rilasciare in un nuovo progetto poichè contiene tutte le informazioni dentro di se.
\nLa directory polls può essere copiata in un nuovo progetto Django e immediatamente riutilizzata. Non è completamente pronta per essere pubblicata. Per questo, dobbiamo creare un pacchetto dall’app per semplificare l’installazione da parte di altri.
Lo stato corrente del packaging di Python è un pochino confuso con vari tool. Per questo tutorial, useremo setuptools per costruire il nostro package. E” il tool di packaging raccomandato (in merge con il fork distribute). Useremo anche pip per installarlo e disinstallarlo. Dovresti installare questi due package ora. Se ti serve aiuto, puoi fare riferimento a come installare Django con pip1. Puoi installare setuptools allo stesso modo.
Il packaging Python si riferisce al preparare la tua app in un formato specifico che può essere facilmente installato e riutilizzato. Django stesso è «impacchettato» così. Per piccole app come polls, è un processo non molto difficile.
\nPrimo, crea una directory principale per polls, all’esterno del tuo progetto Django. Nomina questa cartella django-polls.
Sposta la cartella polls nella cartella django-polls.
Crea un file django-polls/README.rst con il seguente contenuto:
django-polls/README.rst=====\nPolls\n=====\n\nPolls is a Django app to conduct Web-based polls. For each question,\nvisitors 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 path('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.\nCrea un file ``django-polls/LICENSE`. Scegliere una licenza è oltre lo scopo di questo tutorial, ma è sufficiente dire che il codice rilasciato pubblicamente senza licenza è inutile. Django e molte app Django-compatibili sono distribuite sotto la licenza BSD; comunque, sei libero di scegliere la licenza che preferisci. Sii solo consapevole che la licenza che scegli influenzerà anche quelli che usano il tuo codice.
Poi creiamo i file setup.cfg e setup.py che dettagliano come costruire ed installare l’app. Una spiegazione approfondita di questi file è oltre lo scopo di questo tutorial, ma la documentazione setuptools offre una buona spiegazione. Crea i file django-polls/setup.cfg e django-polls/setup.py con i seguenti contenuti:
django-polls/setup.cfg[metadata]\nname = django-polls\nversion = 0.1\ndescription = A Django app to conduct Web-based polls.\nlong_description = file: README.rst\nurl = https://www.example.com/\nauthor = Your Name\nauthor_email = yourname@example.com\nlicense = BSD-3-Clause # Example license\nclassifiers =\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\n Operating System :: OS Independent\n Programming Language :: Python\n Programming Language :: Python :: 3\n Programming Language :: Python :: 3 :: Only\n Programming Language :: Python :: 3.6\n Programming Language :: Python :: 3.7\n Programming Language :: Python :: 3.8\n Topic :: Internet :: WWW/HTTP\n Topic :: Internet :: WWW/HTTP :: Dynamic Content\n\n[options]\ninclude_package_data = true\npackages = find:\npython_requires = >=3.6\ninstall_requires =\n Django >= X.Y # Replace "X.Y" as appropriate\ndjango-polls/setup.pyfrom setuptools import setup\n\nsetup()\nSolo i moduli ed i package di Python sono inclusi nel package di default. Per includere altri file, abbiamo bisogno di creare un file MANIFEST.in. I documenti setuptools ai quali si è fatto riferimento nello step precedente, discutono questo file più nel dettaglio. Per includere i template, il file README.rst ed il nostro file LICENSE, crea un file django-polls/MANIFEST.in con i seguenti contenuti:
django-polls/MANIFEST.ininclude LICENSE\ninclude README.rst\nrecursive-include polls/static *\nrecursive-include polls/templates *\nNon è obbligatorio, ma si raccomanda, di includere una documentazione dettagliata con l’app. Crea una directory vuota django-polls/docs per la futura documentazione. Aggiungi una linea in django-polls/MANIFEST.in:
recursive-include docs *\nNota che la directory docs non verrà inclusa nel tuo package finchè non ci aggiungi dei file. Molte Django app offrono la loro documentazione online anche attraverso siti come readthedocs.org.
Prova a fare una build del tuo package con python setup.py sdist` (lancialo in django-polls). Questo crea una directory chiamata dist e costruisce il tuo nuovo package, django-polls-0.1.tar.gz.
Per ulteriori informazioni sul packaging, vedi il tutorial di Python Tutorial sul Packaging e la Distribuzione di Progetti.
\nDato che abbiamo spostato la cartella polls fuori dal nostro progetto, non funziona più. Possiamo sistemare questo problema, installando il nuovo nostro package django-polls.
Per installare il package, usa pip (lo ha già installato, giusto?):
\npython -m pip install --user django-polls/dist/django-polls-0.1.tar.gz\nCon un pizzico di fortuna, il tuo progetto Django ora dovrebbe nuovamente funzionare correttamente. Esegui il server di nuovo per confermare.
Per disinstallare il package, usare pip:
\npython -m pip uninstall django-polls\nOra che abbiamo creato e testato il package django-polls, è pronto per essere condiviso con il mondo! Se questo non era solo un esempio, potresti fare ora:
Manda via mail il package ad un amico.
Uploada il pacchetto sul tuo sito web
Metti il package su un repository pubblico come il Python Package Index (PyPI). packaging.python.org <https://packaging.python.org>`_ offre un bel tutorial <https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives>`_ per farlo.
Prima, abbiamo installato la app polls come una libreria utente. Questo però ha dei svantaggi:
\nModificare le librerie delle utenze può danneggiare altri software Python installati nel tuo sistema.
Non sarai in grado di eseguire multiple versioni di questo pacchetto ( o altri con lo stesso nome ).
Tipicamente, queste situazioni accadono quando manutieni svariati progetti Django. In questo caso, la miglior soluzione è usare venv. Questo tool ti permette di mantenere più ambienti Python isolati, ognuno con la propria copia delle librerie ed un namespace proprio.
\n