Ten tutorial dla zaawansowanych zaczyna się, gdzie Tutorial 8 się skończył. Będziemy przerabiać naszą web-ankietę na samodzielny pakiet Pythona, który będziesz mógł wykorzystać w nowym projekcie i którym będziesz mógł podzielić się z innymi.
\nJeśli nie ukończyłeś niedawno Tutoriali 1–7, zachęcamy cię do powtórzenia ich, aby twój przykładowy projekt pasował do tego opisanego poniżej.
\nZaprojektować, zbudować, przetestować i utrzymywać aplikację webową to bardzo dużo pracy. Wiele projektów w Pythonie i Django napotyka wspólne problemy. Czy nie byłoby super, jeśli moglibyśmy oszczędzić części tej powtarzanej pracy?
\nPonowne wykorzystanie to sposób na życie w Pythonie. Python Package Index (PyPI) zawiera obszerny zakres pakietów, które możesz wykorzystać w swoich własnych pythonowych programach. Sprawdź w Django Packages istniejące aplikacje gotowe do wykorzystania, które mógłbyś wcielić w swój projekt. Samo Django także jest normalnym pythonowym pakietem. To znaczy, że możesz wziąć istniejące pakiety Pythona lub aplikacje Django i złożyć z nich swój własny projekt webowy. Musisz jedynie napisać części, które uczynią twój projekt unikalnym.
\nPowiedzmy, że zaczynałeś nowy projekt, który potrzebował aplikacji z ankietą, takiej jak ta, nad którą pracowaliśmy. Jak uczynić tą aplikację gotową do wykorzystania przez innych? Na szczęście, jesteśmy już na dobrej drodze. W Tutorialu 1 widzieliśmy jak możemy wydzielić ankiety z URLconfa na poziomie projektu przez użycie include. W tym tutorialu poczynimy dalsze kroki, aby uczynić aplikację łatwą do użycia w nowych projektach i gotową do publikacji, aby inni mogli ją zainstalować i używać.
Po poprzednich tutorialach, nasz projekt powinien wyglądać tak:
\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\nStworzyłeś mysite/templates w Tutorialu 7 i polls/templates w Tutorialu 3. Teraz prawdopodobnie jest jaśniejsze dlaczego postanowiliśmy mieć osobne katalogi szablonów dla projektu i aplikacji: wszystko, co jest częścią aplikacji ankietowej jest w polls. To powoduje, że aplikacja jest w jednym kawałku i prościej ją wrzucić w nowy projekt.
Katalog polls mógłby być teraz skopiowany do nowego projektu Django i od razu użyty. Ale nie jest zupełnie gotowy do bycia opublikowanym. Na tę potrzebę, musimy spakować naszą aplikację, aby ułatwić innym jej instalację.
Bieżący stan pakietowania w Pythonie jest nieco zagmatwany przez wiele narzędzi. Na potrzeby tego tutorialu, użyjemy setuptools, aby zbudować nasz pakiet. Są one zalecanym narzędziem pakietowania (zmergowane z forkiem distribute). Będziemy też używać pip, aby go zainstalować i odinstalować. Powinieneś teraz zainstalować te dwa pakiety. Jeśli potrzebujesz pomocy, możesz zajrzeć do jak zainstalować Django używając pipa. W ten sam sposób możesz zainstalować setuptools.
Pythonowe pakietowanie oznacza przygotowane twojej aplikacji w określonym formacie, który będzie mógł być prosto zainstalowany i użyty. Samo Django jest zapakowane właśnie w ten sposób. Dla małej aplikacji jak ankiety, ten proces nie jest zbyt skomplikowany.
\nNajpierw stwórz katalog nadrzędny dla polls, poza swoim projektem Django. Nazwij ten katalog django-polls.
Przenieś katalog polls do katalogu django-polls.
Stwórz plik django-polls/README.rst o następującej treści:
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.\nStwórz plik django-polls/LICENSE. Wybór licencji jest poza zakresem tego tutorialu, ale wystarczy powiedzieć, że kod wydany publicznie bez licencji jest bezużyteczny. Django i wiele kompatybilnych z Django aplikacji są rozpowszechniane na licencji BSD, aczkolwiek ty możesz wybrać swoją własną licencję. Bądź tylko świadom, że wybór licencji będzie miał wpływ na to, kto może używać twój kod.
Next we’ll create the pyproject.toml file which details how to build and\ninstall the app. A full explanation of this file is beyond the scope of this\ntutorial, but the Python Packaging User Guide has a good\nexplanation. Create the django-polls/pyproject.toml file with the\nfollowing contents:
django-polls/pyproject.toml[build-system]\nrequires = ["setuptools>=69.3"]\nbuild-backend = "setuptools.build_meta"\n\n[project]\nname = "django-polls"\nversion = "0.1"\ndependencies = [\n "django>=X.Y", # Replace "X.Y" as appropriate\n]\ndescription = "A Django app to conduct web-based polls."\nreadme = "README.rst"\nrequires-python = ">= 3.8"\nauthors = [\n {name = "Your Name", email = "yourname@example.com"},\n]\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.8",\n "Programming Language :: Python :: 3.9",\n "Programming Language :: Python :: 3.10",\n "Programming Language :: Python :: 3.11",\n "Programming Language :: Python :: 3.12",\n "Topic :: Internet :: WWW/HTTP",\n "Topic :: Internet :: WWW/HTTP :: Dynamic Content",\n]\n\n[project.urls]\nHomepage = "https://www.example.com/"\nMany common files and Python modules and packages are included in the\npackage by default. To include additional files, we’ll need to create a\nMANIFEST.in file. To include the templates and static files, create a\nfile django-polls/MANIFEST.in with the following contents:
django-polls/MANIFEST.inrecursive-include polls/static *\nrecursive-include polls/templates *\nIt’s optional, but recommended, to include detailed documentation with your\napp. Create an empty directory django-polls/docs for future\ndocumentation.
Zwróć uwagę, że katalog docs nie zostanie zawarty w twoim pakiecie dopóki nie dodasz do niego jakichś plików. Wiele aplikacji Django dostarcza swoją dokumentację online przez strony takie jak readthedocs.org.
Check that the build package is installed (python -m pip install\nbuild) and try building your package by running python -m build inside\ndjango-polls. This creates a directory called dist and builds your\nnew package into source and binary formats, django_polls-0.1.tar.gz and\ndjango_polls-0.1-py3-none-any.whl.
Aby dowiedzieć się więcej na temat pakowania, zobacz tutorial Packaging Python Projects.
\nOdkąd przenieśliśmy katalog polls poza projekt, nie działa. Naprawimy to teraz instalując nasz nowy pakiet django-polls.
Aby zainstalować pakiet, użyj pipa (już go zainstalowałeś, prawda?):
\npython -m pip install --user django-polls/dist/django_polls-0.1.tar.gz\nZ odrobiną szczęścia, twój projekt Django powinien teraz działać znów poprawnie. Uruchom serwer ponownie, aby to potwierdzić.
Aby odinstalować pakiet, użyj pipa:
\npython -m pip uninstall django-polls\nTeraz, kiedy już spakowaliśmy i przetestowaliśmy django-polls, są gotowe do podzielenia się ze światem! Gdyby to nie był tylko przykład, mógłbyś teraz:
Wyślij e-mail z pakietem do znajomego.
Załaduj pakiet na swoją stronę.
Opublikuj pakiet w publicznym repozytorium, takim jak Python Package Index (PyPI). packaging.python.org ma dobry tutorial na ten temat.
Wcześniej zainstalowaliśmy aplikację ankietową jako bibliotekę użytkownika. Ma to pewne wady:
\nModyfikowanie bibliotek użytkownika może wpłynąć na inne oprogramowanie Python w twoim systemie.
Nie będziesz w stanie uruchamiać wielu wersji tego pakietu (lub innych o takiej samej nazwie).
Zazwyczaj takie sytuacje zdarzają się tylko kiedy utrzymujesz kilka projektów Django. W takiej sytuacji najlepszym rozwiązaniem jest venv <python:tutorial/venv>. To narzędzie pozwala utrzymywać wiele izolowanych środowisk Pythona, każdy ze swoimi własnymi kopiami bibliotek i przestrzeniami nazw dla pakietów.
\n