--- title: "Οδηγός για προχωρημένους: Πως να γράψετε επαναχρησιμοποιήσιμα apps" version: 4.1 locale: el source: https://docs.djangoproject.com/el/4.1/intro/reusable-apps/ canonical: https://djangodocs.dev/el/4.1/intro/reusable-apps/ --- # Οδηγός για προχωρημένους: Πως να γράψετε επαναχρησιμοποιήσιμα apps This advanced tutorial begins where [Tutorial 7](/el/4.1/intro/tutorial07/) left off. We’ll be turning our web-poll into a standalone Python package you can reuse in new projects and share with other people. Αν δεν έχετε ολοκληρώσει πρόσφατα τον Οδηγό του Django (μέρη 1 εως 7), σας ενθαρρύνουμε να ρίξετε μια ματιά (ή ακόμη και να τον ακολουθήσετε πλήρως) ούτως ώστε το project σας να συμβαδίζει με αυτό που θα ακολουθήσει. ## Η επαναχρησιμοποίηση έχει σημασία Απαιτεί πολύ δουλειά για να σχεδιάσετε, χτίσετε, τεστάρετε και διατηρήσετε μια web εφαρμογή (application). Πολλά Python και Django projects μοιράζονται κοινά προβλήματα. Δεν θα ήταν εξαιρετικά αν μπορούσαμε να γλυτώσουμε κάποιο μέρος από αυτή τη ρουτίνα; Reusability is the way of life in Python. [The Python Package Index (PyPI)](https://pypi.org/) has a vast range of packages you can use in your own Python programs. Check out [Django Packages](https://djangopackages.org) for existing reusable apps you could incorporate in your project. Django itself is also a normal 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. Let’s say you were starting a new project that needed a polls app like the one we’ve been working on. How do you make this app reusable? Luckily, you’re well on the way already. In [Tutorial 1](/el/4.1/intro/tutorial01/), we saw how we could decouple polls from the project-level URLconf using an `include`. In this tutorial, we’ll take further steps to make the app easy to use in new projects and ready to publish for others to install and use. > **Package? App?** > > Ο όρος Python [package](https://docs.python.org/3/glossary.html#term-package) παρέχει έναν τρόπο να ομαδοποιούμε Python κώδικα για εύκολη επαναχρησιμοποίηση. Ένα package περιέχει ένα ή περισσότερα αρχεία από Python κώδικα (επίσης γνωστά και ως «modules»). > > Ένα package μπορεί να γίνει imported με τον κώδικα `import foo.bar` ή `from foo import bar`. Για να μετατραπεί ένας φάκελος (όπως ο φάκελος `polls`) σε package, θα πρέπει να περιέχει ένα ειδικό αρχείο με το όνομα `__init__.py`, ακόμη και αν αυτό το αρχείο είναι κενό. > > A Django *application* is a Python package that is specifically intended > for use in a Django project. An application may use common Django > conventions, such as having `models`, `tests`, `urls`, and `views` > submodules. > > Αργότερα χρησιμοποιούμε τον όρο *packaging* για να περιγράψουμε την διαδικασία που χρειάζεται για να δημιουργηθεί ένα Python package. Μπορεί να σας μπερδεύει λιγάκι. Καταλαβαίνουμε! ## Το project σας και η επαναχρησιμοποιήσιμη app Κατόπιν ολοκλήρωσης των προηγούμενων οδηγών, η δομή του project μας θα πρέπει να έχει αυτή τη μορφή: ``` mysite/ manage.py mysite/ __init__.py settings.py urls.py asgi.py wsgi.py polls/ __init__.py admin.py apps.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 ``` Δημιουργήσατε τον φάκελο `mysite/templates` στον [Οδηγό 7](/el/4.1/intro/tutorial07/) και τον φάκελο `polls/templates` στον [Οδηγό 3](/el/4.1/intro/tutorial03/). Τώρα ίσως φαίνεται πιο καθαρά ο λόγος που διαλέξαμε να έχουμε ξεχωριστούς template φακέλους για το project και για το application: οτιδήποτε είναι μέρος της εφαρμογής polls βρίσκεται μέσα στο `polls`. Αυτό κάνει την εφαρμογή ανεξάρτητη και ευκολότερη να ενσωματωθεί μέσα σε ένα καινούργιο project. Ο φάκελο `polls` μπορεί εύκολα να αντιγραφεί σε ένα καινούργιο Django project και αμέσως να επαναχρησιμοποιηθεί. Δεν είναι, όμως, ακόμη έτοιμο να διανεμηθεί (εκδοθεί). Γι’ αυτό θα πρέπει να μετατρέψουμε την εφαρμογή μας σε ένα package για να διευκολύνουμε τους άλλους που θα την εγκαταστήσουν. ## Εγκαθιστώντας μερικά προαπαιτούμενα Η παρούσα κατάσταση του Python packaging είναι λιγάκι συγκεχυμένη με διάφορα εργαλεία. Για αυτό τον οδηγό, θα χρησιμοποιήσουμε το εργαλείο [setuptools](https://pypi.org/project/setuptools/) για να χτίσουμε το package (πακέτο) μας. Είναι το προτεινόμενο εργαλείο για packaging (το οποίο έχει γίνει merged με το fork του `distribute`). Θα χρησιμοποιήσουμε, επίσης, το [pip](https://pypi.org/project/pip/) για να το εγκαταστήσουμε και να το απεγκαταστήσουμε. Θα χρειαστεί να εγκαταστήσετε τα δύο αυτά πακέτα τώρα. Αν χρειάζεστε βοήθεια, μπορείτε να ανατρέξετε στο [πως να εγκαταστήσω το Django με το pip](/el/4.1/topics/install/#installing-official-release). Μπορείτε να εγκαταστήσετε το πακέτο `setuptools` με τον ίδιο τρόπο. ## Πακετάροντας το app σας Το Python *packaging* αναφέρεται στην προετοιμασία του app σε μια συγκεκριμένη μορφή ούτως ώστε να μπορεί να εγκατασταθεί και να χρησιμοποιηθεί εύκολα. Το Django από μόνο του έχει πακεταριστεί με παρόμοιο τρόπο. Για μικρά apps όπως το polls, αυτή η διαδικασία δεν είναι δύσκολη. 1. Αρχικά, δημιουργήστε ένα φάκελο για την εφαρμογή `polls`, έξω από το Django project σας. Δώστε του όνομα `django-polls`. > **Επιλέγοντας ένα όνομα για την εφαρμογή σας** > > Όταν διαλέγετε ένα όνομα για την εφαρμογή σας, ελέγξτε πρώτα μέσω του PyPI για τυχόν ήδη πιασμένα ονόματα άλλων εφαρμογών. Συχνά, είναι χρήσιμο να χρησιμοποιείται τη λέξη `django-` πριν το όνομα της εφαρμογής σας που πρόκειται να διανείμετε. Αυτό βοηθάει τους άλλους όταν κοιτάζουν συγκεκριμένα για Django apps προκειμένου να αναγνωρίσουν την εφαρμογή σας ως django-specific. > > Τα application labels (δηλαδή, η τελευταία λέξη των application packages στη διαδρομή με τις τελείες) *πρέπει* να είναι μοναδικό στη ρύθμιση [`INSTALLED_APPS`](/el/4.1/ref/settings/#std-setting-INSTALLED_APPS). Αποφύγετε να χρησιμοποιείτε το ίδιο label με οποιοδήποτε από αυτά των Django [contrib packages](/el/4.1/ref/contrib/), όπως για παράδειγμα `auth`, `admin` ή `messages`. 2. Μετακινήστε τον φάκελο `polls` μέσα στον φάκελο `django-polls`. 3. Δημιουργήστε ένα αρχείο `django-polls/README.rst` με το ακόλουθο περιεχόμενο: *`django-polls/README.rst`* ```rst ===== Polls ===== Polls is a 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:: path('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. Δημιουργήστε ένα αρχείο `django-polls/LICENSE`. Η επιλογή μιας άδειας (license) είναι πέρα από τους σκοπούς αυτού του οδηγού, αλλά αρκεί να πούμε ότι κώδικας που έχει δημοσιευτεί χωρίς άδεια είναι *άχρηστος*. Το Django και πολλά άλλα συμβατα με το Django apps είναι διανεμημένα κάτω από την BSD άδεια. Ωστόσο, είστε ελεύθεροι να διαλέξετε μια της αρέσκειας σας. Κρατήστε στο μυαλό σας, όμως, ότι η επιλογή της αδείας επηρεάζει το ποιος θα μπορεί να χρησιμοποιήσει τον κώδικα σας. 5. Next we’ll create `pyproject.toml`, `setup.cfg`, and `setup.py` files which detail how to build and install the app. A full explanation of these files is beyond the scope of this tutorial, but the [setuptools documentation](https://setuptools.pypa.io/en/latest/) has a good explanation. Create the `django-polls/pyproject.toml`, `django-polls/setup.cfg`, and `django-polls/setup.py` files with the following contents: *`django-polls/pyproject.toml`* ```toml [build-system] requires = ['setuptools>=40.8.0', 'wheel'] build-backend = 'setuptools.build_meta:__legacy__' ``` *`django-polls/setup.cfg`* ```ini [metadata] name = django-polls version = 0.1 description = A Django app to conduct web-based polls. long_description = file: README.rst url = https://www.example.com/ author = Your Name author_email = yourname@example.com license = BSD-3-Clause # Example license classifiers = Environment :: Web Environment Framework :: Django Framework :: Django :: X.Y # Replace "X.Y" as appropriate Intended Audience :: Developers License :: OSI Approved :: BSD License Operating System :: OS Independent Programming Language :: Python Programming Language :: Python :: 3 Programming Language :: Python :: 3 :: Only Programming Language :: Python :: 3.8 Programming Language :: Python :: 3.9 Topic :: Internet :: WWW/HTTP Topic :: Internet :: WWW/HTTP :: Dynamic Content [options] include_package_data = true packages = find: python_requires = >=3.8 install_requires = Django >= X.Y # Replace "X.Y" as appropriate ``` *`django-polls/setup.py`* ```python from setuptools import setup setup() ``` 6. Only Python modules and packages are included in the package by default. To include additional files, we’ll need to create a `MANIFEST.in` file. The setuptools docs referred to in the previous step discuss this file in more detail. To include the templates, the `README.rst` and our `LICENSE` file, create a file `django-polls/MANIFEST.in` with the following contents: *`django-polls/MANIFEST.in`* ```text include LICENSE include README.rst recursive-include polls/static * recursive-include polls/templates * ``` 7. Προτείνεται, παρόλο που είναι προαιρετικό, να συμπεριλάβετε ένα λεπτομερές εγχειρίδιο (documentation) με την εφαρμογή σας. Δημιουργήστε ένα κενό φάκελο `django-polls/docs` για μελλοντική προσθήκη του εγχειριδίου. Προσθέστε την ακόλουθη πρόσθετη γραμμή στο αρχείο `django-polls/MANIFEST.in`: ``` recursive-include docs * ``` Σημειώστε ότι ο φάκελος `docs` δεν θα συμπεριληφθεί στο package σας εκτός και αν προσθέσετε μερικά αρχεία μέσα. Σε περίπτωση που δεν το γνωρίζατε, πολλά Django apps παρέχουν το δικό τους documentation και online μέσα από ιστοσελίδες όπως η [readthedocs.org](https://readthedocs.org). 8. Προσπαθήστε να χτίσετε το πακέτο σας (build package) με την εντολή `python setup.py sdist` (τρέξτε την μέσα από τον φάκελο `django-polls`). Αυτή η εντολή δημιουργεί έναν φάκελο με το όνομα `dist` και χτίζει το νέο σας πακέτο με το όνομα `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/). ## Χρησιμοποιώντας το δικό σας package Από τη στιγμή που μετακινήσαμε τον φάκελο `polls` έξω από το project, η εφαρμογή μας δεν δουλεύει πλέον, κάτι το οποίο είναι λογικό. Σε αυτή την παράγραφο θα εγκαταστήσουμε την εφαρμογή μας,\`\`django-polls\`\`, σαν ένα (τρίτο) πακέτο. > **Εγκατάσταση ως βιβλιοθήκη χρήστη (user library)** > > Τα ακόλουθα βήματα εγκαθιστούν το πακέτο `django-polls` ως μια βιβλιοθήκη χρήστη. Αυτό σημαίνει ότι το πακέτο θα εγκατασταθεί στον υπολογιστή για τον συγκεκριμένο χρήστη και όχι γενικά (global) για όλους τους χρήστες του συστήματος. Αυτή η εγκατάσταση έχει πολλά πλεονεκτήματα έναντι της γενικής (global) διότι μπορεί η εφαρμογή να χρησιμοποιηθεί σε συστήματα όπου δεν υπάρχουν δικαιώματα διαχειριστή ή να αποτρέψει την πρόσβαση στην εφαρμογή από άλλους χρήστες ή άλλες υπηρεσίες του συστήματος. > > Note that per-user installations can still affect the behavior of system > tools that run as that user, so using a virtual environment is a more robust > solution (see below). 1. Για να εγκαταστήσετε το πακέτο σας, χρησιμοποιήστε το pip (το έχετε :ref:\` ήδη εγκατεστημένο \\`, σωστά?): ``` python -m pip install --user django-polls/dist/django-polls-0.1.tar.gz ``` 2. Με λίγη τύχη, το Django project σας θα λειτουργεί και πάλι όπως πριν. Τρέξτε τον server, ξανά, για να το επιβεβαιώσετε. 3. Για να απεγκαταστήσετε το πακέτο σας, χρησιμοποιήστε, πάλι το pip: ``` python -m pip uninstall django-polls ``` ## Δημοσιεύοντας το app σας Τώρα που έχουμε μετατρέψει σε package και τεστάρει την εφαρμογή `django-polls`, είναι έτοιμη να διαμοιραστεί στον υπόλοιπο κόσμο! Αν αυτό δεν ήταν κάποιο παράδειγμα, θα μπορούσατε να: - Στείλετε με email το package σε κάποιον φίλο. - Να ανεβάσετε το package στην ιστοσελίδα σας. - Post the package on a public repository, such as [the Python Package Index (PyPI)](https://pypi.org/). [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. ## Installing Python packages with a virtual environment Νωρίτερα, εγκαταστήσαμε την εφαρμογή ψηφοφορίας ως μια βιβλιοθήκη χρήστη (user library). Αυτό κρύβει μερικά μειονεκτήματα: - Η αλλαγή των βιβλιοθηκών χρηστών μπορεί να επηρεάσει άλλο Python software μέσα στο σύστημα σας. - Δεν θα είστε σε θέση να τρέξετε πολλαπλές εκδόσεις το ίδιου πακέτου (ή άλλων με το ίδιο όνομα). Typically, these situations only arise once you’re maintaining several Django projects. When they do, the best solution is to use [venv](https://docs.python.org/3/tutorial/venv.html). This tool allows you to maintain multiple isolated Python environments, each with its own copy of the libraries and package namespace.