Getting runtime help¶

django-admin help¶

Rundjango-adminhelp to display usage information and a list of thecommands provided by each application.

Rundjango-adminhelp--commands to display a list of all availablecommands.

Rundjango-adminhelp<command> to display a description of the givencommand and a list of its available options.

App names¶

Many commands take a list of “app names.” An “app name” is the basename ofthe package containing your models. For example, if yourINSTALLED_APPScontains the string'mysite.blog', the app name isblog.

Determining the version¶

django-admin version¶

Rundjango-adminversion to display the current Django version.

The output follows the schema described inPEP 440:

1.4.dev170261.4a11.4

Displaying debug output¶

Use--verbosity to specify the amount of notification and debuginformation thatdjango-admin prints to the console.

check¶

django-admin check [app_label [app_label ...]]¶

Uses thesystem check framework to inspect the entireDjango project for common problems.

By default, all apps will be checked. You can check a subset of apps byproviding a list of app labels as arguments:

django-admincheckauthadminmyapp

If you do not specify any app, all apps will be checked.

--tag TAGS,-t TAGS¶

The system check framework performs many different types of checks that arecategorized with tags. You can use thesetags to restrict the checks performed to just those in a particular category.For example, to perform only models and compatibility checks, run:

django-admincheck--tagmodels--tagcompatibility

--list-tags¶

Lists all available tags.

--deploy¶

Activates some additional checks that are only relevant in a deployment setting.

You can use this option in your local development environment, but since yourlocal development settings module may not have many of your production settings,you will probably want to point thecheck command at a different settingsmodule, either by setting theDJANGO_SETTINGS_MODULE environment variable,or by passing the--settings option:

django-admincheck--deploy--settings=production_settings

Or you could run it directly on a production or staging deployment to verifythat the correct settings are in use (omitting--settings). You could evenmake it part of your integration test suite.

--fail-level {CRITICAL,ERROR,WARNING,INFO,DEBUG}¶

Specifies the message level that will cause the command to exit with a non-zerostatus. Default isERROR.

compilemessages¶

django-admin compilemessages¶

Compiles.po files created bymakemessages to.mo files foruse with the built-in gettext support. SeeInternationalization and localization.

--locale LOCALE,-l LOCALE¶

Specifies the locale(s) to process. If not provided, all locales are processed.

--exclude EXCLUDE,-x EXCLUDE¶

Specifies the locale(s) to exclude from processing. If not provided, no localesare excluded.

--use-fuzzy,-f¶

Includes fuzzy translations into compiled files.

Example usage:

django-admincompilemessages--locale=pt_BRdjango-admincompilemessages--locale=pt_BR--locale=fr-fdjango-admincompilemessages-lpt_BRdjango-admincompilemessages-lpt_BR-lfr--use-fuzzydjango-admincompilemessages--exclude=pt_BRdjango-admincompilemessages--exclude=pt_BR--exclude=frdjango-admincompilemessages-xpt_BRdjango-admincompilemessages-xpt_BR-xfr

createcachetable¶

django-admin createcachetable¶

Creates the cache tables for use with the database cache backend using theinformation from your settings file. SeeDjango’s cache framework for moreinformation.

--database DATABASE¶

Specifies the database in which the cache table(s) will be created. Defaults todefault.

--dry-run¶

Prints the SQL that would be run without actually running it, so you cancustomize it or use the migrations framework.

dbshell¶

django-admin dbshell¶

Runs the command-line client for the database engine specified in yourENGINE setting, with the connection parametersspecified in yourUSER,PASSWORD, etc., settings.

• For PostgreSQL, this runs thepsql command-line client.
• For MySQL, this runs themysql command-line client.
• For SQLite, this runs thesqlite3 command-line client.
• For Oracle, this runs thesqlplus command-line client.

This command assumes the programs are on yourPATH so that a simple call tothe program name (psql,mysql,sqlite3,sqlplus) will find theprogram in the right place. There’s no way to specify the location of theprogram manually.

--database DATABASE¶

Specifies the database onto which to open a shell. Defaults todefault.

diffsettings¶

django-admin diffsettings¶

Displays differences between the current settings file and Django’s defaultsettings (or another settings file specified by--default).

