Fixed #12204 -- Corrected the use of :djadmin: links in the testing docs, plus...

Displaying debug output

-----------------------

.. django-admin-option:: --verbosity <amount>

Use ``--verbosity`` to specify the amount of notification and debug information

Use :djadminopt:`--verbosity` to specify the amount of notification and debug information

that ``django-admin.py`` should print to the console. For more details, see the

documentation for the :ref:`default options for django-admin.py <django-admin-verbosity>`.

documentation for the :djadminopt:`--verbosity` option.

Available subcommands

=====================

cleanup

-------

.. django-admin:: cleanup

.. versionadded:: 1.0

Can be run as a cronjob or directly to clean out old data from the database

compilemessages

---------------

.. django-admin:: compilemessages

.. versionchanged:: 1.0

   Before 1.0 this was the "bin/compile-messages.py" command.

Compiles .po files created with ``makemessages`` to .mo files for use with

the builtin gettext support. See :ref:`topics-i18n`.

--locale

~~~~~~~~

Use the ``--locale`` or ``-l`` option to specify the locale to process.

If not provided all locales are processed.

Use the :djadminopt:`--locale`` option to specify the locale to process.

If not provided, all locales are processed.

Example usage::

createcachetable

----------------

.. django-admin:: createcachetable <tablename>

.. django-admin:: createcachetable

Creates a cache table named ``tablename`` for use with the database cache

backend. See :ref:`topics-cache` for more information.

Note that Django's default settings live in ``django/conf/global_settings.py``,

if you're ever curious to see the full list of defaults.

dumpdata

--------

dumpdata <appname appname appname.Model ...>

--------------------------------------------

.. django-admin:: dumpdata <appname appname appname.Model ...>

.. django-admin:: dumpdata

Outputs to standard output all data in the database associated with the named

application(s).

    django-admin.py dumpdata --exclude=auth --exclude=contenttypes

.. django-admin-option:: --format <fmt>

By default, ``dumpdata`` will format its output in JSON, but you can use the

flush

-----

.. django-admin: flush

.. django-admin:: flush

Returns the database to the state it was in immediately after syncdb was

executed. This means that all data will be removed from the database, any

post-synchronization handlers will be re-executed, and the ``initial_data``

fixture will be re-installed.

.. django-admin-option:: --noinput

    Use the ``--noinput`` option to suppress all user prompting, such as "Are

    you sure?" confirmation messages. This is useful if ``django-admin.py`` is

    being executed as an unattended, automated script.

The :djadminopt:`--noinput` option may be provided to suppress all user

prompts.

inspectdb

---------

.. django-admin:: inspectdb

Introspects the database tables in the database pointed-to by the

``DATABASE_NAME`` setting and outputs a Django model module (a ``models.py``

file) to standard output.

loaddata <fixture fixture ...>

------------------------------

.. django-admin:: loaddata

Searches for and loads the contents of the named fixture into the database.

What's a "fixture"?

makemessages

------------

.. django-admin:: makemessages

.. versionchanged:: 1.0

   Before 1.0 this was the ``bin/make-messages.py`` command.

with ``compilemessages`` for use with the builtin gettext support. See the

:ref:`i18n documentation <how-to-create-language-files>` for details.

--all

~~~~~

.. django-admin-option:: --all

Use the ``--all`` or ``-a`` option to update the message files for all

available languages.

    django-admin.py makemessages --all

--extension

~~~~~~~~~~~

.. django-admin-option:: --extension

Use the ``--extension`` or ``-e`` option to specify a list of file extensions

to examine (default: ".html").

    django-admin.py makemessages --locale=de --extension=html,txt --extension xml

--locale

~~~~~~~~

Use the ``--locale`` or ``-l`` option to specify the locale to process.

Use the :djadminopt:`--locale` option to specify the locale to process.

Example usage::

    django-admin.py makemessages --locale=br_PT

--domain

~~~~~~~~

.. django-admin-option:: --domain

Use the ``--domain`` or ``-d`` option to change the domain of the messages files.

Currently supported:

	* ``django`` for all ``*.py`` and ``*.html`` files (default)

	* ``djangojs`` for ``*.js`` files

.. _django-admin-reset:

reset <appname appname ...>

---------------------------

Executes the equivalent of ``sqlreset`` for the given app name(s).

.. django-admin:: reset

--noinput

~~~~~~~~~

Executes the equivalent of ``sqlreset`` for the given app name(s).

Use the ``--noinput`` option to suppress all user prompting, such as

"Are you sure?" confirmation messages. This is useful if ``django-admin.py``

is being executed as an unattended, automated script.

The :djadminopt:`--noinput` option may be provided to suppress all user

prompts.

runfcgi [options]

-----------------

.. django-admin:: runfcgi

Starts a set of FastCGI processes suitable for use with any Web server that

supports the FastCGI protocol. See the :ref:`FastCGI deployment documentation

