diff options
Diffstat (limited to 'docs/intro')
| -rw-r--r-- | docs/intro/_images/admin02.png | bin | 64260 -> 32850 bytes | |||
| -rw-r--r-- | docs/intro/_images/admin02t.png | bin | 24726 -> 16401 bytes | |||
| -rw-r--r-- | docs/intro/_images/admin03.png | bin | 75434 -> 40583 bytes | |||
| -rw-r--r-- | docs/intro/_images/admin03t.png | bin | 28131 -> 19722 bytes | |||
| -rw-r--r-- | docs/intro/reusable-apps.txt | 2 | ||||
| -rw-r--r-- | docs/intro/tutorial01.txt | 110 | ||||
| -rw-r--r-- | docs/intro/tutorial02.txt | 99 | ||||
| -rw-r--r-- | docs/intro/tutorial05.txt | 3 |
8 files changed, 85 insertions, 129 deletions
diff --git a/docs/intro/_images/admin02.png b/docs/intro/_images/admin02.png Binary files differindex 4b49ebb490..b9810ab7ba 100644 --- a/docs/intro/_images/admin02.png +++ b/docs/intro/_images/admin02.png diff --git a/docs/intro/_images/admin02t.png b/docs/intro/_images/admin02t.png Binary files differindex d7519d19ab..c0c6a56928 100644 --- a/docs/intro/_images/admin02t.png +++ b/docs/intro/_images/admin02t.png diff --git a/docs/intro/_images/admin03.png b/docs/intro/_images/admin03.png Binary files differindex 635226c61c..5cf567d5ce 100644 --- a/docs/intro/_images/admin03.png +++ b/docs/intro/_images/admin03.png diff --git a/docs/intro/_images/admin03t.png b/docs/intro/_images/admin03t.png Binary files differindex 94273cb583..ad15ea60cd 100644 --- a/docs/intro/_images/admin03t.png +++ b/docs/intro/_images/admin03t.png diff --git a/docs/intro/reusable-apps.txt b/docs/intro/reusable-apps.txt index 6aade4997e..99fb62e4d7 100644 --- a/docs/intro/reusable-apps.txt +++ b/docs/intro/reusable-apps.txt @@ -63,8 +63,8 @@ After the previous tutorials, our project should look like this:: urls.py wsgi.py polls/ - admin.py __init__.py + admin.py models.py tests.py urls.py diff --git a/docs/intro/tutorial01.txt b/docs/intro/tutorial01.txt index a73db714f4..56a068ff1f 100644 --- a/docs/intro/tutorial01.txt +++ b/docs/intro/tutorial01.txt @@ -182,40 +182,40 @@ Database setup -------------- Now, edit :file:`mysite/settings.py`. It's a normal Python module with -module-level variables representing Django settings. Change the -following keys in the :setting:`DATABASES` ``'default'`` item to match -your database connection settings. +module-level variables representing Django settings. + +By default, the configuration uses SQLite. If you're new to databases, or +you're just interested in trying Django, this is the easiest choice. SQLite is +included in Python, so you won't need to install anything else to support your +database. + +If you wish to use another database, install the appropriate :ref:`database +bindings <database-installation>`, and change the following keys in the +:setting:`DATABASES` ``'default'`` item to match your database connection +settings: * :setting:`ENGINE <DATABASE-ENGINE>` -- Either + ``'django.db.backends.sqlite3'``, ``'django.db.backends.postgresql_psycopg2'``, - ``'django.db.backends.mysql'``, ``'django.db.backends.sqlite3'`` or + ``'django.db.backends.mysql'``, or ``'django.db.backends.oracle'``. Other backends are :setting:`also available <DATABASE-ENGINE>`. -* :setting:`NAME` -- The name of your database. If you're using - SQLite, the database will be a file on your computer; in that - case, :setting:`NAME` should be the full absolute path, - including filename, of that file. If the file doesn't exist, it - will automatically be created when you synchronize the database - for the first time (see below). - - When specifying the path, always use forward slashes, even on - Windows (e.g. ``C:/homes/user/mysite/sqlite3.db``). +* :setting:`NAME` -- The name of your database. If you're using SQLite, the + database will be a file on your computer; in that case, :setting:`NAME` + should be the full absolute path, including filename, of that file. When + specifying the path, always use forward slashes, even on Windows (e.g. + ``C:/homes/user/mysite/sqlite3.db``). * :setting:`USER` -- Your database username (not used for SQLite). -* :setting:`PASSWORD` -- Your database password (not used for - SQLite). +* :setting:`PASSWORD` -- Your database password (not used for SQLite). -* :setting:`HOST` -- The host your database is on. Leave this as - an empty string (or possibly ``127.0.0.1``) if your database server is on the - same physical machine (not used for SQLite). See :setting:`HOST` for details. +* :setting:`HOST` -- The host your database is on (not used for SQLite). + Leave this as an empty string (or possibly ``127.0.0.1``) if your + database server is on the same physical machine . -If you're new to databases, we recommend simply using SQLite by setting -:setting:`ENGINE <DATABASE-ENGINE>` to ``'django.db.backends.sqlite3'`` and -:setting:`NAME` to the place where you'd like to store the database. SQLite is -included in Python, so you won't need to install anything else to support your -database. +For more details, see the reference documentation for :setting:`DATABASES`. .. note:: @@ -226,17 +226,20 @@ database. If you're using SQLite, you don't need to create anything beforehand - the database file will be created automatically when it is needed. -While you're editing :file:`settings.py`, set :setting:`TIME_ZONE` to your -time zone. The default value is the Central time zone in the U.S. (Chicago). +While you're editing :file:`mysite/settings.py`, set :setting:`TIME_ZONE` to +your time zone. -Also, note the :setting:`INSTALLED_APPS` setting toward the bottom of -the file. That holds the names of all Django applications that are -activated in this Django instance. Apps can be used in multiple projects, and -you can package and distribute them for use by others in their projects. +Also, note the :setting:`INSTALLED_APPS` setting at the top of the file. That +holds the names of all Django applications that are activated in this Django +instance. Apps can be used in multiple projects, and you can package and +distribute them for use by others in their projects. By default, :setting:`INSTALLED_APPS` contains the following apps, all of which come with Django: +* :mod:`django.contrib.admin` -- The admin site. You'll use it in :doc:`part 2 + of this tutorial </intro/tutorial02>`. + * :mod:`django.contrib.auth` -- An authentication system. * :mod:`django.contrib.contenttypes` -- A framework for content types. @@ -261,11 +264,12 @@ that, run the following command: python manage.py syncdb -The :djadmin:`syncdb` command looks at the :setting:`INSTALLED_APPS` setting and -creates any necessary database tables according to the database settings in your -:file:`settings.py` file. You'll see a message for each database table it -creates, and you'll get a prompt asking you if you'd like to create a superuser -account for the authentication system. Go ahead and do that. +The :djadmin:`syncdb` command looks at the :setting:`INSTALLED_APPS` setting +and creates any necessary database tables according to the database settings +in your :file:`mysqlite/settings.py` file. You'll see a message for each +database table it creates, and you'll get a prompt asking you if you'd like to +create a superuser account for the authentication system. Go ahead and do +that. If you're interested, run the command-line client for your database and type ``\dt`` (PostgreSQL), ``SHOW TABLES;`` (MySQL), or ``.schema`` (SQLite) to @@ -288,10 +292,10 @@ Creating models Now that your environment -- a "project" -- is set up, you're set to start doing work. -Each application you write in Django consists of a Python package, somewhere -on your `Python path`_, that follows a certain convention. Django comes with a -utility that automatically generates the basic directory structure of an app, -so you can focus on writing code rather than creating directories. +Each application you write in Django consists of a Python package that follows +a certain convention. Django comes with a utility that automatically generates +the basic directory structure of an app, so you can focus on writing code +rather than creating directories. .. admonition:: Projects vs. apps @@ -316,6 +320,7 @@ That'll create a directory :file:`polls`, which is laid out like this:: polls/ __init__.py + admin.py models.py tests.py views.py @@ -401,26 +406,21 @@ But first we need to tell our project that the ``polls`` app is installed. you can distribute apps, because they don't have to be tied to a given Django installation. -Edit the :file:`settings.py` file again, and change the -:setting:`INSTALLED_APPS` setting to include the string ``'polls'``. So -it'll look like this:: +Edit the :file:`mysite/settings.py` file again, and change the +:setting:`INSTALLED_APPS` setting to include the string ``'polls'``. So it'll +look like this:: INSTALLED_APPS = ( + 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', - 'django.contrib.sites', 'django.contrib.messages', 'django.contrib.staticfiles', - # Uncomment the next line to enable the admin: - # 'django.contrib.admin', - # Uncomment the next line to enable admin documentation: - # 'django.contrib.admindocs', 'polls', ) -Now Django knows to include the ``polls`` app. Let's run another -command: +Now Django knows to include the ``polls`` app. Let's run another command: .. code-block:: bash @@ -433,13 +433,13 @@ statements for the polls app): BEGIN; CREATE TABLE "polls_poll" ( - "id" serial NOT NULL PRIMARY KEY, + "id" integer NOT NULL PRIMARY KEY, "question" varchar(200) NOT NULL, - "pub_date" timestamp with time zone NOT NULL + "pub_date" datetime NOT NULL ); CREATE TABLE "polls_choice" ( - "id" serial NOT NULL PRIMARY KEY, - "poll_id" integer NOT NULL REFERENCES "polls_poll" ("id") DEFERRABLE INITIALLY DEFERRED, + "id" integer NOT NULL PRIMARY KEY, + "poll_id" integer NOT NULL REFERENCES "polls_poll" ("id"), "choice_text" varchar(200) NOT NULL, "votes" integer NOT NULL ); @@ -447,7 +447,8 @@ statements for the polls app): Note the following: -* The exact output will vary depending on the database you are using. +* The exact output will vary depending on the database you are using. The + example above is generated for SQLite. * Table names are automatically generated by combining the name of the app (``polls``) and the lowercase name of the model -- ``poll`` and @@ -465,8 +466,7 @@ Note the following: types such as ``auto_increment`` (MySQL), ``serial`` (PostgreSQL), or ``integer primary key`` (SQLite) are handled for you automatically. Same goes for quoting of field names -- e.g., using double quotes or single - quotes. The author of this tutorial runs PostgreSQL, so the example - output is in PostgreSQL syntax. + quotes. * The :djadmin:`sql` command doesn't actually run the SQL in your database - it just prints it to the screen so that you can see what SQL Django thinks diff --git a/docs/intro/tutorial02.txt b/docs/intro/tutorial02.txt index 38ad7d88dc..e5350a4d4c 100644 --- a/docs/intro/tutorial02.txt +++ b/docs/intro/tutorial02.txt @@ -21,49 +21,11 @@ automatically-generated admin site. The admin isn't intended to be used by site visitors. It's for site managers. -Activate the admin site -======================= - -The Django admin site is not activated by default -- it's an opt-in thing. To -activate the admin site for your installation, do these three things: - -* Uncomment ``"django.contrib.admin"`` in the :setting:`INSTALLED_APPS` setting. - -* Run ``python manage.py syncdb``. Since you have added a new application - to :setting:`INSTALLED_APPS`, the database tables need to be updated. - -* Edit your ``mysite/urls.py`` file and uncomment the lines that reference - the admin -- there are three lines in total to uncomment. This file is a - URLconf; we'll dig into URLconfs in the next tutorial. For now, all you - need to know is that it maps URL roots to applications. In the end, you - should have a ``urls.py`` file that looks like this: - - .. parsed-literal:: - - from django.conf.urls import patterns, include, url - - # Uncomment the next two lines to enable the admin: - **from django.contrib import admin** - **admin.autodiscover()** - - urlpatterns = patterns('', - # Examples: - # url(r'^$', '{{ project_name }}.views.home', name='home'), - # url(r'^{{ project_name }}/', include('{{ project_name }}.foo.urls')), - - # Uncomment the admin/doc line below to enable admin documentation: - # url(r'^admin/doc/', include('django.contrib.admindocs.urls')), - - # Uncomment the next line to enable the admin: - **url(r'^admin/', include(admin.site.urls)),** - ) - - (The bold lines are the ones that needed to be uncommented.) - Start the development server ============================ -Let's start the development server and explore the admin site. +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: @@ -77,6 +39,10 @@ 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 </topics/i18n/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 @@ -93,24 +59,26 @@ http://127.0.0.1:8000/admin/. You should see the admin's login screen: Enter the admin site ==================== -Now, try logging in. (You created a superuser account in the first part of this +Now, try logging in. You created a superuser account in the first part of this tutorial, remember? If you didn't create one or forgot the password you can -:ref:`create another one <topics-auth-creating-superusers>`.) You should see -the Django admin index page: +:ref:`create another one <topics-auth-creating-superusers>`. + +You should see the Django admin index page: .. image:: _images/admin02t.png :alt: Django admin index page -You should see a few types of editable content, including groups, users -and sites. These are core features Django ships with by default. +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 ``Poll`` -objects have an admin interface. To do this, create a file called +Just one thing to do: we need to tell the admin that ``Poll`` +objects have an admin interface. To do this, open the file called ``admin.py`` in your ``polls`` directory, and edit it to look like this:: from django.contrib import admin @@ -118,10 +86,6 @@ objects have an admin interface. To do this, create a file called admin.site.register(Poll) -You'll need to restart the development server to see your changes. Normally, -the server auto-reloads code every time you modify a file, but the action of -creating a new file doesn't trigger the auto-reloading logic. - Explore the free admin functionality ==================================== @@ -145,7 +109,7 @@ Click the "What's up?" poll to edit it: Things to note here: -* The form is automatically generated from the Poll model. +* The form is automatically generated from the ``Poll`` model. * The different model field types (:class:`~django.db.models.DateTimeField`, :class:`~django.db.models.CharField`) correspond to the appropriate HTML @@ -302,7 +266,7 @@ registration code to read:: This tells Django: "``Choice`` objects are edited on the ``Poll`` admin page. By default, provide enough fields for 3 choices." -Load the "Add poll" page to see how that looks, you may need to restart your development server: +Load the "Add poll" page to see how that looks: .. image:: _images/admin11t.png :alt: Add poll page now has choices on it @@ -435,31 +399,24 @@ That's easy to change, though, using Django's template system. The Django admin is powered by Django itself, and its interfaces use Django's own template system. -Open your settings file (``mysite/settings.py``, remember) and look at the -:setting:`TEMPLATE_DIRS` setting. :setting:`TEMPLATE_DIRS` is a tuple of -filesystem directories to check when loading Django templates. It's a search -path. - Create a ``mytemplates`` directory in your project directory. Templates can live anywhere on your filesystem that Django can access. (Django runs as whatever user your server runs.) However, keeping your templates within the project is a good convention to follow. -By default, :setting:`TEMPLATE_DIRS` is empty. So, let's add a line to it, to -tell Django where our templates live:: +Open your settings file (``mysite/settings.py``, remember) and add a +:setting:`TEMPLATE_DIRS` setting:: - TEMPLATE_DIRS = ( - '/path/to/mysite/mytemplates', # Change this to your own directory. - ) + TEMPLATE_DIRS = (os.path.join(BASE_DIR, 'mytemplates'),) + +Don't forget the trailing comma. :setting:`TEMPLATE_DIRS` is a tuple of +filesystem directories to check when loading Django templates; it's a search +path. -Now copy the template ``admin/base_site.html`` from within the default Django -admin template directory in the source code of Django itself -(``django/contrib/admin/templates``) into an ``admin`` subdirectory of -whichever directory you're using in :setting:`TEMPLATE_DIRS`. For example, if -your :setting:`TEMPLATE_DIRS` includes ``'/path/to/mysite/mytemplates'``, as -above, then copy ``django/contrib/admin/templates/admin/base_site.html`` to -``/path/to/mysite/mytemplates/admin/base_site.html``. Don't forget that -``admin`` subdirectory. +Now create a directory called ``admin`` inside ``mytemplates``, and copy the +template ``admin/base_site.html`` from within the default Django admin +template directory in the source code of Django itself +(``django/contrib/admin/templates``) into that directory. .. admonition:: Where are the Django source files? diff --git a/docs/intro/tutorial05.txt b/docs/intro/tutorial05.txt index d1f95176ed..7af4eb3edb 100644 --- a/docs/intro/tutorial05.txt +++ b/docs/intro/tutorial05.txt @@ -159,8 +159,7 @@ can do in an automated test, so let's turn that into an automated test. The best place for an application's tests is in the application's ``tests.py`` file - the testing system will look there for tests automatically. -Put the following in the ``tests.py`` file in the ``polls`` application (you'll -notice ``tests.py`` contains some dummy tests, you can remove those):: +Put the following in the ``tests.py`` file in the ``polls`` application:: import datetime |