Settings that don’t appear in the defaults are followed by"###". Forexample, the default settings don’t defineROOT_URLCONF, soROOT_URLCONF is followed by"###" in the output ofdiffsettings.

--all¶

Displays all settings, even if they have Django’s default value. Such settingsare prefixed by"###".

--default MODULE¶

The settings module to compare the current settings against. Leave empty tocompare against Django’s default settings.

--output {hash,unified}¶

Specifies the output format. Available values arehash andunified.hash is the default mode that displays the output that’s described above.unified displays the output similar todiff-u. Default settings areprefixed with a minus sign, followed by the changed setting prefixed with aplus sign.

dumpdata¶

django-admin dumpdata [app_label[.ModelName] [app_label[.ModelName] ...]]¶

Outputs to standard output all data in the database associated with the namedapplication(s).

If no application name is provided, all installed applications will be dumped.

The output ofdumpdata can be used as input forloaddata.

Note thatdumpdata uses the default manager on the model for selecting therecords to dump. If you’re using acustom manager asthe default manager and it filters some of the available records, not all of theobjects will be dumped.

--all,-a¶

Uses Django’s base manager, dumping records which might otherwise be filteredor modified by a custom manager.

--format FORMAT¶

Specifies the serialization format of the output. Defaults to JSON. Supportedformats are listed inSerialization formats.

--indent INDENT¶

Specifies the number of indentation spaces to use in the output. Defaults toNone which displays all data on single line.

--exclude EXCLUDE,-e EXCLUDE¶

Prevents specific applications or models (specified in the form ofapp_label.ModelName) from being dumped. If you specify a model name, theoutput will be restricted to that model, rather than the entire application.You can also mix application names and model names.

If you want to exclude multiple applications, pass--exclude more thanonce:

django-admindumpdata--exclude=auth--exclude=contenttypes

--database DATABASE¶

Specifies the database from which data will be dumped. Defaults todefault.

--natural-foreign¶

Uses thenatural_key() model method to serialize any foreign key andmany-to-many relationship to objects of the type that defines the method. Ifyou’re dumpingcontrib.authPermission objects orcontrib.contenttypesContentType objects, you should probably use thisflag. See thenatural keysdocumentation for more details on this and the next option.

--natural-primary¶

Omits the primary key in the serialized data of this object since it can becalculated during deserialization.

--pks PRIMARY_KEYS¶

Outputs only the objects specified by a comma separated list of primary keys.This is only available when dumping one model. By default, all the records ofthe model are output.

--output OUTPUT,-o OUTPUT¶

Specifies a file to write the serialized data to. By default, the data goes tostandard output.

When this option is set and--verbosity is greater than 0 (the default), aprogress bar is shown in the terminal.

flush¶

django-admin flush¶

Removes all data from the database and re-executes any post-synchronizationhandlers. The table of which migrations have been applied is not cleared.

If you would rather start from an empty database and re-run all migrations, youshould drop and recreate the database and then runmigrate instead.

--noinput,--no-input¶

Suppresses all user prompts.

--database DATABASE¶

Specifies the database to flush. Defaults todefault.

inspectdb¶

django-admin inspectdb [table [table ...]]¶

Introspects the database tables in the database pointed-to by theNAME setting and outputs a Django model module (amodels.pyfile) to standard output.

You may choose what tables or views to inspect by passing their names asarguments. If no arguments are provided, models are created for views only ifthe--include-views option is used.

Use this if you have a legacy database with which you’d like to use Django.The script will inspect the database and create a model for each table withinit.

As you might expect, the created models will have an attribute for every fieldin the table. Note thatinspectdb has a few special cases in its field-nameoutput:

• Ifinspectdb cannot map a column’s type to a model field type, it’lluseTextField and will insert the Python comment'Thisfieldtypeisaguess.' next to the field in the generatedmodel. The recognized fields may depend on apps listed inINSTALLED_APPS. For example,django.contrib.postgres addsrecognition for several PostgreSQL-specific field types.
• If the database column name is a Python reserved word (such as'pass','class' or'for'),inspectdb will append'_field' to the attribute name. For example, if a table has a column'for', the generated model will have a field'for_field', withthedb_column attribute set to'for'.inspectdb will insertthe Python comment'FieldrenamedbecauseitwasaPythonreservedword.' next to thefield.

