django-admin.txt 57 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747
  1. =============================
  2. django-admin.py and manage.py
  3. =============================
  4. ``django-admin.py`` is Django's command-line utility for administrative tasks.
  5. This document outlines all it can do.
  6. In addition, ``manage.py`` is automatically created in each Django project.
  7. ``manage.py`` is a thin wrapper around ``django-admin.py`` that takes care of
  8. two things for you before delegating to ``django-admin.py``:
  9. * It puts your project's package on ``sys.path``.
  10. * It sets the :envvar:`DJANGO_SETTINGS_MODULE` environment variable so that
  11. it points to your project's ``settings.py`` file.
  12. * It calls ``django.setup()`` to initialize various internals of Django.
  13. .. versionadded:: 1.7
  14. ``django.setup()`` didn't exist in previous versions of Django.
  15. The ``django-admin.py`` script should be on your system path if you installed
  16. Django via its ``setup.py`` utility. If it's not on your path, you can find it
  17. in ``site-packages/django/bin`` within your Python installation. Consider
  18. symlinking it from some place on your path, such as ``/usr/local/bin``.
  19. For Windows users, who do not have symlinking functionality available, you can
  20. copy ``django-admin.py`` to a location on your existing path or edit the
  21. ``PATH`` settings (under ``Settings - Control Panel - System - Advanced -
  22. Environment...``) to point to its installed location.
  23. Generally, when working on a single Django project, it's easier to use
  24. ``manage.py`` than ``django-admin.py``. If you need to switch between multiple
  25. Django settings files, use ``django-admin.py`` with
  26. :envvar:`DJANGO_SETTINGS_MODULE` or the :djadminopt:`--settings` command line
  27. option.
  28. The command-line examples throughout this document use ``django-admin.py`` to
  29. be consistent, but any example can use ``manage.py`` just as well.
  30. Usage
  31. =====
  32. .. code-block:: bash
  33. $ django-admin.py <command> [options]
  34. $ manage.py <command> [options]
  35. ``command`` should be one of the commands listed in this document.
  36. ``options``, which is optional, should be zero or more of the options available
  37. for the given command.
  38. Getting runtime help
  39. --------------------
  40. .. django-admin:: help
  41. Run ``django-admin.py help`` to display usage information and a list of the
  42. commands provided by each application.
  43. Run ``django-admin.py help --commands`` to display a list of all available
  44. commands.
  45. Run ``django-admin.py help <command>`` to display a description of the given
  46. command and a list of its available options.
  47. App names
  48. ---------
  49. Many commands take a list of "app names." An "app name" is the basename of
  50. the package containing your models. For example, if your :setting:`INSTALLED_APPS`
  51. contains the string ``'mysite.blog'``, the app name is ``blog``.
  52. Determining the version
  53. -----------------------
  54. .. django-admin:: version
  55. Run ``django-admin.py version`` to display the current Django version.
  56. The output follows the schema described in :pep:`386`::
  57. 1.4.dev17026
  58. 1.4a1
  59. 1.4
  60. Displaying debug output
  61. -----------------------
  62. Use :djadminopt:`--verbosity` to specify the amount of notification and debug information
  63. that ``django-admin.py`` should print to the console. For more details, see the
  64. documentation for the :djadminopt:`--verbosity` option.
  65. Available commands
  66. ==================
  67. check <appname appname ...>
  68. ---------------------------
  69. .. django-admin:: check
  70. .. versionchanged:: 1.7
  71. Uses the :doc:`system check framework </ref/checks>` to inspect
  72. the entire Django project for common problems.
  73. The system check framework will confirm that there aren't any problems with
  74. your installed models or your admin registrations. It will also provide warnings
  75. of common compatibility problems introduced by upgrading Django to a new version.
  76. Custom checks may be introduced by other libraries and applications.
  77. By default, all apps will be checked. You can check a subset of apps by providing
  78. a list of app labels as arguments::
  79. python manage.py check auth admin myapp
  80. If you do not specify any app, all apps will be checked.
  81. .. django-admin-option:: --tag <tagname>
  82. The :doc:`system check framework </ref/checks>` performs many different
  83. types of checks. These check types are categorized with tags. You can use these tags
  84. to restrict the checks performed to just those in a particular category. For example,
  85. to perform only security and compatibility checks, you would run::
  86. python manage.py check --tag security --tag compatibility
  87. .. django-admin-option:: --list-tags
  88. List all available tags.
  89. compilemessages
  90. ---------------
  91. .. django-admin:: compilemessages
  92. Compiles .po files created by :djadmin:`makemessages` to .mo files for use with
  93. the builtin gettext support. See :doc:`/topics/i18n/index`.
  94. Use the :djadminopt:`--locale` option (or its shorter version ``-l``) to
  95. specify the locale(s) to process. If not provided, all locales are processed.
  96. Example usage::
  97. django-admin.py compilemessages --locale=pt_BR
  98. django-admin.py compilemessages --locale=pt_BR --locale=fr
  99. django-admin.py compilemessages -l pt_BR
  100. django-admin.py compilemessages -l pt_BR -l fr
  101. createcachetable
  102. ----------------
  103. .. django-admin:: createcachetable
  104. Creates the cache tables for use with the database cache backend. See
  105. :doc:`/topics/cache` for more information.
  106. The :djadminopt:`--database` option can be used to specify the database
  107. onto which the cachetable will be installed.
  108. .. versionchanged:: 1.7
  109. It is no longer necessary to provide the cache table name or the
  110. :djadminopt:`--database` option. Django takes this information from your
  111. settings file. If you have configured multiple caches or multiple databases,
  112. all cache tables are created.
  113. dbshell
  114. -------
  115. .. django-admin:: dbshell
  116. Runs the command-line client for the database engine specified in your
  117. ``ENGINE`` setting, with the connection parameters specified in your
  118. :setting:`USER`, :setting:`PASSWORD`, etc., settings.
  119. * For PostgreSQL, this runs the ``psql`` command-line client.
  120. * For MySQL, this runs the ``mysql`` command-line client.
  121. * For SQLite, this runs the ``sqlite3`` command-line client.
  122. This command assumes the programs are on your ``PATH`` so that a simple call to
  123. the program name (``psql``, ``mysql``, ``sqlite3``) will find the program in
  124. the right place. There's no way to specify the location of the program
  125. manually.
  126. The :djadminopt:`--database` option can be used to specify the database
  127. onto which to open a shell.
  128. diffsettings
  129. ------------
  130. .. django-admin:: diffsettings
  131. Displays differences between the current settings file and Django's default
  132. settings.
  133. Settings that don't appear in the defaults are followed by ``"###"``. For
  134. example, the default settings don't define :setting:`ROOT_URLCONF`, so
  135. :setting:`ROOT_URLCONF` is followed by ``"###"`` in the output of
  136. ``diffsettings``.
  137. The :djadminopt:`--all` option may be provided to display all settings, even
  138. if they have Django's default value. Such settings are prefixed by ``"###"``.
  139. dumpdata <app_label app_label app_label.Model ...>
  140. --------------------------------------------------
  141. .. django-admin:: dumpdata
  142. Outputs to standard output all data in the database associated with the named
  143. application(s).
  144. If no application name is provided, all installed applications will be dumped.
  145. The output of ``dumpdata`` can be used as input for :djadmin:`loaddata`.
  146. Note that ``dumpdata`` uses the default manager on the model for selecting the
  147. records to dump. If you're using a :ref:`custom manager <custom-managers>` as
  148. the default manager and it filters some of the available records, not all of the
  149. objects will be dumped.
  150. The :djadminopt:`--all` option may be provided to specify that
  151. ``dumpdata`` should use Django's base manager, dumping records which
  152. might otherwise be filtered or modified by a custom manager.
  153. .. django-admin-option:: --format <fmt>
  154. By default, ``dumpdata`` will format its output in JSON, but you can use the
  155. ``--format`` option to specify another format. Currently supported formats
  156. are listed in :ref:`serialization-formats`.
  157. .. django-admin-option:: --indent <num>
  158. By default, ``dumpdata`` will output all data on a single line. This isn't
  159. easy for humans to read, so you can use the ``--indent`` option to
  160. pretty-print the output with a number of indentation spaces.
  161. The :djadminopt:`--exclude` option may be provided to prevent specific
  162. applications or models (specified as in the form of ``app_label.ModelName``)
  163. from being dumped. If you specify a model name to ``dumpdata``, the dumped
  164. output will be restricted to that model, rather than the entire application.
  165. You can also mix application names and model names.
  166. The :djadminopt:`--database` option can be used to specify the database
  167. from which data will be dumped.
  168. .. django-admin-option:: --natural-foreign
  169. .. versionadded:: 1.7
  170. When this option is specified, Django will use the ``natural_key()`` model
  171. method to serialize any foreign key and many-to-many relationship to objects of
  172. the type that defines the method. If you are dumping ``contrib.auth``
  173. ``Permission`` objects or ``contrib.contenttypes`` ``ContentType`` objects, you
  174. should probably be using this flag. See the :ref:`natural keys
  175. <topics-serialization-natural-keys>` documentation for more details on this
  176. and the next option.
  177. .. django-admin-option:: --natural-primary
  178. .. versionadded:: 1.7
  179. When this option is specified, Django will not provide the primary key in the
  180. serialized data of this object since it can be calculated during
  181. deserialization.
  182. .. django-admin-option:: --natural
  183. .. deprecated:: 1.7
  184. Equivalent to the :djadminopt:`--natural-foreign` option; use that instead.
  185. Use :ref:`natural keys <topics-serialization-natural-keys>` to represent
  186. any foreign key and many-to-many relationship with a model that provides
  187. a natural key definition.
  188. .. django-admin-option:: --pks
  189. By default, ``dumpdata`` will output all the records of the model, but
  190. you can use the ``--pks`` option to specify a comma separated list of
  191. primary keys on which to filter. This is only available when dumping
  192. one model.
  193. .. django-admin-option:: --output
  194. .. versionadded:: 1.8
  195. By default ``dumpdata`` will output all the serialized data to standard output.
  196. This options allows to specify the file to which the data is to be written.
  197. flush
  198. -----
  199. .. django-admin:: flush
  200. Removes all data from the database, re-executes any post-synchronization
  201. handlers, and reinstalls any initial data fixtures.
  202. The :djadminopt:`--noinput` option may be provided to suppress all user
  203. prompts.
  204. The :djadminopt:`--database` option may be used to specify the database
  205. to flush.
  206. ``--no-initial-data``
  207. ~~~~~~~~~~~~~~~~~~~~~
  208. Use ``--no-initial-data`` to avoid loading the initial_data fixture.
  209. inspectdb
  210. ---------
  211. .. django-admin:: inspectdb
  212. Introspects the database tables in the database pointed-to by the
  213. :setting:`NAME` setting and outputs a Django model module (a ``models.py``
  214. file) to standard output.
  215. Use this if you have a legacy database with which you'd like to use Django.
  216. The script will inspect the database and create a model for each table within
  217. it.
  218. As you might expect, the created models will have an attribute for every field
  219. in the table. Note that ``inspectdb`` has a few special cases in its field-name
  220. output:
  221. * If ``inspectdb`` cannot map a column's type to a model field type, it'll
  222. use ``TextField`` and will insert the Python comment
  223. ``'This field type is a guess.'`` next to the field in the generated
  224. model.
  225. * If the database column name is a Python reserved word (such as
  226. ``'pass'``, ``'class'`` or ``'for'``), ``inspectdb`` will append
  227. ``'_field'`` to the attribute name. For example, if a table has a column
  228. ``'for'``, the generated model will have a field ``'for_field'``, with
  229. the ``db_column`` attribute set to ``'for'``. ``inspectdb`` will insert
  230. the Python comment
  231. ``'Field renamed because it was a Python reserved word.'`` next to the
  232. field.
  233. This feature is meant as a shortcut, not as definitive model generation. After
  234. you run it, you'll want to look over the generated models yourself to make
  235. customizations. In particular, you'll need to rearrange models' order, so that
  236. models that refer to other models are ordered properly.
  237. Primary keys are automatically introspected for PostgreSQL, MySQL and
  238. SQLite, in which case Django puts in the ``primary_key=True`` where
  239. needed.
  240. ``inspectdb`` works with PostgreSQL, MySQL and SQLite. Foreign-key detection
  241. only works in PostgreSQL and with certain types of MySQL tables.
  242. By default, ``inspectdb`` creates unmanaged models. That is, ``managed = False``
  243. in the model's ``Meta`` class tells Django not to manage each table's creation,
  244. modification, and deletion. If you do want to allow Django to manage the
  245. table's lifecycle, you'll need to change the
  246. :attr:`~django.db.models.Options.managed` option to ``True`` (or simply remove
  247. it because ``True`` is its default value).
  248. The :djadminopt:`--database` option may be used to specify the
  249. database to introspect.
  250. loaddata <fixture fixture ...>
  251. ------------------------------
  252. .. django-admin:: loaddata
  253. Searches for and loads the contents of the named fixture into the database.
  254. The :djadminopt:`--database` option can be used to specify the database
  255. onto which the data will be loaded.
  256. .. django-admin-option:: --ignorenonexistent
  257. The :djadminopt:`--ignorenonexistent` option can be used to ignore fields that
  258. may have been removed from models since the fixture was originally generated.
  259. .. versionchanged:: 1.7
  260. ``--app`` was added.
  261. .. django-admin-option:: --app
  262. The :djadminopt:`--app` option can be used to specify a single app to look
  263. for fixtures in rather than looking through all apps.
  264. What's a "fixture"?
  265. ~~~~~~~~~~~~~~~~~~~
  266. A *fixture* is a collection of files that contain the serialized contents of
  267. the database. Each fixture has a unique name, and the files that comprise the
  268. fixture can be distributed over multiple directories, in multiple applications.
  269. Django will search in three locations for fixtures:
  270. 1. In the ``fixtures`` directory of every installed application
  271. 2. In any directory named in the :setting:`FIXTURE_DIRS` setting
  272. 3. In the literal path named by the fixture
  273. Django will load any and all fixtures it finds in these locations that match
  274. the provided fixture names.
  275. If the named fixture has a file extension, only fixtures of that type
  276. will be loaded. For example::
  277. django-admin.py loaddata mydata.json
  278. would only load JSON fixtures called ``mydata``. The fixture extension
  279. must correspond to the registered name of a
  280. :ref:`serializer <serialization-formats>` (e.g., ``json`` or ``xml``).
  281. If you omit the extensions, Django will search all available fixture types
  282. for a matching fixture. For example::
  283. django-admin.py loaddata mydata
  284. would look for any fixture of any fixture type called ``mydata``. If a fixture
  285. directory contained ``mydata.json``, that fixture would be loaded
  286. as a JSON fixture.
  287. The fixtures that are named can include directory components. These
  288. directories will be included in the search path. For example::
  289. django-admin.py loaddata foo/bar/mydata.json
  290. would search ``<app_label>/fixtures/foo/bar/mydata.json`` for each installed
  291. application, ``<dirname>/foo/bar/mydata.json`` for each directory in
  292. :setting:`FIXTURE_DIRS`, and the literal path ``foo/bar/mydata.json``.
  293. When fixture files are processed, the data is saved to the database as is.
  294. Model defined :meth:`~django.db.models.Model.save` methods are not called, and
  295. any :data:`~django.db.models.signals.pre_save` or
  296. :data:`~django.db.models.signals.post_save` signals will be called with
  297. ``raw=True`` since the instance only contains attributes that are local to the
  298. model. You may, for example, want to disable handlers that access
  299. related fields that aren't present during fixture loading and would otherwise
  300. raise an exception::
  301. from django.db.models.signals import post_save
  302. from .models import MyModel
  303. def my_handler(**kwargs):
  304. # disable the handler during fixture loading
  305. if kwargs['raw']:
  306. return
  307. ...
  308. post_save.connect(my_handler, sender=MyModel)
  309. You could also write a simple decorator to encapsulate this logic::
  310. from functools import wraps
  311. def disable_for_loaddata(signal_handler):
  312. """
  313. Decorator that turns off signal handlers when loading fixture data.
  314. """
  315. @wraps(signal_handler)
  316. def wrapper(*args, **kwargs):
  317. if kwargs['raw']:
  318. return
  319. signal_handler(*args, **kwargs)
  320. return wrapper
  321. @disable_for_loaddata
  322. def my_handler(**kwargs):
  323. ...
  324. Just be aware that this logic will disable the signals whenever fixtures are
  325. deserialized, not just during ``loaddata``.
  326. Note that the order in which fixture files are processed is undefined. However,
  327. all fixture data is installed as a single transaction, so data in
  328. one fixture can reference data in another fixture. If the database backend
  329. supports row-level constraints, these constraints will be checked at the
  330. end of the transaction.
  331. The :djadmin:`dumpdata` command can be used to generate input for ``loaddata``.
  332. Compressed fixtures
  333. ~~~~~~~~~~~~~~~~~~~
  334. Fixtures may be compressed in ``zip``, ``gz``, or ``bz2`` format. For example::
  335. django-admin.py loaddata mydata.json
  336. would look for any of ``mydata.json``, ``mydata.json.zip``,
  337. ``mydata.json.gz``, or ``mydata.json.bz2``. The first file contained within a
  338. zip-compressed archive is used.
  339. Note that if two fixtures with the same name but different
  340. fixture type are discovered (for example, if ``mydata.json`` and
  341. ``mydata.xml.gz`` were found in the same fixture directory), fixture
  342. installation will be aborted, and any data installed in the call to
  343. ``loaddata`` will be removed from the database.
  344. .. admonition:: MySQL with MyISAM and fixtures
  345. The MyISAM storage engine of MySQL doesn't support transactions or
  346. constraints, so if you use MyISAM, you won't get validation of fixture
  347. data, or a rollback if multiple transaction files are found.
  348. Database-specific fixtures
  349. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  350. If you're in a multi-database setup, you might have fixture data that
  351. you want to load onto one database, but not onto another. In this
  352. situation, you can add database identifier into the names of your fixtures.
  353. For example, if your :setting:`DATABASES` setting has a 'master' database
  354. defined, name the fixture ``mydata.master.json`` or
  355. ``mydata.master.json.gz`` and the fixture will only be loaded when you
  356. specify you want to load data into the ``master`` database.
  357. makemessages
  358. ------------
  359. .. django-admin:: makemessages
  360. Runs over the entire source tree of the current directory and pulls out all
  361. strings marked for translation. It creates (or updates) a message file in the
  362. conf/locale (in the Django tree) or locale (for project and application)
  363. directory. After making changes to the messages files you need to compile them
  364. with :djadmin:`compilemessages` for use with the builtin gettext support. See
  365. the :ref:`i18n documentation <how-to-create-language-files>` for details.
  366. .. django-admin-option:: --all
  367. Use the ``--all`` or ``-a`` option to update the message files for all
  368. available languages.
  369. Example usage::
  370. django-admin.py makemessages --all
  371. .. django-admin-option:: --extension
  372. Use the ``--extension`` or ``-e`` option to specify a list of file extensions
  373. to examine (default: ".html", ".txt").
  374. Example usage::
  375. django-admin.py makemessages --locale=de --extension xhtml
  376. Separate multiple extensions with commas or use -e or --extension multiple times::
  377. django-admin.py makemessages --locale=de --extension=html,txt --extension xml
  378. Use the :djadminopt:`--locale` option (or its shorter version ``-l``) to
  379. specify the locale(s) to process.
  380. Example usage::
  381. django-admin.py makemessages --locale=pt_BR
  382. django-admin.py makemessages --locale=pt_BR --locale=fr
  383. django-admin.py makemessages -l pt_BR
  384. django-admin.py makemessages -l pt_BR -l fr
  385. .. versionchanged:: 1.7
  386. Added the ``--previous`` option to the ``msgmerge`` command when merging
  387. with existing po files.
  388. .. django-admin-option:: --domain
  389. Use the ``--domain`` or ``-d`` option to change the domain of the messages files.
  390. Currently supported:
  391. * ``django`` for all ``*.py``, ``*.html`` and ``*.txt`` files (default)
  392. * ``djangojs`` for ``*.js`` files
  393. .. django-admin-option:: --symlinks
  394. Use the ``--symlinks`` or ``-s`` option to follow symlinks to directories when
  395. looking for new translation strings.
  396. Example usage::
  397. django-admin.py makemessages --locale=de --symlinks
  398. .. django-admin-option:: --ignore
  399. Use the ``--ignore`` or ``-i`` option to ignore files or directories matching
  400. the given :mod:`glob`-style pattern. Use multiple times to ignore more.
  401. These patterns are used by default: ``'CVS'``, ``'.*'``, ``'*~'``, ``'*.pyc'``
  402. Example usage::
  403. django-admin.py makemessages --locale=en_US --ignore=apps/* --ignore=secret/*.html
  404. .. django-admin-option:: --no-default-ignore
  405. Use the ``--no-default-ignore`` option to disable the default values of
  406. :djadminopt:`--ignore`.
  407. .. django-admin-option:: --no-wrap
  408. Use the ``--no-wrap`` option to disable breaking long message lines into
  409. several lines in language files.
  410. .. django-admin-option:: --no-location
  411. Use the ``--no-location`` option to not write '``#: filename:line``’
  412. comment lines in language files. Note that using this option makes it harder
  413. for technically skilled translators to understand each message's context.
  414. .. django-admin-option:: --keep-pot
  415. Use the ``--keep-pot`` option to prevent Django from deleting the temporary
  416. .pot files it generates before creating the .po file. This is useful for
  417. debugging errors which may prevent the final language files from being created.
  418. makemigrations [<app_label>]
  419. ----------------------------
  420. .. django-admin:: makemigrations
  421. .. versionadded:: 1.7
  422. Creates new migrations based on the changes detected to your models.
  423. Migrations, their relationship with apps and more are covered in depth in
  424. :doc:`the migrations documentation</topics/migrations>`.
  425. Providing one or more app names as arguments will limit the migrations created
  426. to the app(s) specified and any dependencies needed (the table at the other end
  427. of a ``ForeignKey``, for example).
  428. .. django-admin-option:: --empty
  429. The ``--empty`` option will cause ``makemigrations`` to output an empty
  430. migration for the specified apps, for manual editing. This option is only
  431. for advanced users and should not be used unless you are familiar with
  432. the migration format, migration operations, and the dependencies between
  433. your migrations.
  434. migrate [<app_label> [<migrationname>]]
  435. ---------------------------------------
  436. .. django-admin:: migrate
  437. .. versionadded:: 1.7
  438. Synchronizes the database state with the current set of models and migrations.
  439. Migrations, their relationship with apps and more are covered in depth in
  440. :doc:`the migrations documentation</topics/migrations>`.
  441. The behavior of this command changes depending on the arguments provided:
  442. * No arguments: All migrated apps have all of their migrations run,
  443. and all unmigrated apps are synchronized with the database,
  444. * ``<app_label>``: The specified app has its migrations run, up to the most
  445. recent migration. This may involve running other apps' migrations too, due
  446. to dependencies.
  447. * ``<app_label> <migrationname>``: Brings the database schema to a state where it
  448. would have just run the given migration, but no further - this may involve
  449. unapplying migrations if you have previously migrated past the named
  450. migration. Use the name `zero` to unapply all migrations for an app.
  451. runfcgi [options]
  452. -----------------
  453. .. django-admin:: runfcgi
  454. .. deprecated:: 1.7
  455. FastCGI support is deprecated and will be removed in Django 1.9.
  456. Starts a set of FastCGI processes suitable for use with any Web server that
  457. supports the FastCGI protocol. See the :doc:`FastCGI deployment documentation
  458. </howto/deployment/fastcgi>` for details. Requires the Python FastCGI module from
  459. `flup`_.
  460. Internally, this wraps the WSGI application object specified by the
  461. :setting:`WSGI_APPLICATION` setting.
  462. .. _flup: http://www.saddi.com/software/flup/
  463. The options accepted by this command are passed to the FastCGI library and
  464. don't use the ``'--'`` prefix as is usual for other Django management commands.
  465. .. django-admin-option:: protocol
  466. ``protocol=PROTOCOL``
  467. Protocol to use. *PROTOCOL* can be ``fcgi``, ``scgi``, ``ajp``, etc.
  468. (default is ``fcgi``)
  469. .. django-admin-option:: host
  470. ``host=HOSTNAME``
  471. Hostname to listen on.
  472. .. django-admin-option:: port
  473. ``port=PORTNUM``
  474. Port to listen on.
  475. .. django-admin-option:: socket
  476. ``socket=FILE``
  477. UNIX socket to listen on.
  478. .. django-admin-option:: method
  479. ``method=IMPL``
  480. Possible values: ``prefork`` or ``threaded`` (default ``prefork``)
  481. .. django-admin-option:: maxrequests
  482. ``maxrequests=NUMBER``
  483. Number of requests a child handles before it is killed and a new child is
  484. forked (0 means no limit).
  485. .. django-admin-option:: maxspare
  486. ``maxspare=NUMBER``
  487. Max number of spare processes / threads.
  488. .. django-admin-option:: minspare
  489. ``minspare=NUMBER``
  490. Min number of spare processes / threads.
  491. .. django-admin-option:: maxchildren
  492. ``maxchildren=NUMBER``
  493. Hard limit number of processes / threads.
  494. .. django-admin-option:: daemonize
  495. ``daemonize=BOOL``
  496. Whether to detach from terminal.
  497. .. django-admin-option:: pidfile
  498. ``pidfile=FILE``
  499. Write the spawned process-id to file *FILE*.
  500. .. django-admin-option:: workdir
  501. ``workdir=DIRECTORY``
  502. Change to directory *DIRECTORY* when daemonizing.
  503. .. django-admin-option:: debug
  504. ``debug=BOOL``
  505. Set to true to enable flup tracebacks.
  506. .. django-admin-option:: outlog
  507. ``outlog=FILE``
  508. Write stdout to the *FILE* file.
  509. .. django-admin-option:: errlog
  510. ``errlog=FILE``
  511. Write stderr to the *FILE* file.
  512. .. django-admin-option:: umask
  513. ``umask=UMASK``
  514. Umask to use when daemonizing. The value is interpreted as an octal number
  515. (default value is ``022``).
  516. Example usage::
  517. django-admin.py runfcgi socket=/tmp/fcgi.sock method=prefork daemonize=true \
  518. pidfile=/var/run/django-fcgi.pid
  519. Run a FastCGI server as a daemon and write the spawned PID in a file.
  520. runserver [port or address:port]
  521. --------------------------------
  522. .. django-admin:: runserver
  523. Starts a lightweight development Web server on the local machine. By default,
  524. the server runs on port 8000 on the IP address ``127.0.0.1``. You can pass in an
  525. IP address and port number explicitly.
  526. If you run this script as a user with normal privileges (recommended), you
  527. might not have access to start a port on a low port number. Low port numbers
  528. are reserved for the superuser (root).
  529. This server uses the WSGI application object specified by the
  530. :setting:`WSGI_APPLICATION` setting.
  531. DO NOT USE THIS SERVER IN A PRODUCTION SETTING. It has not gone through
  532. security audits or performance tests. (And that's how it's gonna stay. We're in
  533. the business of making Web frameworks, not Web servers, so improving this
  534. server to be able to handle a production environment is outside the scope of
  535. Django.)
  536. The development server automatically reloads Python code for each request, as
  537. needed. You don't need to restart the server for code changes to take effect.
  538. However, some actions like adding files don't trigger a restart, so you'll
  539. have to restart the server in these cases.
  540. .. versionchanged:: 1.7
  541. Compiling translation files now also restarts the development server.
  542. If you are using Linux and install `pyinotify`_, kernel signals will be used to
  543. autoreload the server (rather than polling file modification timestamps each
  544. second). This offers better scaling to large projects, reduction in response
  545. time to code modification, more robust change detection, and battery usage
  546. reduction.
  547. .. _pyinotify: https://pypi.python.org/pypi/pyinotify/
  548. .. versionadded:: 1.7
  549. ``pyinotify`` support was added.
  550. When you start the server, and each time you change Python code while the
  551. server is running, the server will check your entire Django project for errors (see
  552. the :djadmin:`check` command). If any errors are found, they will be printed
  553. to standard output, but it won't stop the server.
  554. You can run as many servers as you want, as long as they're on separate ports.
  555. Just execute ``django-admin.py runserver`` more than once.
  556. Note that the default IP address, ``127.0.0.1``, is not accessible from other
  557. machines on your network. To make your development server viewable to other
  558. machines on the network, use its own IP address (e.g. ``192.168.2.1``) or
  559. ``0.0.0.0`` or ``::`` (with IPv6 enabled).
  560. You can provide an IPv6 address surrounded by brackets
  561. (e.g. ``[200a::1]:8000``). This will automatically enable IPv6 support.
  562. A hostname containing ASCII-only characters can also be used.
  563. If the :doc:`staticfiles</ref/contrib/staticfiles>` contrib app is enabled
  564. (default in new projects) the :djadmin:`runserver` command will be overridden
  565. with its own :ref:`runserver<staticfiles-runserver>` command.
  566. .. django-admin-option:: --noreload
  567. Use the ``--noreload`` option to disable the use of the auto-reloader. This
  568. means any Python code changes you make while the server is running will *not*
  569. take effect if the particular Python modules have already been loaded into
  570. memory.
  571. Example usage::
  572. django-admin.py runserver --noreload
  573. .. django-admin-option:: --nothreading
  574. The development server is multithreaded by default. Use the ``--nothreading``
  575. option to disable the use of threading in the development server.
  576. .. django-admin-option:: --ipv6, -6
  577. Use the ``--ipv6`` (or shorter ``-6``) option to tell Django to use IPv6 for
  578. the development server. This changes the default IP address from
  579. ``127.0.0.1`` to ``::1``.
  580. Example usage::
  581. django-admin.py runserver --ipv6
  582. Examples of using different ports and addresses
  583. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  584. Port 8000 on IP address ``127.0.0.1``::
  585. django-admin.py runserver
  586. Port 8000 on IP address ``1.2.3.4``::
  587. django-admin.py runserver 1.2.3.4:8000
  588. Port 7000 on IP address ``127.0.0.1``::
  589. django-admin.py runserver 7000
  590. Port 7000 on IP address ``1.2.3.4``::
  591. django-admin.py runserver 1.2.3.4:7000
  592. Port 8000 on IPv6 address ``::1``::
  593. django-admin.py runserver -6
  594. Port 7000 on IPv6 address ``::1``::
  595. django-admin.py runserver -6 7000
  596. Port 7000 on IPv6 address ``2001:0db8:1234:5678::9``::
  597. django-admin.py runserver [2001:0db8:1234:5678::9]:7000
  598. Port 8000 on IPv4 address of host ``localhost``::
  599. django-admin.py runserver localhost:8000
  600. Port 8000 on IPv6 address of host ``localhost``::
  601. django-admin.py runserver -6 localhost:8000
  602. Serving static files with the development server
  603. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  604. By default, the development server doesn't serve any static files for your site
  605. (such as CSS files, images, things under :setting:`MEDIA_URL` and so forth). If
  606. you want to configure Django to serve static media, read
  607. :doc:`/howto/static-files/index`.
  608. shell
  609. -----
  610. .. django-admin:: shell
  611. Starts the Python interactive interpreter.
  612. Django will use IPython_ or bpython_ if either is installed. If you have a
  613. rich shell installed but want to force use of the "plain" Python interpreter,
  614. use the ``--plain`` option, like so::
  615. django-admin.py shell --plain
  616. If you would like to specify either IPython or bpython as your interpreter if
  617. you have both installed you can specify an alternative interpreter interface
  618. with the ``-i`` or ``--interface`` options like so:
  619. IPython::
  620. django-admin.py shell -i ipython
  621. django-admin.py shell --interface ipython
  622. bpython::
  623. django-admin.py shell -i bpython
  624. django-admin.py shell --interface bpython
  625. .. _IPython: http://ipython.scipy.org/
  626. .. _bpython: http://bpython-interpreter.org/
  627. When the "plain" Python interactive interpreter starts (be it because
  628. ``--plain`` was specified or because no other interactive interface is
  629. available) it reads the script pointed to by the :envvar:`PYTHONSTARTUP`
  630. environment variable and the ``~/.pythonrc.py`` script. If you don't wish this
  631. behavior you can use the ``--no-startup`` option. e.g.::
  632. django-admin.py shell --plain --no-startup
  633. sql <app_label app_label ...>
  634. -----------------------------
  635. .. django-admin:: sql
  636. Prints the CREATE TABLE SQL statements for the given app name(s).
  637. The :djadminopt:`--database` option can be used to specify the database for
  638. which to print the SQL.
  639. sqlall <app_label app_label ...>
  640. --------------------------------
  641. .. django-admin:: sqlall
  642. Prints the CREATE TABLE and initial-data SQL statements for the given app name(s).
  643. Refer to the description of :djadmin:`sqlcustom` for an explanation of how to
  644. specify initial data.
  645. The :djadminopt:`--database` option can be used to specify the database for
  646. which to print the SQL.
  647. sqlclear <app_label app_label ...>
  648. ----------------------------------
  649. .. django-admin:: sqlclear
  650. Prints the DROP TABLE SQL statements for the given app name(s).
  651. The :djadminopt:`--database` option can be used to specify the database for
  652. which to print the SQL.
  653. sqlcustom <app_label app_label ...>
  654. -----------------------------------
  655. .. django-admin:: sqlcustom
  656. Prints the custom SQL statements for the given app name(s).
  657. For each model in each specified app, this command looks for the file
  658. ``<app_label>/sql/<modelname>.sql``, where ``<app_label>`` is the given app
  659. name and ``<modelname>`` is the model's name in lowercase. For example, if you
  660. have an app ``news`` that includes a ``Story`` model, ``sqlcustom`` will
  661. attempt to read a file ``news/sql/story.sql`` and append it to the output of
  662. this command.
  663. Each of the SQL files, if given, is expected to contain valid SQL. The SQL
  664. files are piped directly into the database after all of the models'
  665. table-creation statements have been executed. Use this SQL hook to make any
  666. table modifications, or insert any SQL functions into the database.
  667. Note that the order in which the SQL files are processed is undefined.
  668. The :djadminopt:`--database` option can be used to specify the database for
  669. which to print the SQL.
  670. sqldropindexes <app_label app_label ...>
  671. ----------------------------------------
  672. .. django-admin:: sqldropindexes
  673. Prints the DROP INDEX SQL statements for the given app name(s).
  674. The :djadminopt:`--database` option can be used to specify the database for
  675. which to print the SQL.
  676. sqlflush
  677. --------
  678. .. django-admin:: sqlflush
  679. Prints the SQL statements that would be executed for the :djadmin:`flush`
  680. command.
  681. The :djadminopt:`--database` option can be used to specify the database for
  682. which to print the SQL.
  683. sqlindexes <app_label app_label ...>
  684. ------------------------------------
  685. .. django-admin:: sqlindexes
  686. Prints the CREATE INDEX SQL statements for the given app name(s).
  687. The :djadminopt:`--database` option can be used to specify the database for
  688. which to print the SQL.
  689. sqlmigrate <app_label> <migrationname>
  690. --------------------------------------
  691. .. django-admin:: sqlmigrate
  692. Prints the SQL for the named migration. This requires an active database
  693. connection, which it will use to resolve constraint names; this means you must
  694. generate the SQL against a copy of the database you wish to later apply it on.
  695. The :djadminopt:`--database` option can be used to specify the database for
  696. which to generate the SQL.
  697. .. django-admin-option:: --backwards
  698. By default, the SQL created is for running the migration in the forwards
  699. direction. Pass ``--backwards`` to generate the SQL for
  700. unapplying the migration instead.
  701. sqlsequencereset <app_label app_label ...>
  702. ------------------------------------------
  703. .. django-admin:: sqlsequencereset
  704. Prints the SQL statements for resetting sequences for the given app name(s).
  705. Sequences are indexes used by some database engines to track the next available
  706. number for automatically incremented fields.
  707. Use this command to generate SQL which will fix cases where a sequence is out
  708. of sync with its automatically incremented field data.
  709. The :djadminopt:`--database` option can be used to specify the database for
  710. which to print the SQL.
  711. squashmigrations <app_label> <migration_name>
  712. ---------------------------------------------
  713. .. django-admin:: squashmigrations
  714. Squashes the migrations for ``app_label`` up to and including ``migration_name``
  715. down into fewer migrations, if possible. The resulting squashed migrations
  716. can live alongside the unsquashed ones safely. For more information,
  717. please read :ref:`migration-squashing`.
  718. .. django-admin-option:: --no-optimize
  719. By default, Django will try to optimize the operations in your migrations
  720. to reduce the size of the resulting file. Pass ``--no-optimize`` if this
  721. process is failing for you or creating incorrect migrations, though please
  722. also file a Django bug report about the behaviour, as optimization is meant
  723. to be safe.
  724. startapp <app_label> [destination]
  725. ----------------------------------
  726. .. django-admin:: startapp
  727. Creates a Django app directory structure for the given app name in the current
  728. directory or the given destination.
  729. By default the directory created contains a ``models.py`` file and other app
  730. template files. (See the `source`_ for more details.) If only the app
  731. name is given, the app directory will be created in the current working
  732. directory.
  733. If the optional destination is provided, Django will use that existing
  734. directory rather than creating a new one. You can use '.' to denote the current
  735. working directory.
  736. For example::
  737. django-admin.py startapp myapp /Users/jezdez/Code/myapp
  738. .. _custom-app-and-project-templates:
  739. .. django-admin-option:: --template
  740. With the ``--template`` option, you can use a custom app template by providing
  741. either the path to a directory with the app template file, or a path to a
  742. compressed file (``.tar.gz``, ``.tar.bz2``, ``.tgz``, ``.tbz``, ``.zip``)
  743. containing the app template files.
  744. For example, this would look for an app template in the given directory when
  745. creating the ``myapp`` app::
  746. django-admin.py startapp --template=/Users/jezdez/Code/my_app_template myapp
  747. Django will also accept URLs (``http``, ``https``, ``ftp``) to compressed
  748. archives with the app template files, downloading and extracting them on the
  749. fly.
  750. For example, taking advantage of Github's feature to expose repositories as
  751. zip files, you can use a URL like::
  752. django-admin.py startapp --template=https://github.com/githubuser/django-app-template/archive/master.zip myapp
  753. When Django copies the app template files, it also renders certain files
  754. through the template engine: the files whose extensions match the
  755. ``--extension`` option (``py`` by default) and the files whose names are passed
  756. with the ``--name`` option. The :class:`template context
  757. <django.template.Context>` used is:
  758. - Any option passed to the ``startapp`` command (among the command's supported
  759. options)
  760. - ``app_name`` -- the app name as passed to the command
  761. - ``app_directory`` -- the full path of the newly created app
  762. - ``docs_version`` -- the version of the documentation: ``'dev'`` or ``'1.x'``
  763. .. _render_warning:
  764. .. warning::
  765. When the app template files are rendered with the Django template
  766. engine (by default all ``*.py`` files), Django will also replace all
  767. stray template variables contained. For example, if one of the Python files
  768. contains a docstring explaining a particular feature related
  769. to template rendering, it might result in an incorrect example.
  770. To work around this problem, you can use the :ttag:`templatetag`
  771. templatetag to "escape" the various parts of the template syntax.
  772. .. _source: https://github.com/django/django/tree/master/django/conf/app_template/
  773. startproject <projectname> [destination]
  774. ----------------------------------------
  775. .. django-admin:: startproject
  776. Creates a Django project directory structure for the given project name in
  777. the current directory or the given destination.
  778. By default, the new directory contains ``manage.py`` and a project package
  779. (containing a ``settings.py`` and other files). See the `template source`_ for
  780. details.
  781. If only the project name is given, both the project directory and project
  782. package will be named ``<projectname>`` and the project directory
  783. will be created in the current working directory.
  784. If the optional destination is provided, Django will use that existing
  785. directory as the project directory, and create ``manage.py`` and the project
  786. package within it. Use '.' to denote the current working directory.
  787. For example::
  788. django-admin.py startproject myproject /Users/jezdez/Code/myproject_repo
  789. As with the :djadmin:`startapp` command, the ``--template`` option lets you
  790. specify a directory, file path or URL of a custom project template. See the
  791. :djadmin:`startapp` documentation for details of supported project template
  792. formats.
  793. For example, this would look for a project template in the given directory
  794. when creating the ``myproject`` project::
  795. django-admin.py startproject --template=/Users/jezdez/Code/my_project_template myproject
  796. Django will also accept URLs (``http``, ``https``, ``ftp``) to compressed
  797. archives with the project template files, downloading and extracting them on the
  798. fly.
  799. For example, taking advantage of Github's feature to expose repositories as
  800. zip files, you can use a URL like::
  801. django-admin.py startproject --template=https://github.com/githubuser/django-project-template/archive/master.zip myproject
  802. When Django copies the project template files, it also renders certain files
  803. through the template engine: the files whose extensions match the
  804. ``--extension`` option (``py`` by default) and the files whose names are passed
  805. with the ``--name`` option. The :class:`template context
  806. <django.template.Context>` used is:
  807. - Any option passed to the ``startproject`` command (among the command's
  808. supported options)
  809. - ``project_name`` -- the project name as passed to the command
  810. - ``project_directory`` -- the full path of the newly created project
  811. - ``secret_key`` -- a random key for the :setting:`SECRET_KEY` setting
  812. - ``docs_version`` -- the version of the documentation: ``'dev'`` or ``'1.x'``
  813. Please also see the :ref:`rendering warning <render_warning>` as mentioned
  814. for :djadmin:`startapp`.
  815. .. _`template source`: https://github.com/django/django/tree/master/django/conf/project_template/
  816. syncdb
  817. ------
  818. .. django-admin:: syncdb
  819. .. deprecated:: 1.7
  820. This command has been deprecated in favor of the :djadmin:`migrate`
  821. command, which performs both the old behavior as well as executing
  822. migrations. It is now just an alias to that command.
  823. Alias for :djadmin:`migrate`.
  824. test <app or test identifier>
  825. -----------------------------
  826. .. django-admin:: test
  827. Runs tests for all installed models. See :doc:`/topics/testing/index` for more
  828. information.
  829. .. django-admin-option:: --failfast
  830. The ``--failfast`` option can be used to stop running tests and report the
  831. failure immediately after a test fails.
  832. .. django-admin-option:: --testrunner
  833. The ``--testrunner`` option can be used to control the test runner class that
  834. is used to execute tests. If this value is provided, it overrides the value
  835. provided by the :setting:`TEST_RUNNER` setting.
  836. .. django-admin-option:: --liveserver
  837. The ``--liveserver`` option can be used to override the default address where
  838. the live server (used with :class:`~django.test.LiveServerTestCase`) is
  839. expected to run from. The default value is ``localhost:8081``.
  840. testserver <fixture fixture ...>
  841. --------------------------------
  842. .. django-admin:: testserver
  843. Runs a Django development server (as in :djadmin:`runserver`) using data from
  844. the given fixture(s).
  845. For example, this command::
  846. django-admin.py testserver mydata.json
  847. ...would perform the following steps:
  848. 1. Create a test database, as described in :ref:`the-test-database`.
  849. 2. Populate the test database with fixture data from the given fixtures.
  850. (For more on fixtures, see the documentation for :djadmin:`loaddata` above.)
  851. 3. Runs the Django development server (as in :djadmin:`runserver`), pointed at
  852. this newly created test database instead of your production database.
  853. This is useful in a number of ways:
  854. * When you're writing :doc:`unit tests </topics/testing/overview>` of how your views
  855. act with certain fixture data, you can use ``testserver`` to interact with
  856. the views in a Web browser, manually.
  857. * Let's say you're developing your Django application and have a "pristine"
  858. copy of a database that you'd like to interact with. You can dump your
  859. database to a fixture (using the :djadmin:`dumpdata` command, explained
  860. above), then use ``testserver`` to run your Web application with that data.
  861. With this arrangement, you have the flexibility of messing up your data
  862. in any way, knowing that whatever data changes you're making are only
  863. being made to a test database.
  864. Note that this server does *not* automatically detect changes to your Python
  865. source code (as :djadmin:`runserver` does). It does, however, detect changes to
  866. templates.
  867. .. django-admin-option:: --addrport [port number or ipaddr:port]
  868. Use ``--addrport`` to specify a different port, or IP address and port, from
  869. the default of ``127.0.0.1:8000``. This value follows exactly the same format and
  870. serves exactly the same function as the argument to the :djadmin:`runserver`
  871. command.
  872. Examples:
  873. To run the test server on port 7000 with ``fixture1`` and ``fixture2``::
  874. django-admin.py testserver --addrport 7000 fixture1 fixture2
  875. django-admin.py testserver fixture1 fixture2 --addrport 7000
  876. (The above statements are equivalent. We include both of them to demonstrate
  877. that it doesn't matter whether the options come before or after the fixture
  878. arguments.)
  879. To run on 1.2.3.4:7000 with a ``test`` fixture::
  880. django-admin.py testserver --addrport 1.2.3.4:7000 test
  881. The :djadminopt:`--noinput` option may be provided to suppress all user
  882. prompts.
  883. validate
  884. --------
  885. .. django-admin:: validate
  886. .. deprecated:: 1.7
  887. Replaced by the :djadmin:`check` command.
  888. Validates all installed models (according to the :setting:`INSTALLED_APPS`
  889. setting) and prints validation errors to standard output.
  890. Commands provided by applications
  891. =================================
  892. Some commands are only available when the ``django.contrib`` application that
  893. :doc:`implements </howto/custom-management-commands>` them has been
  894. :setting:`enabled <INSTALLED_APPS>`. This section describes them grouped by
  895. their application.
  896. ``django.contrib.auth``
  897. -----------------------
  898. changepassword
  899. ~~~~~~~~~~~~~~
  900. .. django-admin:: changepassword
  901. This command is only available if Django's :doc:`authentication system
  902. </topics/auth/index>` (``django.contrib.auth``) is installed.
  903. Allows changing a user's password. It prompts you to enter twice the password of
  904. the user given as parameter. If they both match, the new password will be
  905. changed immediately. If you do not supply a user, the command will attempt to
  906. change the password whose username matches the current user.
  907. Use the ``--database`` option to specify the database to query for the user. If
  908. it's not supplied, Django will use the ``default`` database.
  909. Example usage::
  910. django-admin.py changepassword ringo
  911. createsuperuser
  912. ~~~~~~~~~~~~~~~
  913. .. django-admin:: createsuperuser
  914. This command is only available if Django's :doc:`authentication system
  915. </topics/auth/index>` (``django.contrib.auth``) is installed.
  916. Creates a superuser account (a user who has all permissions). This is
  917. useful if you need to create an initial superuser account but did not
  918. do so during the first :djadmin:`migrate`, or if you need to programmatically
  919. generate superuser accounts for your site(s).
  920. When run interactively, this command will prompt for a password for
  921. the new superuser account. When run non-interactively, no password
  922. will be set, and the superuser account will not be able to log in until
  923. a password has been manually set for it.
  924. .. django-admin-option:: --username
  925. .. django-admin-option:: --email
  926. The username and email address for the new account can be supplied by
  927. using the ``--username`` and ``--email`` arguments on the command
  928. line. If either of those is not supplied, ``createsuperuser`` will prompt for
  929. it when running interactively.
  930. Use the ``--database`` option to specify the database into which the superuser
  931. object will be saved.
  932. ``django.contrib.gis``
  933. ----------------------
  934. ogrinspect
  935. ~~~~~~~~~~
  936. This command is only available if :doc:`GeoDjango </ref/contrib/gis/index>`
  937. (``django.contrib.gis``) is installed.
  938. Please refer to its :djadmin:`description <ogrinspect>` in the GeoDjango
  939. documentation.
  940. ``django.contrib.sessions``
  941. ---------------------------
  942. clearsessions
  943. ~~~~~~~~~~~~~~~
  944. .. django-admin:: clearsessions
  945. Can be run as a cron job or directly to clean out expired sessions.
  946. ``django.contrib.sitemaps``
  947. ---------------------------
  948. ping_google
  949. ~~~~~~~~~~~
  950. This command is only available if the :doc:`Sitemaps framework
  951. </ref/contrib/sitemaps>` (``django.contrib.sitemaps``) is installed.
  952. Please refer to its :djadmin:`description <ping_google>` in the Sitemaps
  953. documentation.
  954. ``django.contrib.staticfiles``
  955. ------------------------------
  956. collectstatic
  957. ~~~~~~~~~~~~~
  958. This command is only available if the :doc:`static files application
  959. </howto/static-files/index>` (``django.contrib.staticfiles``) is installed.
  960. Please refer to its :djadmin:`description <collectstatic>` in the
  961. :doc:`staticfiles </ref/contrib/staticfiles>` documentation.
  962. findstatic
  963. ~~~~~~~~~~
  964. This command is only available if the :doc:`static files application
  965. </howto/static-files/index>` (``django.contrib.staticfiles``) is installed.
  966. Please refer to its :djadmin:`description <findstatic>` in the :doc:`staticfiles
  967. </ref/contrib/staticfiles>` documentation.
  968. Default options
  969. ===============
  970. Although some commands may allow their own custom options, every command
  971. allows for the following options:
  972. .. django-admin-option:: --pythonpath
  973. Example usage::
  974. django-admin.py migrate --pythonpath='/home/djangoprojects/myproject'
  975. Adds the given filesystem path to the Python `import search path`_. If this
  976. isn't provided, ``django-admin.py`` will use the ``PYTHONPATH`` environment
  977. variable.
  978. Note that this option is unnecessary in ``manage.py``, because it takes care of
  979. setting the Python path for you.
  980. .. _import search path: http://diveintopython.net/getting_to_know_python/everything_is_an_object.html
  981. .. django-admin-option:: --settings
  982. Example usage::
  983. django-admin.py migrate --settings=mysite.settings
  984. Explicitly specifies the settings module to use. The settings module should be
  985. in Python package syntax, e.g. ``mysite.settings``. If this isn't provided,
  986. ``django-admin.py`` will use the ``DJANGO_SETTINGS_MODULE`` environment
  987. variable.
  988. Note that this option is unnecessary in ``manage.py``, because it uses
  989. ``settings.py`` from the current project by default.
  990. .. django-admin-option:: --traceback
  991. Example usage::
  992. django-admin.py migrate --traceback
  993. By default, ``django-admin.py`` will show a simple error message whenever an
  994. :class:`~django.core.management.CommandError` occurs, but a full stack trace
  995. for any other exception. If you specify ``--traceback``, ``django-admin.py``
  996. will also output a full stack trace when a ``CommandError`` is raised.
  997. .. django-admin-option:: --verbosity
  998. Example usage::
  999. django-admin.py migrate --verbosity 2
  1000. Use ``--verbosity`` to specify the amount of notification and debug information
  1001. that ``django-admin.py`` should print to the console.
  1002. * ``0`` means no output.
  1003. * ``1`` means normal output (default).
  1004. * ``2`` means verbose output.
  1005. * ``3`` means *very* verbose output.
  1006. .. django-admin-option:: --no-color
  1007. .. versionadded:: 1.7
  1008. Example usage::
  1009. django-admin.py sqlall --no-color
  1010. By default, ``django-admin.py`` will format the output to be colorized. For
  1011. example, errors will be printed to the console in red and SQL statements will
  1012. be syntax highlighted. To prevent this and have a plain text output, pass the
  1013. ``--no-color`` option when running your command.
  1014. Common options
  1015. ==============
  1016. The following options are not available on every command, but they are common
  1017. to a number of commands.
  1018. .. django-admin-option:: --database
  1019. Used to specify the database on which a command will operate. If not
  1020. specified, this option will default to an alias of ``default``.
  1021. For example, to dump data from the database with the alias ``master``::
  1022. django-admin.py dumpdata --database=master
  1023. .. django-admin-option:: --exclude
  1024. Exclude a specific application from the applications whose contents is
  1025. output. For example, to specifically exclude the ``auth`` application from
  1026. the output of dumpdata, you would call::
  1027. django-admin.py dumpdata --exclude=auth
  1028. If you want to exclude multiple applications, use multiple ``--exclude``
  1029. directives::
  1030. django-admin.py dumpdata --exclude=auth --exclude=contenttypes
  1031. .. django-admin-option:: --locale
  1032. Use the ``--locale`` or ``-l`` option to specify the locale to process.
  1033. If not provided all locales are processed.
  1034. .. django-admin-option:: --noinput
  1035. Use the ``--noinput`` option to suppress all user prompting, such as "Are
  1036. you sure?" confirmation messages. This is useful if ``django-admin.py`` is
  1037. being executed as an unattended, automated script.
  1038. Extra niceties
  1039. ==============
  1040. .. _syntax-coloring:
  1041. Syntax coloring
  1042. ---------------
  1043. The ``django-admin.py`` / ``manage.py`` commands will use pretty
  1044. color-coded output if your terminal supports ANSI-colored output. It
  1045. won't use the color codes if you're piping the command's output to
  1046. another program.
  1047. Under Windows, the native console doesn't support ANSI escape sequences so by
  1048. default there is no color output. But you can install the `ANSICON`_
  1049. third-party tool, the Django commands will detect its presence and will make
  1050. use of its services to color output just like on Unix-based platforms.
  1051. The colors used for syntax highlighting can be customized. Django
  1052. ships with three color palettes:
  1053. * ``dark``, suited to terminals that show white text on a black
  1054. background. This is the default palette.
  1055. * ``light``, suited to terminals that show black text on a white
  1056. background.
  1057. * ``nocolor``, which disables syntax highlighting.
  1058. You select a palette by setting a ``DJANGO_COLORS`` environment
  1059. variable to specify the palette you want to use. For example, to
  1060. specify the ``light`` palette under a Unix or OS/X BASH shell, you
  1061. would run the following at a command prompt::
  1062. export DJANGO_COLORS="light"
  1063. You can also customize the colors that are used. Django specifies a
  1064. number of roles in which color is used:
  1065. * ``error`` - A major error.
  1066. * ``notice`` - A minor error.
  1067. * ``sql_field`` - The name of a model field in SQL.
  1068. * ``sql_coltype`` - The type of a model field in SQL.
  1069. * ``sql_keyword`` - An SQL keyword.
  1070. * ``sql_table`` - The name of a model in SQL.
  1071. * ``http_info`` - A 1XX HTTP Informational server response.
  1072. * ``http_success`` - A 2XX HTTP Success server response.
  1073. * ``http_not_modified`` - A 304 HTTP Not Modified server response.
  1074. * ``http_redirect`` - A 3XX HTTP Redirect server response other than 304.
  1075. * ``http_not_found`` - A 404 HTTP Not Found server response.
  1076. * ``http_bad_request`` - A 4XX HTTP Bad Request server response other than 404.
  1077. * ``http_server_error`` - A 5XX HTTP Server Error response.
  1078. Each of these roles can be assigned a specific foreground and
  1079. background color, from the following list:
  1080. * ``black``
  1081. * ``red``
  1082. * ``green``
  1083. * ``yellow``
  1084. * ``blue``
  1085. * ``magenta``
  1086. * ``cyan``
  1087. * ``white``
  1088. Each of these colors can then be modified by using the following
  1089. display options:
  1090. * ``bold``
  1091. * ``underscore``
  1092. * ``blink``
  1093. * ``reverse``
  1094. * ``conceal``
  1095. A color specification follows one of the following patterns:
  1096. * ``role=fg``
  1097. * ``role=fg/bg``
  1098. * ``role=fg,option,option``
  1099. * ``role=fg/bg,option,option``
  1100. where ``role`` is the name of a valid color role, ``fg`` is the
  1101. foreground color, ``bg`` is the background color and each ``option``
  1102. is one of the color modifying options. Multiple color specifications
  1103. are then separated by semicolon. For example::
  1104. export DJANGO_COLORS="error=yellow/blue,blink;notice=magenta"
  1105. would specify that errors be displayed using blinking yellow on blue,
  1106. and notices displayed using magenta. All other color roles would be
  1107. left uncolored.
  1108. Colors can also be specified by extending a base palette. If you put
  1109. a palette name in a color specification, all the colors implied by that
  1110. palette will be loaded. So::
  1111. export DJANGO_COLORS="light;error=yellow/blue,blink;notice=magenta"
  1112. would specify the use of all the colors in the light color palette,
  1113. *except* for the colors for errors and notices which would be
  1114. overridden as specified.
  1115. .. versionadded:: 1.7
  1116. Support for color-coded output from ``django-admin.py`` / ``manage.py``
  1117. utilities on Windows by relying on the ANSICON application was added in Django
  1118. 1.7.
  1119. .. _ANSICON: http://adoxa.hostmyway.net/ansicon/
  1120. Bash completion
  1121. ---------------
  1122. If you use the Bash shell, consider installing the Django bash completion
  1123. script, which lives in ``extras/django_bash_completion`` in the Django
  1124. distribution. It enables tab-completion of ``django-admin.py`` and
  1125. ``manage.py`` commands, so you can, for instance...
  1126. * Type ``django-admin.py``.
  1127. * Press [TAB] to see all available options.
  1128. * Type ``sql``, then [TAB], to see all available options whose names start
  1129. with ``sql``.
  1130. See :doc:`/howto/custom-management-commands` for how to add customized actions.
  1131. ==========================================
  1132. Running management commands from your code
  1133. ==========================================
  1134. .. _call-command:
  1135. .. function:: django.core.management.call_command(name, *args, **options)
  1136. To call a management command from code use ``call_command``.
  1137. ``name``
  1138. the name of the command to call.
  1139. ``*args``
  1140. a list of arguments accepted by the command.
  1141. ``**options``
  1142. named options accepted on the command-line.
  1143. Examples::
  1144. from django.core import management
  1145. management.call_command('flush', verbosity=0, interactive=False)
  1146. management.call_command('loaddata', 'test_data', verbosity=0)
  1147. Note that command options that take no arguments are passed as keywords
  1148. with ``True`` or ``False``::
  1149. management.call_command('dumpdata', use_natural_keys=True)
  1150. Command options which take multiple options are passed a list::
  1151. management.call_command('dumpdata', exclude=['contenttypes', 'auth'])
  1152. Output redirection
  1153. ==================
  1154. Note that you can redirect standard output and error streams as all commands
  1155. support the ``stdout`` and ``stderr`` options. For example, you could write::
  1156. with open('/tmp/command_output') as f:
  1157. management.call_command('dumpdata', stdout=f)