===================================== Writing your first Django app, part 2 ===================================== This tutorial begins where :doc:`Tutorial 1 ` left off. We're continuing the Web-poll application and will focus on Django's automatically-generated admin site. .. admonition:: Philosophy Generating admin sites for your staff or clients to add, change and delete content is tedious work that doesn't require much creativity. For that reason, Django entirely automates creation of admin interfaces for models. Django was written in a newsroom environment, with a very clear separation between "content publishers" and the "public" site. Site managers use the system to add news stories, events, sports scores, etc., and that content is displayed on the public site. Django solves the problem of creating a unified interface for site administrators to edit content. The admin isn't intended to be used by site visitors. It's for site managers. Creating an admin user ====================== First we'll need to create a user who can login to the admin site. Run the following command: .. code-block:: bash $ python manage.py createsuperuser Enter your desired username and press enter. .. code-block:: text Username: admin You will then be prompted for your desired email address: .. code-block:: text Email address: admin@example.com The final step is to enter your password. You will be asked to enter your password twice, the second time as a confirmation of the first. .. code-block:: text Password: ********** Password (again): ********* Superuser created successfully. Start the development server ============================ The Django admin site is activated by default. Let's start the development server and explore it. Recall from Tutorial 1 that you start the development server like so: .. code-block:: bash $ python manage.py runserver Now, open a Web browser and go to "/admin/" on your local domain -- e.g., http://127.0.0.1:8000/admin/. You should see the admin's login screen: .. image:: _images/admin01.png :alt: Django admin login screen Since :doc:`translation ` is turned on by default, the login screen may be displayed in your own language, depending on your browser's settings and on whether Django has a translation for this language. .. admonition:: Doesn't match what you see? If at this point, instead of the above login page, you get an error page reporting something like:: ImportError at /admin/ cannot import name patterns ... then you're probably using a version of Django that doesn't match this tutorial version. You'll want to either switch to the older tutorial or the newer Django version. Enter the admin site ==================== Now, try logging in with the superuser account you created in the previous step. You should see the Django admin index page: .. image:: _images/admin02.png :alt: Django admin index page You should see a few types of editable content: groups and users. They are provided by :mod:`django.contrib.auth`, the authentication framework shipped by Django. Make the poll app modifiable in the admin ========================================= But where's our poll app? It's not displayed on the admin index page. Just one thing to do: we need to tell the admin that ``Question`` objects have an admin interface. To do this, open the :file:`polls/admin.py` file, and edit it to look like this: .. snippet:: :filename: polls/admin.py from django.contrib import admin from polls.models import Question admin.site.register(Question) Explore the free admin functionality ==================================== Now that we've registered ``Question``, Django knows that it should be displayed on the admin index page: .. image:: _images/admin03t.png :alt: Django admin index page, now with polls displayed Click "Questions". Now you're at the "change list" page for questions. This page displays all the question in the database and lets you choose one to change it. There's the "What's up?" question we created in the first tutorial: .. image:: _images/admin04t.png :alt: Polls change list page Click the "What's up?" question to edit it: .. image:: _images/admin05t.png :alt: Editing form for question object Things to note here: * The form is automatically generated from the ``Question`` model. * The different model field types (:class:`~django.db.models.DateTimeField`, :class:`~django.db.models.CharField`) correspond to the appropriate HTML input widget. Each type of field knows how to display itself in the Django admin. * Each :class:`~django.db.models.DateTimeField` gets free JavaScript shortcuts. Dates get a "Today" shortcut and calendar popup, and times get a "Now" shortcut and a convenient popup that lists commonly entered times. The bottom part of the page gives you a couple of options: * Save -- Saves changes and returns to the change-list page for this type of object. * Save and continue editing -- Saves changes and reloads the admin page for this object. * Save and add another -- Saves changes and loads a new, blank form for this type of object. * Delete -- Displays a delete confirmation page. If the value of "Date published" doesn't match the time when you created the question in Tutorial 1, it probably means you forgot to set the correct value for the :setting:`TIME_ZONE` setting. Change it, reload the page and check that the correct value appears. Change the "Date published" by clicking the "Today" and "Now" shortcuts. Then click "Save and continue editing." Then click "History" in the upper right. You'll see a page listing all changes made to this object via the Django admin, with the timestamp and username of the person who made the change: .. image:: _images/admin06t.png :alt: History page for question object Customize the admin form ======================== Take a few minutes to marvel at all the code you didn't have to write. By registering the ``Question`` model with ``admin.site.register(Question)``, Django was able to construct a default form representation. Often, you'll want to customize how the admin form looks and works. You'll do this by telling Django the options you want when you register the object. Let's see how this works by re-ordering the fields on the edit form. Replace the ``admin.site.register(Question)`` line with: .. snippet:: :filename: polls/admin.py from django.contrib import admin from polls.models import Question class QuestionAdmin(admin.ModelAdmin): fields = ['pub_date', 'question_text'] admin.site.register(Question, QuestionAdmin) You'll follow this pattern -- create a model admin object, then pass it as the second argument to ``admin.site.register()`` -- any time you need to change the admin options for an object. This particular change above makes the "Publication date" come before the "Question" field: .. image:: _images/admin07.png :alt: Fields have been reordered This isn't impressive with only two fields, but for admin forms with dozens of fields, choosing an intuitive order is an important usability detail. And speaking of forms with dozens of fields, you might want to split the form up into fieldsets: .. snippet:: :filename: polls/admin.py from django.contrib import admin from polls.models import Question class QuestionAdmin(admin.ModelAdmin): fieldsets = [ (None, {'fields': ['question_text']}), ('Date information', {'fields': ['pub_date']}), ] admin.site.register(Question, QuestionAdmin) The first element of each tuple in :attr:`~django.contrib.admin.ModelAdmin.fieldsets` is the title of the fieldset. Here's what our form looks like now: .. image:: _images/admin08t.png :alt: Form has fieldsets now You can assign arbitrary HTML classes to each fieldset. Django provides a ``"collapse"`` class that displays a particular fieldset initially collapsed. This is useful when you have a long form that contains a number of fields that aren't commonly used: .. snippet:: :filename: polls/admin.py from django.contrib import admin from polls.models import Question class QuestionAdmin(admin.ModelAdmin): fieldsets = [ (None, {'fields': ['question_text']}), ('Date information', {'fields': ['pub_date'], 'classes': ['collapse']}), ] .. image:: _images/admin09.png :alt: Fieldset is initially collapsed Adding related objects ====================== OK, we have our Question admin page. But a ``Question`` has multiple ``Choices``, and the admin page doesn't display choices. Yet. There are two ways to solve this problem. The first is to register ``Choice`` with the admin just as we did with ``Question``. That's easy: .. snippet:: :filename: polls/admin.py from django.contrib import admin from polls.models import Choice, Question # ... admin.site.register(Choice) Now "Choices" is an available option in the Django admin. The "Add choice" form looks like this: .. image:: _images/admin10.png :alt: Choice admin page In that form, the "Question" field is a select box containing every question in the database. Django knows that a :class:`~django.db.models.ForeignKey` should be represented in the admin as a ``