Current Command Extensions

trbs edited this page May 3, 2016 · 4 revisions

This page is obsolete, please have look to rst official doc for a more up to date documentation. For a real exhaustive documentation, refer to —help or the commands folder

  • create_app – creates an application directory structure for the specified app name. This command allows you to specify the —template option where you can indicate a template directory structure to use as your default.
  • create_command – creates a command extension directory structure within the specified application. This makes it easy to get started with adding a command extension to your application.
  • create_jobs – Creates a Django jobs command directory structure for the given app name in the current directory. This is part of the impressive jobs system.
  • create_superuser – makes it easy to create a superuser for the django.contrib.auth.
  • describe_form – used to display a form definition for a model. Copy and paste the contents into your and you’re ready to go.
  • dumpscript – Generates a Python script that will repopulate the database using objects. The advantage of this approach is that it is easy to understand, and more flexible than directly populating the database, or using XML.
  • export_emails – export the email addresses for your users in one of many formats. Currently supports Address, Google, Outlook, !LinkedIn, and VCard formats.
  • generate_secret_key – creates a new secret key that you can put in your module.
  • graph_models – creates a GraphViz dot file. You need to send this output to a file yourself. Great for graphing your models. Pass multiple application names to combine all the models into a single dot file.
  • mail_debug – starts a mail server which echos out the contents of the email instead of sending it.
  • passwd – makes it easy to reset a user’s password
  • print_user_for_session – print the user information for the provided session key. this is very helpful when trying to track down the person who experienced a site crash.
  • reset_db – Resets a database (currently sqlite3, mysql, postgres).
  • runjob – run a single maintenance job. Part of the jobs system.
  • runjobs – runs scheduled maintenance jobs. Specify hourly, daily, weekly, monthly. Part of the jobs system.
  • runprofileserver – starts `runserver` with hotshot/profiling tools enabled. I haven’t had a chance to check this one out, but it looks really cool.
  • runscript – Runs a script in django context. Note that all scripts must reside inside a scripts package; if you don’t do this the runscript command will not be able to find your script. Create a scripts directory on your project root directory, put a file inside it, and then add your scripts to the directory.
  • runserver_plus – The standard runserver stuff but with the Werkzeug debugger baked in. Requires Werkzeug. This one kicks ass.
  • set_fake_passwords – Sets all user passwords to a common value (`password` by default). DEBUG only
  • shell_plus – An enhanced version of the Django shell. It will autoload all your models making it easy to work with the ORM right away.
  • show_urls – displays the url routes that are defined in your project. Very crude at this point.
  • sqldiff – prints the (approximated) difference between an apps models and what is in the database. This is very nice, but also very experimental at the moment. It can not catch everything but it’s a great sanity check.
  • sync_media_s3 – copies files found in settings.MEDIA_ROOT to S3. Optionally can also gzip CSS and Javascript files and set the Content-Encoding header, and also set a far future expires header for browser caching.
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.