This feature is meant as a shortcut, not as definitive model generation. Afteryou run it, you’ll want to look over the generated models yourself to makecustomizations. In particular, you’ll need to rearrange models’ order, so thatmodels that refer to other models are ordered properly.

Django doesn’t create database defaults when adefault is specified on a model field.Similarly, database defaults aren’t translated to model field defaults ordetected in any fashion byinspectdb.

By default,inspectdb creates unmanaged models. That is,managed=Falsein the model’sMeta class tells Django not to manage each table’s creation,modification, and deletion. If you do want to allow Django to manage thetable’s lifecycle, you’ll need to change themanaged option toTrue (or simply removeit becauseTrue is its default value).

--database DATABASE¶

Specifies the database to introspect. Defaults todefault.

--include-views¶

If this option is provided, models are also created for database views.

loaddata¶

django-admin loaddata fixture [fixture ...]¶

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

--database DATABASE¶

Specifies the database into which the data will be loaded. Defaults todefault.

--ignorenonexistent,-i¶

Ignores fields and models that may have been removed since the fixture wasoriginally generated.

--app APP_LABEL¶

Specifies a single app to look for fixtures in rather than looking in all apps.

--format FORMAT¶

Specifies theserialization format (e.g.,json orxml) for fixturesread from stdin.

--exclude EXCLUDE,-e EXCLUDE¶

Excludes loading the fixtures from the given applications and/or models (in theform ofapp_label orapp_label.ModelName). Use the option multipletimes to exclude more than one app or model.

django-adminloaddatamydata.json

django-adminloaddatamydata

django-adminloaddatafoo/bar/mydata.json

fromdjango.db.models.signalsimportpost_savefrom.modelsimportMyModeldefmy_handler(**kwargs):# disable the handler during fixture loadingifkwargs['raw']:return...post_save.connect(my_handler,sender=MyModel)

fromfunctoolsimportwrapsdefdisable_for_loaddata(signal_handler):"""    Decorator that turns off signal handlers when loading fixture data.    """@wraps(signal_handler)defwrapper(*args,**kwargs):ifkwargs['raw']:returnsignal_handler(*args,**kwargs)returnwrapper@disable_for_loaddatadefmy_handler(**kwargs):...

django-adminloaddatamydata.json

django-adminloaddata--format=json-

django-admindumpdata--format=json--database=testapp_label.ModelName|django-adminloaddata--format=json--database=prod-

makemessages¶

django-admin makemessages¶

Runs over the entire source tree of the current directory and pulls out allstrings marked for translation. It creates (or updates) a message file in theconf/locale (in the Django tree) or locale (for project and application)directory. After making changes to the messages files you need to compile themwithcompilemessages for use with the builtin gettext support. Seethei18n documentation for details.

This command doesn’t require configured settings. However, when settings aren’tconfigured, the command can’t ignore theMEDIA_ROOT andSTATIC_ROOT directories or includeLOCALE_PATHS. It willalso write files in UTF-8 rather than inFILE_CHARSET.

--all,-a¶

Updates the message files for all available languages.

--extension EXTENSIONS,-e EXTENSIONS¶

Specifies a list of file extensions to examine (default:html,txt,py orjs if--domain isjs).

Example usage:

django-adminmakemessages--locale=de--extensionxhtml

Separate multiple extensions with commas or use-e or--extensionmultiple times:

django-adminmakemessages--locale=de--extension=html,txt--extensionxml

--locale LOCALE,-l LOCALE¶

Specifies the locale(s) to process.

--exclude EXCLUDE,-x EXCLUDE¶

Specifies the locale(s) to exclude from processing. If not provided, no localesare excluded.

Example usage:

django-adminmakemessages--locale=pt_BRdjango-adminmakemessages--locale=pt_BR--locale=frdjango-adminmakemessages-lpt_BRdjango-adminmakemessages-lpt_BR-lfrdjango-adminmakemessages--exclude=pt_BRdjango-adminmakemessages--exclude=pt_BR--exclude=frdjango-adminmakemessages-xpt_BRdjango-adminmakemessages-xpt_BR-xfr

