--- title: "Zaawansowany tutorial: Jak pisać aplikacje wielokrotnego użytku" version: 1.11 locale: pl source: https://docs.djangoproject.com/pl/1.11/intro/reusable-apps/ canonical: https://djangodocs.dev/pl/1.11/intro/reusable-apps/ --- # Zaawansowany tutorial: Jak pisać aplikacje wielokrotnego użytku Ten tutorial dla zaawansowanych zaczyna się, gdzie [Tutorial 7](/pl/1.11/intro/tutorial07/) 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. Jeś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. ## Możliwość ponownego użycia ma znaczenie Zaprojektować, 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? Ponowne wykorzystanie to sposób na życie w Pythonie. [Python Package Index (PyPI)](https://pypi.python.org/pypi) zawiera obszerny zakres pakietów, które możesz wykorzystać w swoich własnych pythonowych programach. Sprawdź w [Django Packages](https://djangopackages.org) istniejące aplikacje gotowe do wykorzystania, które mógłbyś wcielić w swój projekt. Samo Django także jest tylko 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. Powiedzmy, ż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 3](/pl/1.11/intro/tutorial03/) 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ć. > **Pakiet? Aplikacja?** > > Pythonowy [package](https://docs.python.org/3/glossary.html#term-package) jest sposobem na zgrupowanie związanego kodu Pythona na potrzeby łatwego ponownego użycia. Pakiet zawiera jeden lub więcej plików z kodem Pythona (znane także jako „moduły”). > > Pakiet można zaimportować przez `import foo.bar` lub `from foo import bar`. Aby katalog (jak `polls`) stał się pakietem, musi zawierać specjalny plik `__init__.py`, który może być pusty. > > *Aplikacja* Django jest tylko pakietem Pythona, który jest szczególnie przeznaczony do użycia w projekcie Django. Aplikacja może używać powszechnych w Django konwencji, jak posiadanie podmodułów `models`, `tests`, `urls` i `views`. > > Dalej będziemy używać pojęcia *pakietowanie*, aby opisać proces robienia pakietu Pythona łatwego do instalacji dla innych. Mamy świadomość, że może to być nieco mylące. ## Twój projekt i twoja aplikacja do ponownego wykorzystania Po poprzednich tutorialach, nasz projekt powinien wyglądać tak: ``` 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 ``` Stworzyłeś `mysite/templates` w [Tutorialu 7](/pl/1.11/intro/tutorial07/) i `polls/templates` w [Tutorialu 3](/pl/1.11/intro/tutorial03/). 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ę. ## Instalowanie narzędzi Bieżący stan pakietowania w Pythonie jest nieco zagmatwany przez wiele narzędzi. Na potrzeby tego tutorialu, użyjemy [setuptools](https://pypi.python.org/pypi/setuptools), aby zbudować nasz pakiet. Są one zalecanym narzędziem pakietowania (zmergowane z forkiem `distribute`). Będziemy też używać [pipa](https://pypi.python.org/pypi/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](/pl/1.11/topics/install/#installing-official-release). W ten sam sposób możesz zainstalować `setuptools`. ## Pakowanie twojej aplikacji 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. 1. Najpierw stwórz katalog nadrzędny dla `polls`, poza swoim projektem Django. Nazwij ten katalog `django-polls`. > **Wybór nazwy dla twojej aplikacji** > > Wybierają nazwę dla swojego pakietu, sprawdź miejsca takie jak PyPI, aby uniknąć konfliktu nazw z istniejącymi pakietami. Często przydaje się dodać `django-` to nazwy twojego modułu tworząc pakiet do dystrybucji. To pomaga innym szukającym aplikacje Django rozróżnić twoją aplikację jako djangową. > > Etykiety aplikacji (czyli ostatnia część kropkowanej ścieżki do pakietów aplikacji) *musi* być unikalna w [`INSTALLED_APPS`](/pl/1.11/ref/settings/#std-setting-INSTALLED_APPS). Unikaj używania takich samych etykiet jak którykolwiek z [pakietów contrib](/pl/1.11/ref/contrib/), na przykład `auth`, `admin` lub `messages`. 2. Przenieś katalog `polls` do katalogu `django-polls`. 3. Stwórz plik `django-polls/README.rst` o następującej treści: *django-polls/README.rst* ``` ===== 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. Stwó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. 5. Następnie stworzymy plik `setup.py`, który zawiera szczegóły jak zbudować i zainstalować aplikację. Pełne wytłumaczenie tego pliku nie należy do tego tutorialu, ale [dokumentacja setuptools](https://setuptools.readthedocs.io/en/latest/) ma dobre tłumaczenie. Stwórz plik `django-polls/setup.py` z następującą treścią: *django-polls/setup.py* ``` 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. Domyślnie tylko pythonowe moduły i pakiety zawierają się w pakiecie. Aby zawrzeć dodatkowe pliki, musimy stworzyć plik `MANIFEST.in`. Dokumentacja setuptools, do której odsyłaliśmy w poprzednim punkcie opisuje ten plik w szczegółach. Aby zawrzeć szablony, pliki `README.rst` i `LICENSE`, stwórz plik `django-polls/MANIFEST.in` o następującej treści: *django-polls/MANIFEST.in* ``` include LICENSE include README.rst recursive-include polls/static * recursive-include polls/templates * ``` 7. Opcjonalne, ale zalecane, jest zawarcie szczegółowej dokumentacji w twojej aplikacji. Stwórz pusty katalog `django-polls/docs` na przyszłą dokumentację. Dodaj nową linię w `django-polls/MANIFEST.in`: ``` recursive-include docs * ``` 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](https://readthedocs.org). 8. Spróbuj zbudować swój pakiet używając `python setup.py sdist` (uruchom z wnętrza `django-polls`). Stworzy to katalog o nazwie `dist` i zbuduje twój nowy pakiet, `django-polls-0.1.tar.gz`. For more information on packaging, see Python’s [Tutorial on Packaging and Distributing Projects](https://packaging.python.org/tutorials/packaging-projects/). ## Używanie twojego własnego pakietu Odkąd przenieśliśmy katalog `polls` poza projekt, nie działa. Naprawimy to teraz instalując nasz nowy pakiet `django-polls`. > **Instalowanie jako bibliotekę użytkownika** > > Poniższe kroki zainstalują `django-polls` jako bibliotekę użytkownika. Instalacja bibliotek per użytkownik posiada sporo zalet w porównaniu do instalacji paczek per system jak np. możliwość instalacji bibliotek w systemie, w którym nie posiadasz uprawnień administracyjnych oraz zapobieganie wpływu biblioteki na system i innych jego użytkowników. > > Pamiętaj, że instalacja per użytkownik nadal może wpłynąć na narzędzia systemowe uruchamiane przez tego samego użytkownika, więc `virtualenv` jest bardziej niezawodnym rozwiązaniem (patrz niżej). 1. Aby zainstalować pakiet, użyj pipa (już [go zainstalowałeś](#installing-reusable-apps-prerequisites), prawda?): ``` pip install --user django-polls/dist/django-polls-0.1.tar.gz ``` 2. Z odrobiną szczęścia, twój projekt Django powinien teraz działać znów poprawnie. Uruchom serwer ponownie, aby to potwierdzić. 3. Aby odinstalować pakiet, użyj pipa: ``` pip uninstall django-polls ``` ## Publikowanie twojej aplikacji Teraz, 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ę. - Post the package on a public repository, such as [the Python Package Index (PyPI)](#the-python-package-index-pypi). [packaging.python.org](https://packaging.python.org) has [a good tutorial](https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives) for doing this. ## Instalowanie pakietów Pythona z virtualenvem Wcześniej zainstalowaliśmy aplikację ankietową jako bibliotekę użytkownika. Ma to pewne wady: - Modyfikowanie 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 [virtualenv](https://virtualenv.pypa.io/). To narzędzie pozwala utrzymywać wiele izolowanych środowisk Pythona, każdy ze swoimi własnymi kopiami bibliotek i przestrzeniami nazw dla pakietów.