<howto-deployment-fastcgi>` for details. Requires the Python FastCGI module from

.. _flup: http://www.saddi.com/software/flup/

runserver

---------

runserver [port or ipaddr:port]

-------------------------------

.. django-admin:: runserver [port or ipaddr:port]

.. django-admin:: runserver

Starts a lightweight development Web server on the local machine. By default,

the server runs on port 8000 on the IP address 127.0.0.1. You can pass in an

shell

-----

.. django-admin:: shell

Starts the Python interactive interpreter.

Django will use IPython_, if it's installed. If you have IPython installed and

sql <appname appname ...>

-------------------------

.. django-admin:: sql

Prints the CREATE TABLE SQL statements for the given app name(s).

sqlall <appname appname ...>

----------------------------

.. django-admin:: sqlall

Prints the CREATE TABLE and initial-data SQL statements for the given app name(s).

Refer to the description of ``sqlcustom`` for an explanation of how to

sqlclear <appname appname ...>

------------------------------

.. django-admin:: sqlclear

Prints the DROP TABLE SQL statements for the given app name(s).

sqlcustom <appname appname ...>

-------------------------------

.. django-admin:: sqlcustom

Prints the custom SQL statements for the given app name(s).

For each model in each specified app, this command looks for the file

sqlflush

--------

Prints the SQL statements that would be executed for the `flush`_ command.

.. django-admin:: sqlflush

Prints the SQL statements that would be executed for the :djadmin:`flush`

command.

sqlindexes <appname appname ...>

--------------------------------

.. django-admin:: sqlindexes

Prints the CREATE INDEX SQL statements for the given app name(s).

sqlreset <appname appname ...>

------------------------------

.. django-admin:: sqlreset

Prints the DROP TABLE SQL, then the CREATE TABLE SQL, for the given app name(s).

sqlsequencereset <appname appname ...>

--------------------------------------

.. django-admin:: sqlsequencereset

Prints the SQL statements for resetting sequences for the given app name(s).

Sequences are indexes used by some database engines to track the next available

startapp <appname>

------------------

.. django-admin:: startapp

Creates a Django app directory structure for the given app name in the current

directory.

startproject <projectname>

--------------------------

.. django-admin:: startproject

Creates a Django project directory structure for the given project name in the

current directory.

situations, either omit the ``--settings`` option or unset

``DJANGO_SETTINGS_MODULE``.

.. _django-admin-syncdb:

syncdb

------

.. django-admin:: syncdb

Creates the database tables for all apps in ``INSTALLED_APPS`` whose tables

have not already been created.

documentation for ``loaddata`` for details on the specification of fixture

data files.

--noinput

~~~~~~~~~

The :djadminopt:`--noinput` option may be provided to suppress all user

prompts.

Use the ``--noinput`` option to suppress all user prompting, such as

"Are you sure?" confirmation messages. This is useful if ``django-admin.py``

is being executed as an unattended, automated script.

test <app or test identifier>

-----------------------------

test

----

.. django-admin:: test

Runs tests for all installed models. See :ref:`topics-testing` for more

information.

--noinput

~~~~~~~~~

Use the ``--noinput`` option to suppress all user prompting, such as

"Are you sure?" confirmation messages. This is useful if ``django-admin.py``

is being executed as an unattended, automated script.

testserver <fixture fixture ...>

--------------------------------

.. django-admin:: testserver

.. versionadded:: 1.0

Runs a Django development server (as in ``runserver``) using data from the

source code (as ``runserver`` does). It does, however, detect changes to

templates.

--addrport [port number or ipaddr:port]

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. django-admin-option:: --addrport [port number or ipaddr:port]

Use ``--addrport`` to specify a different port, or IP address and port, from

the default of 127.0.0.1:8000. This value follows exactly the same format and

validate

--------

.. django-admin:: validate

Validates all installed models (according to the ``INSTALLED_APPS`` setting)

and prints validation errors to standard output.

Although some subcommands may allow their own custom options, every subcommand

allows for the following options:

--pythonpath

------------

.. django-admin-option:: --pythonpath

Example usage::

.. _import search path: http://diveintopython.org/getting_to_know_python/everything_is_an_object.html

--settings

----------

.. django-admin-option:: --settings

Example usage::

Note that this option is unnecessary in ``manage.py``, because it uses

``settings.py`` from the current project by default.

--traceback

-----------

.. django-admin-option:: --traceback

Example usage::

error occurs. If you specify ``--traceback``, ``django-admin.py``  will

output a full stack trace whenever an exception is raised.

.. _django-admin-verbosity:

--verbosity

-----------

.. django-admin-option:: --verbosity

Example usage::

    * ``1`` means normal output (default).

    * ``2`` means verbose output.

Common options

==============

The following options are not available on every commands, but they are

common to a number of commands.

.. django-admin-option:: --locale

Use the ``--locale`` or ``-l`` option to specify the locale to process.

If not provided all locales are processed.

.. django-admin-option:: --noinput

Use the ``--noinput`` option to suppress all user prompting, such as "Are

you sure?" confirmation messages. This is useful if ``django-admin.py`` is

being executed as an unattended, automated script.

Extra niceties

==============

      with ``sql``.

See :ref:`howto-custom-management-commands` for how to add customized actions.

.. versionadded:: 1.1

Defaults to ``True``, meaning Django will create the appropriate database

tables in :ref:`django-admin-syncdb` and remove them as part of a :ref:`reset

