summaryrefslogtreecommitdiff
path: root/plugins/django
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/django')
-rw-r--r--plugins/django/README.md56
-rw-r--r--plugins/django/django.plugin.zsh1
2 files changed, 57 insertions, 0 deletions
diff --git a/plugins/django/README.md b/plugins/django/README.md
new file mode 100644
index 000000000..415f6b7ea
--- /dev/null
+++ b/plugins/django/README.md
@@ -0,0 +1,56 @@
+# Django plugin
+
+This plugin adds completion and hints for the [Django Project](https://www.djangoproject.com/) `manage.py` commands
+and options.
+
+To use it, add `django` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... django)
+```
+
+## Usage
+
+```zsh
+$> python manage.py (press <TAB> here)
+```
+
+Would result in:
+
+```zsh
+cleanup -- remove old data from the database
+compilemessages -- compile .po files to .mo for use with gettext
+createcachetable -- creates table for SQL cache backend
+createsuperuser -- create a superuser
+dbshell -- run command-line client for the current database
+diffsettings -- display differences between the current settings and Django defaults
+dumpdata -- output contents of database as a fixture
+flush -- execute 'sqlflush' on the current database
+inspectdb -- output Django model module for tables in database
+loaddata -- install the named fixture(s) in the database
+makemessages -- pull out all strings marked for translation
+reset -- executes 'sqlreset' for the given app(s)
+runfcgi -- run this project as a fastcgi
+runserver -- start a lightweight web server for development
+...
+```
+
+If you want to see the options available for a specific command, try:
+
+```zsh
+$> python manage.py makemessages (press <TAB> here)
+```
+
+And that would result in:
+
+```zsh
+--all -a -- re-examine all code and templates
+--domain -d -- domain of the message files (default: "django")
+--extensions -e -- file extension(s) to examine (default: ".html")
+--help -- display help information
+--locale -l -- locale to process (default: all)
+--pythonpath -- directory to add to the Python path
+--settings -- python path to settings module
+...
+```
+
diff --git a/plugins/django/django.plugin.zsh b/plugins/django/django.plugin.zsh
index 35865a692..29a51d29d 100644
--- a/plugins/django/django.plugin.zsh
+++ b/plugins/django/django.plugin.zsh
@@ -349,6 +349,7 @@ _managepy-commands() {
'runfcgi:Run this project as a fastcgi (or some other protocol supported by flup) application,'
'runserver:Starts a lightweight Web server for development.'
'shell:Runs a Python interactive interpreter.'
+ 'showmigrations:Shows all available migrations for the current project.'
'sql:Prints the CREATE TABLE SQL statements for the given app name(s).'
'sqlall:Prints the CREATE TABLE, custom SQL and CREATE INDEX SQL statements for the given model module name(s).'
'sqlclear:Prints the DROP TABLE SQL statements for the given app name(s).'