django-admin is Django’s command-line utility for administrative tasks.\nThis document outlines all it can do.
In addition, manage.py is automatically created in each Django project.\nmanage.py does the same thing as django-admin but takes care of a few\nthings for you:
It puts your project’s package on sys.path.
It sets the DJANGO_SETTINGS_MODULE environment variable so that\nit points to your project’s settings.py file.
The django-admin script should be on your system path if you installed\nDjango via its setup.py utility. If it’s not on your path, you can find it\nin site-packages/django/bin within your Python installation. Consider\nsymlinking it from some place on your path, such as /usr/local/bin.
For Windows users, who do not have symlinking functionality available, you can\ncopy django-admin.exe to a location on your existing path or edit the\nPATH settings (under Settings - Control Panel - System - Advanced -\nEnvironment...) to point to its installed location.
Generally, when working on a single Django project, it’s easier to use\nmanage.py than django-admin. If you need to switch between multiple\nDjango settings files, use django-admin with\nDJANGO_SETTINGS_MODULE or the --settings command line\noption.
The command-line examples throughout this document use django-admin to\nbe consistent, but any example can use manage.py just as well.
$ django-admin <command> [options]\n$ manage.py <command> [options]\ncommand should be one of the commands listed in this document.\noptions, which is optional, should be zero or more of the options available\nfor the given command.
Run django-admin help to display usage information and a list of the\ncommands provided by each application.
Run django-admin help --commands to display a list of all available\ncommands.
Run django-admin help <command> to display a description of the given\ncommand and a list of its available options.
Many commands take a list of “app names.” An “app name” is the basename of\nthe package containing your models. For example, if your INSTALLED_APPS\ncontains the string 'mysite.blog', the app name is blog.
Run django-admin version to display the current Django version.
The output follows the schema described in PEP 386:
\n1.4.dev17026\n1.4a1\n1.4\nUse --verbosity to specify the amount of notification and debug information\nthat django-admin should print to the console. For more details, see the\ndocumentation for the --verbosity option.
Uses the system check framework to inspect\nthe entire Django project for common problems.
\nThe system check framework will confirm that there aren’t any problems with\nyour installed models or your admin registrations. It will also provide warnings\nof common compatibility problems introduced by upgrading Django to a new version.\nCustom checks may be introduced by other libraries and applications.
\nBy default, all apps will be checked. You can check a subset of apps by providing\na list of app labels as arguments:
\npython manage.py check auth admin myapp\nIf you do not specify any app, all apps will be checked.
\nThe system check framework performs many different\ntypes of checks. These check types are categorized with tags. You can use these tags\nto restrict the checks performed to just those in a particular category. For example,\nto perform only security and compatibility checks, you would run:
\npython manage.py check --tag security --tag compatibility\nList all available tags.
\nThe --deploy option activates some additional checks that are only relevant\nin a deployment setting.
You can use this option in your local development environment, but since your\nlocal development settings module may not have many of your production settings,\nyou will probably want to point the check command at a different settings\nmodule, either by setting the DJANGO_SETTINGS_MODULE environment variable,\nor by passing the --settings option:
python manage.py check --deploy --settings=production_settings\nOr you could run it directly on a production or staging deployment to verify\nthat the correct settings are in use (omitting --settings). You could even\nmake it part of your integration test suite.
Compiles .po files created by makemessages to .mo files for use with\nthe builtin gettext support. See Internationalization and localization.
Use the --locale option (or its shorter version -l) to\nspecify the locale(s) to process. If not provided, all locales are processed.
Use the --exclude option (or its shorter version -x) to\nspecify the locale(s) to exclude from processing. If not provided, no locales\nare excluded.
You can pass --use-fuzzy option (or -f) to include fuzzy translations\ninto compiled files.
Example usage:
\ndjango-admin compilemessages --locale=pt_BR\ndjango-admin compilemessages --locale=pt_BR --locale=fr -f\ndjango-admin compilemessages -l pt_BR\ndjango-admin compilemessages -l pt_BR -l fr --use-fuzzy\ndjango-admin compilemessages --exclude=pt_BR\ndjango-admin compilemessages --exclude=pt_BR --exclude=fr\ndjango-admin compilemessages -x pt_BR\ndjango-admin compilemessages -x pt_BR -x fr\nCreates the cache tables for use with the database cache backend. See\nDjango’s cache framework for more information.
\nThe --database option can be used to specify the database\nonto which the cachetable will be installed.
Runs the command-line client for the database engine specified in your\nENGINE setting, with the connection parameters specified in your\nUSER, PASSWORD, etc., settings.
For PostgreSQL, this runs the psql command-line client.
For MySQL, this runs the mysql command-line client.
For SQLite, this runs the sqlite3 command-line client.
For Oracle, this runs the sqlplus command-line client.
This command assumes the programs are on your PATH so that a simple call to\nthe program name (psql, mysql, sqlite3, sqlplus) will find the\nprogram in the right place. There’s no way to specify the location of the\nprogram manually.
The --database option can be used to specify the database\nonto which to open a shell.
Displays differences between the current settings file and Django’s default\nsettings.
\nSettings that don’t appear in the defaults are followed by "###". For\nexample, the default settings don’t define ROOT_URLCONF, so\nROOT_URLCONF is followed by "###" in the output of\ndiffsettings.
The --all option may be provided to display all settings, even\nif they have Django’s default value. Such settings are prefixed by "###".
Outputs to standard output all data in the database associated with the named\napplication(s).
\nIf no application name is provided, all installed applications will be dumped.
\nThe output of dumpdata can be used as input for loaddata.
Note that dumpdata uses the default manager on the model for selecting the\nrecords to dump. If you’re using a custom manager as\nthe default manager and it filters some of the available records, not all of the\nobjects will be dumped.
The --all option may be provided to specify that\ndumpdata should use Django’s base manager, dumping records which\nmight otherwise be filtered or modified by a custom manager.
By default, dumpdata will format its output in JSON, but you can use the\n--format option to specify another format. Currently supported formats\nare listed in Serialization formats.
By default, dumpdata will output all data on a single line. This isn’t\neasy for humans to read, so you can use the --indent option to\npretty-print the output with a number of indentation spaces.
The --exclude option may be provided to prevent specific\napplications or models (specified as in the form of app_label.ModelName)\nfrom being dumped. If you specify a model name to dumpdata, the dumped\noutput will be restricted to that model, rather than the entire application.\nYou can also mix application names and model names.
The --database option can be used to specify the database\nfrom which data will be dumped.
When this option is specified, Django will use the natural_key() model\nmethod to serialize any foreign key and many-to-many relationship to objects of\nthe type that defines the method. If you are dumping contrib.auth\nPermission objects or contrib.contenttypes ContentType objects, you\nshould probably be using this flag. See the natural keys documentation for more details on this\nand the next option.
When this option is specified, Django will not provide the primary key in the\nserialized data of this object since it can be calculated during\ndeserialization.
\nUse natural keys to represent\nany foreign key and many-to-many relationship with a model that provides\na natural key definition.
\nBy default, dumpdata will output all the records of the model, but\nyou can use the --pks option to specify a comma separated list of\nprimary keys on which to filter. This is only available when dumping\none model.
By default dumpdata will output all the serialized data to standard output.\nThis option allows you to specify the file to which the data is to be written.
Removes all data from the database, re-executes any post-synchronization\nhandlers, and reinstalls any initial data fixtures.
\nThe --noinput option may be provided to suppress all user\nprompts.
The --database option may be used to specify the database\nto flush.
--no-initial-dataLink to this heading#Use --no-initial-data to avoid loading the initial_data fixture.
Introspects the database tables in the database pointed-to by the\nNAME setting and outputs a Django model module (a models.py\nfile) to standard output.
Use this if you have a legacy database with which you’d like to use Django.\nThe script will inspect the database and create a model for each table within\nit.
\nAs you might expect, the created models will have an attribute for every field\nin the table. Note that inspectdb has a few special cases in its field-name\noutput:
If inspectdb cannot map a column’s type to a model field type, it’ll\nuse TextField and will insert the Python comment\n'This field type is a guess.' next to the field in the generated\nmodel.
If the database column name is a Python reserved word (such as\n'pass', 'class' or 'for'), inspectdb will append\n'_field' to the attribute name. For example, if a table has a column\n'for', the generated model will have a field 'for_field', with\nthe db_column attribute set to 'for'. inspectdb will insert\nthe Python comment\n'Field renamed because it was a Python reserved word.' next to the\nfield.
This feature is meant as a shortcut, not as definitive model generation. After\nyou run it, you’ll want to look over the generated models yourself to make\ncustomizations. In particular, you’ll need to rearrange models’ order, so that\nmodels that refer to other models are ordered properly.
\nPrimary keys are automatically introspected for PostgreSQL, MySQL and\nSQLite, in which case Django puts in the primary_key=True where\nneeded.
inspectdb works with PostgreSQL, MySQL and SQLite. Foreign-key detection\nonly works in PostgreSQL and with certain types of MySQL tables.
Django doesn’t create database defaults when a\ndefault is specified on a model field.\nSimilarly, database defaults aren’t translated to model field defaults or\ndetected in any fashion by inspectdb.
By default, inspectdb creates unmanaged models. That is, managed = False\nin the model’s Meta class tells Django not to manage each table’s creation,\nmodification, and deletion. If you do want to allow Django to manage the\ntable’s lifecycle, you’ll need to change the\nmanaged option to True (or simply remove\nit because True is its default value).
The --database option may be used to specify the\ndatabase to introspect.
Searches for and loads the contents of the named fixture into the database.
\nThe --database option can be used to specify the database\nonto which the data will be loaded.
The --ignorenonexistent option can be used to ignore fields and\nmodels that may have been removed since the fixture was originally generated.
The --app option can be used to specify a single app to look\nfor fixtures in rather than looking through all apps.
A fixture is a collection of files that contain the serialized contents of\nthe database. Each fixture has a unique name, and the files that comprise the\nfixture can be distributed over multiple directories, in multiple applications.
\nDjango will search in three locations for fixtures:
\nIn the fixtures directory of every installed application
In any directory named in the FIXTURE_DIRS setting
In the literal path named by the fixture
Django will load any and all fixtures it finds in these locations that match\nthe provided fixture names.
\nIf the named fixture has a file extension, only fixtures of that type\nwill be loaded. For example:
\ndjango-admin loaddata mydata.json\nwould only load JSON fixtures called mydata. The fixture extension\nmust correspond to the registered name of a\nserializer (e.g., json or xml).
If you omit the extensions, Django will search all available fixture types\nfor a matching fixture. For example:
\ndjango-admin loaddata mydata\nwould look for any fixture of any fixture type called mydata. If a fixture\ndirectory contained mydata.json, that fixture would be loaded\nas a JSON fixture.
The fixtures that are named can include directory components. These\ndirectories will be included in the search path. For example:
\ndjango-admin loaddata foo/bar/mydata.json\nwould search <app_label>/fixtures/foo/bar/mydata.json for each installed\napplication, <dirname>/foo/bar/mydata.json for each directory in\nFIXTURE_DIRS, and the literal path foo/bar/mydata.json.
When fixture files are processed, the data is saved to the database as is.\nModel defined save() methods are not called, and\nany pre_save or\npost_save signals will be called with\nraw=True since the instance only contains attributes that are local to the\nmodel. You may, for example, want to disable handlers that access\nrelated fields that aren’t present during fixture loading and would otherwise\nraise an exception:
from django.db.models.signals import post_save\nfrom .models import MyModel\n\ndef my_handler(**kwargs):\n # disable the handler during fixture loading\n if kwargs['raw']:\n return\n ...\n\npost_save.connect(my_handler, sender=MyModel)\nYou could also write a simple decorator to encapsulate this logic:
\nfrom functools import wraps\n\ndef disable_for_loaddata(signal_handler):\n """\n Decorator that turns off signal handlers when loading fixture data.\n """\n @wraps(signal_handler)\n def wrapper(*args, **kwargs):\n if kwargs['raw']:\n return\n signal_handler(*args, **kwargs)\n return wrapper\n\n@disable_for_loaddata\ndef my_handler(**kwargs):\n ...\nJust be aware that this logic will disable the signals whenever fixtures are\ndeserialized, not just during loaddata.
Note that the order in which fixture files are processed is undefined. However,\nall fixture data is installed as a single transaction, so data in\none fixture can reference data in another fixture. If the database backend\nsupports row-level constraints, these constraints will be checked at the\nend of the transaction.
\nThe dumpdata command can be used to generate input for loaddata.
Fixtures may be compressed in zip, gz, or bz2 format. For example:
django-admin loaddata mydata.json\nwould look for any of mydata.json, mydata.json.zip,\nmydata.json.gz, or mydata.json.bz2. The first file contained within a\nzip-compressed archive is used.
Note that if two fixtures with the same name but different\nfixture type are discovered (for example, if mydata.json and\nmydata.xml.gz were found in the same fixture directory), fixture\ninstallation will be aborted, and any data installed in the call to\nloaddata will be removed from the database.
If you’re in a multi-database setup, you might have fixture data that\nyou want to load onto one database, but not onto another. In this\nsituation, you can add a database identifier into the names of your fixtures.
\nFor example, if your DATABASES setting has a ‘master’ database\ndefined, name the fixture mydata.master.json or\nmydata.master.json.gz and the fixture will only be loaded when you\nspecify you want to load data into the master database.
Runs over the entire source tree of the current directory and pulls out all\nstrings marked for translation. It creates (or updates) a message file in the\nconf/locale (in the Django tree) or locale (for project and application)\ndirectory. After making changes to the messages files you need to compile them\nwith compilemessages for use with the builtin gettext support. See\nthe i18n documentation for details.
Use the --all or -a option to update the message files for all\navailable languages.
Example usage:
\ndjango-admin makemessages --all\nUse the --extension or -e option to specify a list of file extensions\nto examine (default: “.html”, “.txt”).
Example usage:
\ndjango-admin makemessages --locale=de --extension xhtml\nSeparate multiple extensions with commas or use -e or –extension multiple times:
\ndjango-admin makemessages --locale=de --extension=html,txt --extension xml\nUse the --locale option (or its shorter version -l) to\nspecify the locale(s) to process.
Use the --exclude option (or its shorter version -x) to\nspecify the locale(s) to exclude from processing. If not provided, no locales\nare excluded.
Example usage:
\ndjango-admin makemessages --locale=pt_BR\ndjango-admin makemessages --locale=pt_BR --locale=fr\ndjango-admin makemessages -l pt_BR\ndjango-admin makemessages -l pt_BR -l fr\ndjango-admin makemessages --exclude=pt_BR\ndjango-admin makemessages --exclude=pt_BR --exclude=fr\ndjango-admin makemessages -x pt_BR\ndjango-admin makemessages -x pt_BR -x fr\nUse the --domain or -d option to change the domain of the messages files.\nCurrently supported:
django for all *.py, *.html and *.txt files (default)
djangojs for *.js files
Use the --symlinks or -s option to follow symlinks to directories when\nlooking for new translation strings.
Example usage:
\ndjango-admin makemessages --locale=de --symlinks\nUse the --ignore or -i option to ignore files or directories matching\nthe given glob-style pattern. Use multiple times to ignore more.
These patterns are used by default: 'CVS', '.*', '*~', '*.pyc'
Example usage:
\ndjango-admin makemessages --locale=en_US --ignore=apps/* --ignore=secret/*.html\nUse the --no-default-ignore option to disable the default values of\n--ignore.
Use the --no-wrap option to disable breaking long message lines into\nseveral lines in language files.
Use the --no-location option to suppress writing ‘#: filename:line’\ncomment lines in language files. Note that using this option makes it harder\nfor technically skilled translators to understand each message’s context.
Use the --keep-pot option to prevent Django from deleting the temporary\n.pot files it generates before creating the .po file. This is useful for\ndebugging errors which may prevent the final language files from being created.
Creates new migrations based on the changes detected to your models.\nMigrations, their relationship with apps and more are covered in depth in\nthe migrations documentation.
\nProviding one or more app names as arguments will limit the migrations created\nto the app(s) specified and any dependencies needed (the table at the other end\nof a ForeignKey, for example).
The --empty option will cause makemigrations to output an empty\nmigration for the specified apps, for manual editing. This option is only\nfor advanced users and should not be used unless you are familiar with\nthe migration format, migration operations, and the dependencies between\nyour migrations.
The --dry-run option shows what migrations would be made without\nactually writing any migrations files to disk. Using this option along with\n--verbosity 3 will also show the complete migrations files that would be\nwritten.
The --merge option enables fixing of migration conflicts. The\n--noinput option may be provided to suppress user prompts during\na merge.
The --name option allows you to give the migration(s) a custom name instead\nof a generated one.
The --exit option will cause makemigrations to exit with error code 1\nwhen no migrations are created (or would have been created, if combined with\n--dry-run).
Synchronizes the database state with the current set of models and migrations.\nMigrations, their relationship with apps and more are covered in depth in\nthe migrations documentation.
\nThe behavior of this command changes depending on the arguments provided:
\nNo arguments: All migrated apps have all of their migrations run,\nand all unmigrated apps are synchronized with the database,
<app_label>: The specified app has its migrations run, up to the most\nrecent migration. This may involve running other apps’ migrations too, due\nto dependencies.
<app_label> <migrationname>: Brings the database schema to a state where\nthe named migration is applied, but no later migrations in the same app are\napplied. This may involve unapplying migrations if you have previously\nmigrated past the named migration. Use the name zero to unapply all\nmigrations for an app.
Unlike syncdb, this command does not prompt you to create a superuser if\none doesn’t exist (assuming you are using django.contrib.auth). Use\ncreatesuperuser to do that if you wish.
The --database option can be used to specify the database to\nmigrate.
The --fake option tells Django to mark the migrations as having been\napplied or unapplied, but without actually running the SQL to change your\ndatabase schema.
This is intended for advanced users to manipulate the\ncurrent migration state directly if they’re manually applying changes;\nbe warned that using --fake runs the risk of putting the migration state\ntable into a state where manual recovery will be needed to make migrations\nrun correctly.
The --fake-initial option can be used to allow Django to skip an app’s\ninitial migration if all database tables with the names of all models created\nby all CreateModel operations in that\nmigration already exist. This option is intended for use when first running\nmigrations against a database that preexisted the use of migrations. This\noption does not, however, check for matching database schema beyond matching\ntable names and so is only safe to use if you are confident that your existing\nschema matches what is recorded in your initial migration.
Starts a set of FastCGI processes suitable for use with any Web server that\nsupports the FastCGI protocol. See the FastCGI deployment documentation for details. Requires the Python FastCGI module from\nflup.
\nInternally, this wraps the WSGI application object specified by the\nWSGI_APPLICATION setting.
The options accepted by this command are passed to the FastCGI library and\ndon’t use the '--' prefix as is usual for other Django management commands.
protocol=PROTOCOL
Protocol to use. PROTOCOL can be fcgi, scgi, ajp, etc.\n(default is fcgi)
host=HOSTNAME
Hostname to listen on.
\nport=PORTNUM
Port to listen on.
\nsocket=FILE
UNIX socket to listen on.
\nmethod=IMPL
Possible values: prefork or threaded (default prefork)
maxrequests=NUMBER
Number of requests a child handles before it is killed and a new child is\nforked (0 means no limit).
\nmaxspare=NUMBER
Max number of spare processes / threads.
\nminspare=NUMBER
Min number of spare processes / threads.
\nmaxchildren=NUMBER
Hard limit number of processes / threads.
\ndaemonize=BOOL
Whether to detach from terminal.
\npidfile=FILE
Write the spawned process-id to file FILE.
\nworkdir=DIRECTORY
Change to directory DIRECTORY when daemonizing.
\ndebug=BOOL
Set to true to enable flup tracebacks.
\noutlog=FILE
Write stdout to the FILE file.
\nerrlog=FILE
Write stderr to the FILE file.
\numask=UMASK
Umask to use when daemonizing. The value is interpreted as an octal number\n(default value is 0o22).
Example usage:
\ndjango-admin runfcgi socket=/tmp/fcgi.sock method=prefork daemonize=true \\\n pidfile=/var/run/django-fcgi.pid\nRun a FastCGI server as a daemon and write the spawned PID in a file.
\nStarts a lightweight development Web server on the local machine. By default,\nthe server runs on port 8000 on the IP address 127.0.0.1. You can pass in an\nIP address and port number explicitly.
If you run this script as a user with normal privileges (recommended), you\nmight not have access to start a port on a low port number. Low port numbers\nare reserved for the superuser (root).
\nThis server uses the WSGI application object specified by the\nWSGI_APPLICATION setting.
DO NOT USE THIS SERVER IN A PRODUCTION SETTING. It has not gone through\nsecurity audits or performance tests. (And that’s how it’s gonna stay. We’re in\nthe business of making Web frameworks, not Web servers, so improving this\nserver to be able to handle a production environment is outside the scope of\nDjango.)
\nThe development server automatically reloads Python code for each request, as\nneeded. You don’t need to restart the server for code changes to take effect.\nHowever, some actions like adding files don’t trigger a restart, so you’ll\nhave to restart the server in these cases.
\n\nIf you are using Linux and install pyinotify, kernel signals will be used to\nautoreload the server (rather than polling file modification timestamps each\nsecond). This offers better scaling to large projects, reduction in response\ntime to code modification, more robust change detection, and battery usage\nreduction.
\n\nWhen you start the server, and each time you change Python code while the\nserver is running, the system check framework will check your entire Django\nproject for some common errors (see the check command). If any\nerrors are found, they will be printed to standard output.
You can run as many concurrent servers as you want, as long as they’re on\nseparate ports. Just execute django-admin runserver more than once.
Note that the default IP address, 127.0.0.1, is not accessible from other\nmachines on your network. To make your development server viewable to other\nmachines on the network, use its own IP address (e.g. 192.168.2.1) or\n0.0.0.0 or :: (with IPv6 enabled).
You can provide an IPv6 address surrounded by brackets\n(e.g. [200a::1]:8000). This will automatically enable IPv6 support.
A hostname containing ASCII-only characters can also be used.
\nIf the staticfiles contrib app is enabled\n(default in new projects) the runserver command will be overridden\nwith its own runserver command.
If migrate was not previously executed, the table that stores the\nhistory of migrations is created at first run of runserver.
Use the --noreload option to disable the use of the auto-reloader. This\nmeans any Python code changes you make while the server is running will not\ntake effect if the particular Python modules have already been loaded into\nmemory.
Example usage:
\ndjango-admin runserver --noreload\nThe development server is multithreaded by default. Use the --nothreading\noption to disable the use of threading in the development server.
Use the --ipv6 (or shorter -6) option to tell Django to use IPv6 for\nthe development server. This changes the default IP address from\n127.0.0.1 to ::1.
Example usage:
\ndjango-admin runserver --ipv6\nPort 8000 on IP address 127.0.0.1:
django-admin runserver\nPort 8000 on IP address 1.2.3.4:
django-admin runserver 1.2.3.4:8000\nPort 7000 on IP address 127.0.0.1:
django-admin runserver 7000\nPort 7000 on IP address 1.2.3.4:
django-admin runserver 1.2.3.4:7000\nPort 8000 on IPv6 address ::1:
django-admin runserver -6\nPort 7000 on IPv6 address ::1:
django-admin runserver -6 7000\nPort 7000 on IPv6 address 2001:0db8:1234:5678::9:
django-admin runserver [2001:0db8:1234:5678::9]:7000\nPort 8000 on IPv4 address of host localhost:
django-admin runserver localhost:8000\nPort 8000 on IPv6 address of host localhost:
django-admin runserver -6 localhost:8000\nBy default, the development server doesn’t serve any static files for your site\n(such as CSS files, images, things under MEDIA_URL and so forth). If\nyou want to configure Django to serve static media, read\nManaging static files (e.g. images, JavaScript, CSS).
Starts the Python interactive interpreter.
\nDjango will use IPython or bpython if either is installed. If you have a\nrich shell installed but want to force use of the “plain” Python interpreter,\nuse the --plain option, like so:
django-admin shell --plain\nIf you would like to specify either IPython or bpython as your interpreter if\nyou have both installed you can specify an alternative interpreter interface\nwith the -i or --interface options like so:
IPython:
\ndjango-admin shell -i ipython\ndjango-admin shell --interface ipython\nbpython:
\ndjango-admin shell -i bpython\ndjango-admin shell --interface bpython\nWhen the “plain” Python interactive interpreter starts (be it because\n--plain was specified or because no other interactive interface is\navailable) it reads the script pointed to by the PYTHONSTARTUP\nenvironment variable and the ~/.pythonrc.py script. If you don’t wish this\nbehavior you can use the --no-startup option. e.g.:
django-admin shell --plain --no-startup\nShows all migrations in a project.
\nThe --list option lists all of the apps Django knows about, the\nmigrations available for each app, and whether or not each migration is\napplied (marked by an [X] next to the migration name).
Apps without migrations are also listed, but have (no migrations) printed\nunder them.
The --plan option shows the migration plan Django will follow to apply\nmigrations. Any supplied app labels are ignored because the plan might go\nbeyond those apps. Same as --list, applied migrations are marked by an\n[X]. For a verbosity of 2 and above, all dependencies of a migration will\nalso be shown.
Prints the CREATE TABLE SQL statements for the given app name(s).
\nThe --database option can be used to specify the database for\nwhich to print the SQL.
Prints the CREATE TABLE and initial-data SQL statements for the given app name(s).
\nRefer to the description of sqlcustom for an explanation of how to\nspecify initial data.
The --database option can be used to specify the database for\nwhich to print the SQL.
Prints the DROP TABLE SQL statements for the given app name(s).
\nThe --database option can be used to specify the database for\nwhich to print the SQL.
Prints the custom SQL statements for the given app name(s).
\nFor each model in each specified app, this command looks for the file\n<app_label>/sql/<modelname>.sql, where <app_label> is the given app\nname and <modelname> is the model’s name in lowercase. For example, if you\nhave an app news that includes a Story model, sqlcustom will\nattempt to read a file news/sql/story.sql and append it to the output of\nthis command.
Each of the SQL files, if given, is expected to contain valid SQL. The SQL\nfiles are piped directly into the database after all of the models’\ntable-creation statements have been executed. Use this SQL hook to make any\ntable modifications, or insert any SQL functions into the database.
\nNote that the order in which the SQL files are processed is undefined.
\nThe --database option can be used to specify the database for\nwhich to print the SQL.
Prints the DROP INDEX SQL statements for the given app name(s).
\nThe --database option can be used to specify the database for\nwhich to print the SQL.
Prints the SQL statements that would be executed for the flush\ncommand.
The --database option can be used to specify the database for\nwhich to print the SQL.
Prints the CREATE INDEX SQL statements for the given app name(s).
\nThe --database option can be used to specify the database for\nwhich to print the SQL.
Prints the SQL for the named migration. This requires an active database\nconnection, which it will use to resolve constraint names; this means you must\ngenerate the SQL against a copy of the database you wish to later apply it on.
\nNote that sqlmigrate doesn’t colorize its output.
The --database option can be used to specify the database for\nwhich to generate the SQL.
By default, the SQL created is for running the migration in the forwards\ndirection. Pass --backwards to generate the SQL for\nunapplying the migration instead.
Prints the SQL statements for resetting sequences for the given app name(s).
\nSequences are indexes used by some database engines to track the next available\nnumber for automatically incremented fields.
\nUse this command to generate SQL which will fix cases where a sequence is out\nof sync with its automatically incremented field data.
\nThe --database option can be used to specify the database for\nwhich to print the SQL.
Squashes the migrations for app_label up to and including migration_name\ndown into fewer migrations, if possible. The resulting squashed migrations\ncan live alongside the unsquashed ones safely. For more information,\nplease read Squashing migrations.
By default, Django will try to optimize the operations in your migrations\nto reduce the size of the resulting file. Pass --no-optimize if this\nprocess is failing for you or creating incorrect migrations, though please\nalso file a Django bug report about the behavior, as optimization is meant\nto be safe.
Creates a Django app directory structure for the given app name in the current\ndirectory or the given destination.
\nBy default the directory created contains a models.py file and other app\ntemplate files. (See the source for more details.) If only the app\nname is given, the app directory will be created in the current working\ndirectory.
If the optional destination is provided, Django will use that existing\ndirectory rather than creating a new one. You can use ‘.’ to denote the current\nworking directory.
\nFor example:
\ndjango-admin startapp myapp /Users/jezdez/Code/myapp\nWith the --template option, you can use a custom app template by providing\neither the path to a directory with the app template file, or a path to a\ncompressed file (.tar.gz, .tar.bz2, .tgz, .tbz, .zip)\ncontaining the app template files.
For example, this would look for an app template in the given directory when\ncreating the myapp app:
django-admin startapp --template=/Users/jezdez/Code/my_app_template myapp\nDjango will also accept URLs (http, https, ftp) to compressed\narchives with the app template files, downloading and extracting them on the\nfly.
For example, taking advantage of Github’s feature to expose repositories as\nzip files, you can use a URL like:
\ndjango-admin startapp --template=https://github.com/githubuser/django-app-template/archive/master.zip myapp\nWhen Django copies the app template files, it also renders certain files\nthrough the template engine: the files whose extensions match the\n--extension option (py by default) and the files whose names are passed\nwith the --name option. The template context used is:
Any option passed to the startapp command (among the command’s supported\noptions)
app_name – the app name as passed to the command
app_directory – the full path of the newly created app
docs_version – the version of the documentation: 'dev' or '1.x'
Creates a Django project directory structure for the given project name in\nthe current directory or the given destination.
\nBy default, the new directory contains manage.py and a project package\n(containing a settings.py and other files). See the template source for\ndetails.
If only the project name is given, both the project directory and project\npackage will be named <projectname> and the project directory\nwill be created in the current working directory.
If the optional destination is provided, Django will use that existing\ndirectory as the project directory, and create manage.py and the project\npackage within it. Use ‘.’ to denote the current working directory.
For example:
\ndjango-admin startproject myproject /Users/jezdez/Code/myproject_repo\nAs with the startapp command, the --template option lets you\nspecify a directory, file path or URL of a custom project template. See the\nstartapp documentation for details of supported project template\nformats.
For example, this would look for a project template in the given directory\nwhen creating the myproject project:
django-admin startproject --template=/Users/jezdez/Code/my_project_template myproject\nDjango will also accept URLs (http, https, ftp) to compressed\narchives with the project template files, downloading and extracting them on the\nfly.
For example, taking advantage of Github’s feature to expose repositories as\nzip files, you can use a URL like:
\ndjango-admin startproject --template=https://github.com/githubuser/django-project-template/archive/master.zip myproject\nWhen Django copies the project template files, it also renders certain files\nthrough the template engine: the files whose extensions match the\n--extension option (py by default) and the files whose names are passed\nwith the --name option. The template context used is:
Any option passed to the startproject command (among the command’s\nsupported 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 the SECRET_KEY setting
docs_version – the version of the documentation: 'dev' or '1.x'
Please also see the rendering warning as mentioned\nfor startapp.
Alias for migrate, except that it also prompts you to create a\nsuperuser if one doesn’t exist (assuming you are using django.contrib.auth).
Runs tests for all installed models. See Testing in Django for more\ninformation.
\nThe --failfast option can be used to stop running tests and report the\nfailure immediately after a test fails.
The --testrunner option can be used to control the test runner class that\nis used to execute tests. If this value is provided, it overrides the value\nprovided by the TEST_RUNNER setting.
The --liveserver option can be used to override the default address where\nthe live server (used with LiveServerTestCase) is\nexpected to run from. The default value is localhost:8081.
The --keepdb option can be used to preserve the test database between test\nruns. This has the advantage of skipping both the create and destroy actions\nwhich can greatly decrease the time to run tests, especially those in a large\ntest suite. If the test database does not exist, it will be created on the first\nrun and then preserved for each subsequent run. Any unapplied migrations will also\nbe applied to the test database before running the test suite.
The --reverse option can be used to sort test cases in the opposite order.\nThis may help in debugging the side effects of tests that aren’t properly\nisolated. Grouping by test class is preserved when using\nthis option.
The --debug-sql option can be used to enable SQL logging for failing tests. If --verbosity is 2,\nthen queries in passing tests are also output.
Runs a Django development server (as in runserver) using data from\nthe given fixture(s).
For example, this command:
\ndjango-admin testserver mydata.json\n…would perform the following steps:
\nCreate a test database, as described in The test database.
Populate the test database with fixture data from the given fixtures.\n(For more on fixtures, see the documentation for loaddata above.)
Runs the Django development server (as in runserver), pointed at\nthis newly created test database instead of your production database.
This is useful in a number of ways:
\nWhen you’re writing unit tests of how your views\nact with certain fixture data, you can use testserver to interact with\nthe views in a Web browser, manually.
Let’s say you’re developing your Django application and have a “pristine”\ncopy of a database that you’d like to interact with. You can dump your\ndatabase to a fixture (using the dumpdata command, explained\nabove), then use testserver to run your Web application with that data.\nWith this arrangement, you have the flexibility of messing up your data\nin any way, knowing that whatever data changes you’re making are only\nbeing made to a test database.
Note that this server does not automatically detect changes to your Python\nsource code (as runserver does). It does, however, detect changes to\ntemplates.
Use --addrport to specify a different port, or IP address and port, from\nthe default of 127.0.0.1:8000. This value follows exactly the same format and\nserves exactly the same function as the argument to the runserver\ncommand.
Examples:
\nTo run the test server on port 7000 with fixture1 and fixture2:
django-admin testserver --addrport 7000 fixture1 fixture2\ndjango-admin testserver fixture1 fixture2 --addrport 7000\n(The above statements are equivalent. We include both of them to demonstrate\nthat it doesn’t matter whether the options come before or after the fixture\narguments.)
\nTo run on 1.2.3.4:7000 with a test fixture:
django-admin testserver --addrport 1.2.3.4:7000 test\nThe --noinput option may be provided to suppress all user\nprompts.
Validates all installed models (according to the INSTALLED_APPS\nsetting) and prints validation errors to standard output.
Some commands are only available when the django.contrib application that\nimplements them has been\nenabled. This section describes them grouped by\ntheir application.
django.contrib.authLink to this heading#This command is only available if Django’s authentication system (django.contrib.auth) is installed.
Allows changing a user’s password. It prompts you to enter a new password twice\nfor the given user. If the entries are identical, this immediately becomes the\nnew password. If you do not supply a user, the command will attempt to change\nthe password whose username matches the current user.
\nUse the --database option to specify the database to query for the user. If\nit’s not supplied, Django will use the default database.
Example usage:
\ndjango-admin changepassword ringo\nThis command is only available if Django’s authentication system (django.contrib.auth) is installed.
Creates a superuser account (a user who has all permissions). This is\nuseful if you need to create an initial superuser account or if you need to\nprogrammatically generate superuser accounts for your site(s).
\nWhen run interactively, this command will prompt for a password for\nthe new superuser account. When run non-interactively, no password\nwill be set, and the superuser account will not be able to log in until\na password has been manually set for it.
\nThe username and email address for the new account can be supplied by\nusing the --username and --email arguments on the command\nline. If either of those is not supplied, createsuperuser will prompt for\nit when running interactively.
Use the --database option to specify the database into which the superuser\nobject will be saved.
You can subclass the management command and override get_input_data() if you\nwant to customize data input and validation. Consult the source code for\ndetails on the existing implementation and the method’s parameters. For example,\nit could be useful if you have a ForeignKey in\nREQUIRED_FIELDS and want to\nallow creating an instance instead of entering the primary key of an existing\ninstance.
django.contrib.gisLink to this heading#This command is only available if GeoDjango\n(django.contrib.gis) is installed.
Please refer to its description in the GeoDjango\ndocumentation.
django.contrib.sessionsLink to this heading#Can be run as a cron job or directly to clean out expired sessions.
\ndjango.contrib.sitemapsLink to this heading#This command is only available if the Sitemaps framework (django.contrib.sitemaps) is installed.
Please refer to its description in the Sitemaps\ndocumentation.
django.contrib.staticfilesLink to this heading#This command is only available if the static files application (django.contrib.staticfiles) is installed.
Please refer to its description in the\nstaticfiles documentation.
This command is only available if the static files application (django.contrib.staticfiles) is installed.
Please refer to its description in the staticfiles documentation.
Although some commands may allow their own custom options, every command\nallows for the following options:
\nExample usage:
\ndjango-admin migrate --pythonpath='/home/djangoprojects/myproject'\nAdds the given filesystem path to the Python import search path. If this\nisn’t provided, django-admin will use the PYTHONPATH environment\nvariable.
Note that this option is unnecessary in manage.py, because it takes care of\nsetting the Python path for you.
Example usage:
\ndjango-admin migrate --settings=mysite.settings\nExplicitly specifies the settings module to use. The settings module should be\nin Python package syntax, e.g. mysite.settings. If this isn’t provided,\ndjango-admin will use the DJANGO_SETTINGS_MODULE environment\nvariable.
Note that this option is unnecessary in manage.py, because it uses\nsettings.py from the current project by default.
Example usage:
\ndjango-admin migrate --traceback\nBy default, django-admin will show a simple error message whenever a\nCommandError occurs, but a full stack trace\nfor any other exception. If you specify --traceback, django-admin\nwill also output a full stack trace when a CommandError is raised.
Example usage:
\ndjango-admin migrate --verbosity 2\nUse --verbosity to specify the amount of notification and debug information\nthat django-admin should print to the console.
0 means no output.
1 means normal output (default).
2 means verbose output.
3 means very verbose output.
Example usage:
\ndjango-admin sqlall --no-color\nBy default, django-admin will format the output to be colorized. For\nexample, errors will be printed to the console in red and SQL statements will\nbe syntax highlighted. To prevent this and have a plain text output, pass the\n--no-color option when running your command.
The following options are not available on every command, but they are common\nto a number of commands.
\nUsed to specify the database on which a command will operate. If not\nspecified, this option will default to an alias of default.
For example, to dump data from the database with the alias master:
django-admin dumpdata --database=master\nExclude a specific application from the applications whose contents is\noutput. For example, to specifically exclude the auth application from\nthe output of dumpdata, you would call:
django-admin dumpdata --exclude=auth\nIf you want to exclude multiple applications, use multiple --exclude\ndirectives:
django-admin dumpdata --exclude=auth --exclude=contenttypes\nUse the --locale or -l option to specify the locale to process.\nIf not provided all locales are processed.
Use the --noinput option to suppress all user prompting, such as “Are\nyou sure?” confirmation messages. This is useful if django-admin is\nbeing executed as an unattended, automated script.
The django-admin / manage.py commands will use pretty\ncolor-coded output if your terminal supports ANSI-colored output. It\nwon’t use the color codes if you’re piping the command’s output to\nanother program.
Under Windows, the native console doesn’t support ANSI escape sequences so by\ndefault there is no color output. But you can install the ANSICON\nthird-party tool, the Django commands will detect its presence and will make\nuse of its services to color output just like on Unix-based platforms.
\nThe colors used for syntax highlighting can be customized. Django\nships with three color palettes:
\ndark, suited to terminals that show white text on a black\nbackground. This is the default palette.
light, suited to terminals that show black text on a white\nbackground.
nocolor, which disables syntax highlighting.
You select a palette by setting a DJANGO_COLORS environment\nvariable to specify the palette you want to use. For example, to\nspecify the light palette under a Unix or OS/X BASH shell, you\nwould run the following at a command prompt:
export DJANGO_COLORS="light"\nYou can also customize the colors that are used. Django specifies a\nnumber of roles in which color is used:
\nerror - A major error.
notice - A minor error.
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 and\nbackground color, from the following list:
\nblack
red
green
yellow
blue
magenta
cyan
white
Each of these colors can then be modified by using the following\ndisplay options:
\nbold
underscore
blink
reverse
conceal
A color specification follows one of the following patterns:
\nrole=fg
role=fg/bg
role=fg,option,option
role=fg/bg,option,option
where role is the name of a valid color role, fg is the\nforeground color, bg is the background color and each option\nis one of the color modifying options. Multiple color specifications\nare then separated by a semicolon. For example:
export DJANGO_COLORS="error=yellow/blue,blink;notice=magenta"\nwould specify that errors be displayed using blinking yellow on blue,\nand notices displayed using magenta. All other color roles would be\nleft uncolored.
\nColors can also be specified by extending a base palette. If you put\na palette name in a color specification, all the colors implied by that\npalette will be loaded. So:
\nexport DJANGO_COLORS="light;error=yellow/blue,blink;notice=magenta"\nwould specify the use of all the colors in the light color palette,\nexcept for the colors for errors and notices which would be\noverridden as specified.
\n\nSupport for color-coded output from django-admin / manage.py\nutilities on Windows by relying on the ANSICON application was added in Django\n1.7.
If you use the Bash shell, consider installing the Django bash completion\nscript, which lives in extras/django_bash_completion in the Django\ndistribution. It enables tab-completion of django-admin and\nmanage.py commands, so you can, for instance…
Type django-admin.
Press [TAB] to see all available options.
Type sql, then [TAB], to see all available options whose names start\nwith sql.
See Writing custom django-admin commands for how to add customized actions.
\nTo call a management command from code use call_command.
namethe name of the command to call.
\n*argsa list of arguments accepted by the command.
\n**optionsnamed options accepted on the command-line.
\nExamples:
\nfrom django.core import management\nmanagement.call_command('flush', verbosity=0, interactive=False)\nmanagement.call_command('loaddata', 'test_data', verbosity=0)\nNote that command options that take no arguments are passed as keywords\nwith True or False, as you can see with the interactive option above.
Named arguments can be passed by using either one of the following syntaxes:
\n# Similar to the command line\nmanagement.call_command('dumpdata', '--natural-foreign')\n\n# Named argument similar to the command line minus the initial dashes and\n# with internal dashes replaced by underscores\nmanagement.call_command('dumpdata', natural_foreign=True)\n\n# `use_natural_foreign_keys` is the option destination variable\nmanagement.call_command('dumpdata', use_natural_foreign_keys=True)\nCommand options which take multiple options are passed a list:
\nmanagement.call_command('dumpdata', exclude=['contenttypes', 'auth'])\nNote that you can redirect standard output and error streams as all commands\nsupport the stdout and stderr options. For example, you could write:
with open('/path/to/command_output') as f:\n management.call_command('dumpdata', stdout=f)\n