<django-admin-reset>` management command. That is, Django *manages* the

database tables' lifecycles.

tables in :djadmin:`syncdb` and remove them as part of a :djadmin:`reset`

management command. That is, Django *manages* the database tables' lifecycles.

If ``False``, no database table creation or deletion operations will be

performed for this model. This is useful if the model represents an existing

        def setUp(self):

            # Test definitions as before.

            call_setup_methods()

        def testFluffyAnimals(self):

            # A test that uses the fixtures.

            call_some_test_code()

Here's specifically what will happen:

    * At the start of each test case, before ``setUp()`` is run, Django will

      flush the database, returning the database to the state it was in

      directly after ``syncdb`` was called.

      directly after :djadmin:`syncdb` was called.

    * Then, all the named fixtures are installed. In this example, Django will

      install any JSON fixture named ``mammals``, followed by any fixture named

      ``birds``. See the :djadmin:`loaddata documentation<loaddata>` for more

      ``birds``. See the :djadmin:`loaddata` documentation for more

      details on defining and installing fixtures.

This flush/load procedure is repeated for each test in the test case, so you

        def testIndexPageView(self):

            # Here you'd test your view using ``Client``.

            call_some_test_code()

This test case will use the contents of ``myapp.test_urls`` as the

URLconf for the duration of the test case.