--domain DOMAIN,-d DOMAIN¶

Specifies the domain of the messages files. Supported options are:

• django for all*.py,*.html and*.txt files (default)
• djangojs for*.js files

--symlinks,-s¶

Follows symlinks to directories when looking for new translation strings.

Example usage:

django-adminmakemessages--locale=de--symlinks

--ignore PATTERN,-i PATTERN¶

Ignores files or directories matching the givenglob-style pattern. Usemultiple times to ignore more.

These patterns are used by default:'CVS','.*','*~','*.pyc'.

Example usage:

django-adminmakemessages--locale=en_US--ignore=apps/*--ignore=secret/*.html

--no-default-ignore¶

Disables the default values of--ignore.

--no-wrap¶

Disables breaking long message lines into several lines in language files.

--no-location¶

Suppresses writing ‘#:filename:line’ comment lines in language files.Using this option makes it harder for technically skilled translators tounderstand each message’s context.

--add-location [{full,file,never}]¶

Controls#:filename:line comment lines in language files. If the optionis:

• full (the default if not given): the lines include both file name andline number.
• file: the line number is omitted.
• never: the lines are suppressed (same as--no-location).

Requiresgettext 0.19 or newer.

--keep-pot¶

Prevents deleting the temporary.pot files generated before creating the.po file. This is useful for debugging errors which may prevent the finallanguage files from being created.

makemigrations¶

django-admin makemigrations [app_label [app_label ...]]¶

Creates new migrations based on the changes detected to your models.Migrations, their relationship with apps and more are covered in depth inthe migrations documentation.

Providing one or more app names as arguments will limit the migrations createdto the app(s) specified and any dependencies needed (the table at the other endof aForeignKey, for example).

To add migrations to an app that doesn’t have amigrations directory, runmakemigrations with the app’sapp_label.

--noinput,--no-input¶

Suppresses all user prompts. If a suppressed prompt cannot be resolvedautomatically, the command will exit with error code 3.

--empty¶

Outputs an empty migration for the specified apps, for manual editing. This isfor advanced users and should not be used unless you are familiar with themigration format, migration operations, and the dependencies between yourmigrations.

--dry-run¶

Shows what migrations would be made without actually writing any migrationsfiles to disk. Using this option along with--verbosity3 will also showthe complete migrations files that would be written.

--merge¶

Enables fixing of migration conflicts.

--name NAME,-n NAME¶

Allows naming the generated migration(s) instead of using a generated name.

--check¶

Makesmakemigrations exit with a non-zero status when model changes withoutmigrations are detected.

migrate¶

django-admin migrate [app_label] [migration_name]¶

Synchronizes the database state with the current set of models and migrations.Migrations, their relationship with apps and more are covered in depth inthe migrations documentation.

The behavior of this command changes depending on the arguments provided:

• No arguments: All apps have all of their migrations run.
• <app_label>: The specified app has its migrations run, up to the mostrecent migration. This may involve running other apps’ migrations too, dueto dependencies.
• <app_label><migrationname>: Brings the database schema to a state wherethe named migration is applied, but no later migrations in the same app areapplied. This may involve unapplying migrations if you have previouslymigrated past the named migration. Use the namezero to unapply allmigrations for an app.

--database DATABASE¶

Specifies the database to migrate. Defaults todefault.

--fake¶

Marks the migrations up to the target one (following the rules above) asapplied, but without actually running the SQL to change your database schema.

This is intended for advanced users to manipulate thecurrent migration state directly if they’re manually applying changes;be warned that using--fake runs the risk of putting the migration statetable into a state where manual recovery will be needed to make migrationsrun correctly.

--fake-initial¶

Allows Django to skip an app’s initial migration if all database tables withthe names of all models created by allCreateModel operations in thatmigration already exist. This option is intended for use when first runningmigrations against a database that preexisted the use of migrations. Thisoption does not, however, check for matching database schema beyond matchingtable names and so is only safe to use if you are confident that your existingschema matches what is recorded in your initial migration.

--run-syncdb¶

Allows creating tables for apps without migrations. While this isn’trecommended, the migrations framework is sometimes too slow on large projectswith hundreds of models.

--noinput,--no-input¶

Suppresses all user prompts. An example prompt is asking about removing stalecontent types.

runserver¶

django-admin runserver [addrport]¶

Starts a lightweight development Web server on the local machine. By default,the server runs on port 8000 on the IP address127.0.0.1. You can pass in anIP address and port number explicitly.

If you run this script as a user with normal privileges (recommended), youmight not have access to start a port on a low port number. Low port numbersare reserved for the superuser (root).

This server uses the WSGI application object specified by theWSGI_APPLICATION setting.

DO NOT USE THIS SERVER IN A PRODUCTION SETTING. It has not gone throughsecurity audits or performance tests. (And that’s how it’s gonna stay. We’re inthe business of making Web frameworks, not Web servers, so improving thisserver to be able to handle a production environment is outside the scope ofDjango.)

The development server automatically reloads Python code for each request, asneeded. You don’t need to restart the server for code changes to take effect.However, some actions like adding files don’t trigger a restart, so you’llhave to restart the server in these cases.

If you are using Linux and installpyinotify, kernel signals will be used toautoreload the server (rather than polling file modification timestamps eachsecond). This offers better scaling to large projects, reduction in responsetime to code modification, more robust change detection, and battery usagereduction.

When you start the server, and each time you change Python code while theserver is running, the system check framework will check your entire Djangoproject for some common errors (see thecheck command). If anyerrors are found, they will be printed to standard output.

You can run as many concurrent servers as you want, as long as they’re onseparate ports. Just executedjango-adminrunserver more than once.

Note that the default IP address,127.0.0.1, is not accessible from othermachines on your network. To make your development server viewable to othermachines on the network, use its own IP address (e.g.192.168.2.1) or0.0.0.0 or:: (with IPv6 enabled).

You can provide an IPv6 address surrounded by brackets(e.g.[200a::1]:8000). This will automatically enable IPv6 support.

A hostname containing ASCII-only characters can also be used.

If thestaticfiles contrib app is enabled(default in new projects) therunserver command will be overriddenwith its ownrunserver command.

Logging of each request and response of the server is sent to thedjango.server logger.

--noreload¶

Disables the auto-reloader. This means any Python code changes you make whilethe server is running willnot take effect if the particular Python moduleshave already been loaded into memory.

--nothreading¶

Disables use of threading in the development server. The server ismultithreaded by default.

--ipv6,-6¶

Uses IPv6 for the development server. This changes the default IP address from127.0.0.1 to::1.

django-adminrunserver

django-adminrunserver1.2.3.4:8000

django-adminrunserver7000

django-adminrunserver1.2.3.4:7000

django-adminrunserver-6

django-adminrunserver-67000

django-adminrunserver[2001:0db8:1234:5678::9]:7000

django-adminrunserverlocalhost:8000

django-adminrunserver-6localhost:8000

sendtestemail¶

django-admin sendtestemail [email [email ...]]¶

Sends a test email (to confirm email sending through Django is working) to therecipient(s) specified. For example:

django-adminsendtestemailfoo@example.combar@example.com

There are a couple of options, and you may use any combination of themtogether:

--managers¶

Mails the email addresses specified inMANAGERS usingmail_managers().

--admins¶

Mails the email addresses specified inADMINS usingmail_admins().

shell¶

django-admin shell¶

Starts the Python interactive interpreter.

--interface {ipython,bpython,python},-i {ipython,bpython,python}¶

Specifies the shell to use. By default, Django will useIPython orbpython ifeither is installed. If both are installed, specify which one you want like so:

IPython:

django-adminshell-iipython

bpython:

django-adminshell-ibpython

If you have a “rich” shell installed but want to force use of the “plain”Python interpreter, usepython as the interface name, like so:

django-adminshell-ipython

--nostartup¶

Disables reading the startup script for the “plain” Python interpreter. Bydefault, the script pointed to by thePYTHONSTARTUP environmentvariable or the~/.pythonrc.py script is read.

--command COMMAND,-c COMMAND¶

Lets you pass a command as a string to execute it as Django, like so:

django-adminshell--command="import django; print(django.__version__)"

You can also pass code in on standard input to execute it. For example:

$ django-admin shell<<EOF> import django> print(django.__version__)> EOF

On Windows, the REPL is output due to implementation limits ofselect.select() on that platform.

showmigrations¶

django-admin showmigrations [app_label [app_label ...]]¶

Shows all migrations in a project. You can choose from one of two formats:

--list,-l¶

Lists all of the apps Django knows about, the migrations available for eachapp, and whether or not each migration is applied (marked by an[X] next tothe migration name).

Apps without migrations are also listed, but have(nomigrations) printedunder them.

This is the default output format.

--plan,-p¶

Shows the migration plan Django will follow to apply migrations. Like--list, applied migrations are marked by an[X]. For a--verbosityof 2 and above, all dependencies of a migration will also be shown.

app_labels arguments limit the output, however, dependencies of providedapps may also be included.

--database DATABASE¶

Specifies the database to examine. Defaults todefault.

sqlflush¶

django-admin sqlflush¶

Prints the SQL statements that would be executed for theflushcommand.

--database DATABASE¶

Specifies the database for which to print the SQL. Defaults todefault.

sqlmigrate¶

django-admin sqlmigrate app_label migration_name¶

Prints the SQL for the named migration. This requires an active databaseconnection, which it will use to resolve constraint names; this means you mustgenerate the SQL against a copy of the database you wish to later apply it on.

Note thatsqlmigrate doesn’t colorize its output.

--backwards¶

Generates the SQL for unapplying the migration. By default, the SQL created isfor running the migration in the forwards direction.

--database DATABASE¶

Specifies the database for which to generate the SQL. Defaults todefault.

sqlsequencereset¶

django-admin sqlsequencereset app_label [app_label ...]¶

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 availablenumber for automatically incremented fields.

Use this command to generate SQL which will fix cases where a sequence is outof sync with its automatically incremented field data.

--database DATABASE¶

Specifies the database for which to print the SQL. Defaults todefault.

squashmigrations¶

django-admin squashmigrations app_label [start_migration_name] migration_name¶

Squashes the migrations forapp_label up to and includingmigration_namedown into fewer migrations, if possible. The resulting squashed migrationscan live alongside the unsquashed ones safely. For more information,please readSquashing migrations.

Whenstart_migration_name is given, Django will only include migrationsstarting from and including this migration. This helps to mitigate thesquashing limitation ofRunPython anddjango.db.migrations.operations.RunSQL migration operations.

--no-optimize¶

Disables the optimizer when generating a squashed migration. By default, Djangowill try to optimize the operations in your migrations to reduce the size ofthe resulting file. Use this option if this process is failing or creatingincorrect migrations, though please also file a Django bug report about thebehavior, as optimization is meant to be safe.

--noinput,--no-input¶

Suppresses all user prompts.

--squashed-name SQUASHED_NAME¶

Sets the name of the squashed migration. When omitted, the name is based on thefirst and last migration, with_squashed_ in between.

startapp¶

django-admin startapp name [directory]¶

Creates a Django app directory structure for the given app name in the currentdirectory or the given destination.

By default the directory created contains amodels.py file and other apptemplate files. (See thesource for more details.) If only the appname is given, the app directory will be created in the current workingdirectory.

If the optional destination is provided, Django will use that existingdirectory rather than creating a new one. You can use ‘.’ to denote the currentworking directory.

For example:

django-adminstartappmyapp/Users/jezdez/Code/myapp

--template TEMPLATE¶

Provides the path to a directory with a custom app template file or a path to acompressed file (.tar.gz,.tar.bz2,.tgz,.tbz,.zip)containing the app template files.

For example, this would look for an app template in the given directory whencreating themyapp app:

django-adminstartapp--template=/Users/jezdez/Code/my_app_templatemyapp

Django will also accept URLs (http,https,ftp) to compressedarchives with the app template files, downloading and extracting them on thefly.

For example, taking advantage of GitHub’s feature to expose repositories aszip files, you can use a URL like:

django-adminstartapp--template=https://github.com/githubuser/django-app-template/archive/master.zipmyapp

--extension EXTENSIONS,-e EXTENSIONS¶

Specifies which file extensions in the app template should be rendered with thetemplate engine. Defaults topy.

--name FILES,-n FILES¶

Specifies which files in the app template (in addition to those matching--extension) should be rendered with the template engine. Defaults to anempty list.

Thetemplatecontext used for all matchingfiles is:

• Any option passed to thestartapp command (among the command’s supportedoptions)
• app_name – the app name as passed to the command
• app_directory – the full path of the newly created app
• camel_case_app_name – the app name in camel case format
• docs_version – the version of the documentation:'dev' or'1.x'
• django_version – the version of Django, e.g.``‘2.0.3’``

startproject¶

django-admin startproject name [directory]¶

Creates a Django project directory structure for the given project name inthe current directory or the given destination.

By default, the new directory containsmanage.py and a project package(containing asettings.py and other files). See thetemplate source fordetails.

If only the project name is given, both the project directory and projectpackage will be named<projectname> and the project directorywill be created in the current working directory.

If the optional destination is provided, Django will use that existingdirectory as the project directory, and createmanage.py and the projectpackage within it. Use ‘.’ to denote the current working directory.

For example:

django-adminstartprojectmyproject/Users/jezdez/Code/myproject_repo

--template TEMPLATE¶

Specifies a directory, file path, or URL of a custom project template. See thestartapp--template documentation for examples and usage.

--extension EXTENSIONS,-e EXTENSIONS¶

Specifies which file extensions in the project template should be rendered withthe template engine. Defaults topy.

--name FILES,-n FILES¶

Specifies which files in the project template (in addition to those matching--extension) should be rendered with the template engine. Defaults to anempty list.

Thetemplatecontext used is:

• Any option passed to thestartproject command (among the command’ssupported options)
• project_name – the project name as passed to the command
• project_directory – the full path of the newly created project
• secret_key – a random key for theSECRET_KEY setting
• docs_version – the version of the documentation:'dev' or'1.x'
• django_version – the version of Django, e.g.``‘2.0.3’``

Please also see therendering warning as mentionedforstartapp.

test¶

django-admin test [test_label [test_label ...]]¶

Runs tests for all installed apps. SeeTesting in Django for moreinformation.

--failfast¶

Stops running tests and reports the failure immediately after a test fails.

--testrunner TESTRUNNER¶

Controls the test runner class that is used to execute tests. This valueoverrides the value provided by theTEST_RUNNER setting.

--noinput,--no-input¶

Suppresses all user prompts. A typical prompt is a warning about deleting anexisting test database.

$ pip install tblib

testserver¶

django-admin testserver [fixture [fixture ...]]¶

Runs a Django development server (as inrunserver) using data fromthe given fixture(s).

For example, this command:

django-admintestservermydata.json

…would perform the following steps:

1. Create a test database, as described inThe test database.
2. Populate the test database with fixture data from the given fixtures.(For more on fixtures, see the documentation forloaddata above.)
3. Runs the Django development server (as inrunserver), pointed atthis newly created test database instead of your production database.

This is useful in a number of ways:

• When you’re writingunit tests of how your viewsact with certain fixture data, you can usetestserver to interact withthe views in a Web browser, manually.
• Let’s say you’re developing your Django application and have a “pristine”copy of a database that you’d like to interact with. You can dump yourdatabase to a fixture (using thedumpdata command, explainedabove), then usetestserver to run your Web application with that data.With this arrangement, you have the flexibility of messing up your datain any way, knowing that whatever data changes you’re making are onlybeing made to a test database.

Note that this server doesnot automatically detect changes to your Pythonsource code (asrunserver does). It does, however, detect changes totemplates.

--addrport ADDRPORT¶

Specifies a different port, or IP address and port, from the default of127.0.0.1:8000. This value follows exactly the same format and servesexactly the same function as the argument to therunserver command.

Examples:

To run the test server on port 7000 withfixture1 andfixture2:

django-admintestserver--addrport7000fixture1fixture2django-admintestserverfixture1fixture2--addrport7000

(The above statements are equivalent. We include both of them to demonstratethat it doesn’t matter whether the options come before or after the fixturearguments.)

To run on 1.2.3.4:7000 with atest fixture:

django-admintestserver--addrport1.2.3.4:7000test

--noinput,--no-input¶

Suppresses all user prompts. A typical prompt is a warning about deleting anexisting test database.

django.contrib.auth¶

django-adminchangepasswordringo

django.contrib.contenttypes¶

django.contrib.gis¶

django.contrib.sessions¶

django.contrib.sitemaps¶

django.contrib.staticfiles¶

Syntax coloring¶

Thedjango-admin /manage.py commands will use prettycolor-coded output if your terminal supports ANSI-colored output. Itwon’t use the color codes if you’re piping the command’s output toanother program.

Under Windows, the native console doesn’t support ANSI escape sequences so bydefault there is no color output. But you can install theANSICONthird-party tool, the Django commands will detect its presence and will makeuse of its services to color output just like on Unix-based platforms.

The colors used for syntax highlighting can be customized. Djangoships with three color palettes:

• dark, suited to terminals that show white text on a blackbackground. This is the default palette.
• light, suited to terminals that show black text on a whitebackground.
• nocolor, which disables syntax highlighting.

You select a palette by setting aDJANGO_COLORS environmentvariable to specify the palette you want to use. For example, tospecify thelight palette under a Unix or OS/X BASH shell, youwould run the following at a command prompt:

exportDJANGO_COLORS="light"

You can also customize the colors that are used. Django specifies anumber of roles in which color is used:

• error - A major error.
• notice - A minor error.
• success - A success.
• warning - A warning.
• sql_field - The name of a model field in SQL.
• sql_coltype - The type of a model field in SQL.
• sql_keyword - An SQL keyword.
• sql_table - The name of a model in SQL.
• http_info - A 1XX HTTP Informational server response.
• http_success - A 2XX HTTP Success server response.
• http_not_modified - A 304 HTTP Not Modified server response.
• http_redirect - A 3XX HTTP Redirect server response other than 304.
• http_not_found - A 404 HTTP Not Found server response.
• http_bad_request - A 4XX HTTP Bad Request server response other than 404.
• http_server_error - A 5XX HTTP Server Error response.
• migrate_heading - A heading in a migrations management command.
• migrate_label - A migration name.

Each of these roles can be assigned a specific foreground andbackground color, from the following list:

• black
• red
• green
• yellow
• blue
• magenta
• cyan
• white

Each of these colors can then be modified by using the followingdisplay options:

• bold
• underscore
• blink
• reverse
• conceal

A color specification follows one of the following patterns:

• role=fg
• role=fg/bg
• role=fg,option,option
• role=fg/bg,option,option

whererole is the name of a valid color role,fg is theforeground color,bg is the background color and eachoptionis one of the color modifying options. Multiple color specificationsare then separated by a semicolon. For example:

exportDJANGO_COLORS="error=yellow/blue,blink;notice=magenta"

would specify that errors be displayed using blinking yellow on blue,and notices displayed using magenta. All other color roles would beleft uncolored.

Colors can also be specified by extending a base palette. If you puta palette name in a color specification, all the colors implied by thatpalette will be loaded. So:

exportDJANGO_COLORS="light;error=yellow/blue,blink;notice=magenta"

would specify the use of all the colors in the light color palette,except for the colors for errors and notices which would beoverridden as specified.

Bash completion¶

If you use the Bash shell, consider installing the Django bash completionscript, which lives inextras/django_bash_completion in the Django sourcedistribution. It enables tab-completion ofdjango-admin andmanage.py commands, so you can, for instance…

• Typedjango-admin.
• Press [TAB] to see all available options.
• Typesql, then [TAB], to see all available options whose names startwithsql.

SeeWriting custom django-admin commands for how to add customized actions.

fromdjango.coreimportmanagementfromdjango.core.management.commandsimportloaddatamanagement.call_command('flush',verbosity=0,interactive=False)management.call_command('loaddata','test_data',verbosity=0)management.call_command(loaddata.Command(),'test_data',verbosity=0)

# Similar to the command linemanagement.call_command('dumpdata','--natural-foreign')# Named argument similar to the command line minus the initial dashes and# with internal dashes replaced by underscoresmanagement.call_command('dumpdata',natural_foreign=True)# `use_natural_foreign_keys` is the option destination variablemanagement.call_command('dumpdata',use_natural_foreign_keys=True)

management.call_command('dumpdata',exclude=['contenttypes','auth'])