Fixed a bunch of ReST-related bugs in docs/tutorial.txt and made some improvements

git-svn-id: http://code.djangoproject.com/svn/django/trunk@98 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Adrian Holovaty 2005-07-16 05:19:28 +00:00
parent d30ffb4db6
commit a5a3eca757
1 changed files with 30 additions and 24 deletions

View File

@ -40,13 +40,13 @@ settings. Let's look at what ``startproject`` created::
First, edit ``myproject/settings/main.py``. It's a normal Python module with First, edit ``myproject/settings/main.py``. It's a normal Python module with
module-level variables representing Django settings. Edit the file and change module-level variables representing Django settings. Edit the file and change
these settings to match your database's connection parameters:: these settings to match your database's connection parameters:
* ``DATABASE_ENGINE`` -- Either 'postgresql' or 'mysql'. More coming soon. * ``DATABASE_ENGINE`` -- Either 'postgresql' or 'mysql'. More coming soon.
* ``DATABASE_NAME`` -- The name of your database. * ``DATABASE_NAME`` -- The name of your database.
* ``DATABASE_USER`` -- Your database username. * ``DATABASE_USER`` -- Your database username.
* ``DATABASE_PASSWORD`` -- Your database password. * ``DATABASE_PASSWORD`` -- Your database password.
* ``DATABASE_HOST`` -- The host your database is on. Just leave this as an * ``DATABASE_HOST`` -- The host your database is on. Leave this as an
empty string if your database server is on the same physical machine empty string if your database server is on the same physical machine
(localhost). (localhost).
@ -61,28 +61,28 @@ your `Python path`_ -- so that the Python statement ``import myproject.settings.
works. Throughout Django, you'll be referring to your projects and apps via works. Throughout Django, you'll be referring to your projects and apps via
Python package syntax. Python package syntax.
Then run the following command: Then run the following command::
django-admin.py init django-admin.py init
If you don't see any errors, you know it worked. That command initialized your If you don't see any errors, you know it worked. That command initialized your
database with Django's core database tables. If you're interested, run the database with Django's core database tables. If you're interested, run the
PostgreSQL or MySQL command-line client and type "\dt" (PostgreSQL) or PostgreSQL or MySQL command-line client and type "\\dt" (PostgreSQL) or
"SHOW TABLES" (MySQL) to display the tables. "SHOW TABLES;" (MySQL) to display the tables.
Now you're set to start doing work. You won't have to take care of this boring Now you're set to start doing work. You won't have to take care of this boring
administrative stuff again. administrative stuff again.
:: _Python path: http://docs.python.org/tut/node8.html#SECTION008110000000000000000 .. _`Python path`: http://docs.python.org/tut/node8.html#SECTION008110000000000000000
Creating models Creating models
=============== ===============
``cd`` into the ``myproject/apps`` directory and type this command: Change into the ``myproject/apps`` directory and type this command::
django-admin.py startapp polls django-admin.py startapp polls
That'll create a directory structure like this: That'll create a directory structure like this::
polls/ polls/
__init__.py __init__.py
@ -109,7 +109,7 @@ In our simple poll app, we'll create two models: polls and choices. A poll has
a question, a publication date and an expiration date. A choice has two fields: a question, a publication date and an expiration date. A choice has two fields:
the text of the choice and a vote tally. Each choice is associated with a poll. the text of the choice and a vote tally. Each choice is associated with a poll.
Edit the ``polls/models/polls.py`` file so that it looks like this: Edit the ``polls/models/polls.py`` file so that it looks like this::
from django.core import meta from django.core import meta
@ -159,7 +159,7 @@ That small bit of model code gives Django a lot of information. With it, Django
is able to: is able to:
* Create a database schema (``CREATE TABLE`` statements) for this app. * Create a database schema (``CREATE TABLE`` statements) for this app.
* Create a Python API for accessing Poll and Choice objects. * Create a Python database-access API for accessing Poll and Choice objects.
But first we need to tell our project that the ``polls`` app is installed. But first we need to tell our project that the ``polls`` app is installed.
@ -177,11 +177,11 @@ setting to include the string "myproject.apps.polls". So it'll look like this::
(Don't forget the trailing comma because of Python's rules about single-value (Don't forget the trailing comma because of Python's rules about single-value
tuples.) tuples.)
Now Django knows myproject includes the polls app. Let's run another command: Now Django knows myproject includes the polls app. Let's run another command::
django-admin.py sql polls django-admin.py sql polls
You should see the following (the CREATE TABLE SQL statements for the polls app): You should see the following (the CREATE TABLE SQL statements for the polls app)::
BEGIN; BEGIN;
CREATE TABLE polls_polls ( CREATE TABLE polls_polls (
@ -200,8 +200,9 @@ You should see the following (the CREATE TABLE SQL statements for the polls app)
Note the following: Note the following:
* Table names are automatically generated by combining the name of the app * Table names are automatically generated by combining the name of the app
(polls) with a plural version of the object name (polls and choices). (polls) with a plural version of the object name (polls and choices). (You
* Primary keys (IDs) are added automatically. (You can override this behavior.) can override this behavior.)
* Primary keys (IDs) are added automatically. (You can override this, too.)
* The foreign key relationship is made explicit by a ``REFERENCES`` statement. * The foreign key relationship is made explicit by a ``REFERENCES`` statement.
* It's tailored to the database you're using, so database-specific field types * It's tailored to the database you're using, so database-specific field types
such as ``auto_increment`` (MySQL) vs. ``serial`` (PostgreSQL) are handled such as ``auto_increment`` (MySQL) vs. ``serial`` (PostgreSQL) are handled
@ -222,7 +223,7 @@ If you're interested, also run the following commands:
Looking at the output of those commands can help you understand what's actually Looking at the output of those commands can help you understand what's actually
happening under the hood. happening under the hood.
Now, run this command: Now, run this command::
django-admin.py install polls django-admin.py install polls
@ -318,10 +319,15 @@ Let's jump back into the Python interactive shell::
>>> polls.get_object(id__exact=2) >>> polls.get_object(id__exact=2)
Traceback (most recent call last): Traceback (most recent call last):
... ...
django.models.polls.PollDoesNotExist: Poll does not exist for {'id__exact': 2} PollDoesNotExist: Poll does not exist for {'id__exact': 2}
>>> polls.get_list(question__startswith='What') >>> polls.get_list(question__startswith='What')
[What's up] [What's up]
# Make sure our custom method worked.
>>> p = polls.get_object(id__exact=1)
>>> p.was_published_today()
False
# Give the Poll a couple of Choices. Each one of these method calls does an # Give the Poll a couple of Choices. Each one of these method calls does an
# INSERT statement behind the scenes and returns the new Choice object. # INSERT statement behind the scenes and returns the new Choice object.
>>> p = polls.get_object(id__exact=1) >>> p = polls.get_object(id__exact=1)
@ -360,7 +366,7 @@ Coming soon
=========== ===========
The tutorial ends here for the time being. But check back within 48 hours for The tutorial ends here for the time being. But check back within 48 hours for
more: the next installments:
* Using the dynamically-generated admin site * Using the dynamically-generated admin site
* Writing public-facing apps * Writing public-facing apps