community.general.django_manage – Manages a Django application.
Note
This plugin is part of the community.general collection (version 3.8.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.django_manage
.
Synopsis
Manages a Django application using the
manage.py
application frontend todjango-admin
. With thevirtualenv
parameter, all management commands will be executed by the givenvirtualenv
installation.
Requirements
The below requirements are needed on the host that executes this module.
virtualenv
django
Parameters
Parameter |
Comments |
---|---|
A list of space-delimited apps to target. Used by the |
|
The name of the table used for database-backed caching. Used by the |
|
Clear the existing files before trying to copy or link the original file. Used only with the Choices:
|
|
The name of the Django management command to run. Built in commands are Other commands can be entered, but will fail if they’re unknown to Django. Other commands that may prompt for user input should be run with the The module will perform some basic parameter validation (when applicable) to the commands |
|
The database to target. Used by the |
|
Fail the command immediately if a test fails. Used by the Choices:
|
|
A space-delimited list of fixture file names to load in the database. Required by the |
|
Will create links to the files instead of copying them, you can only use this parameter with Choices:
|
|
Will run out-of-order or missing migrations as they are not rollback migrations, you can only use this parameter with Choices:
|
|
The path to the root of the Django application where manage.py lives. |
|
A directory to add to the Python path. Typically used to include the settings module if it is located external to the application directory. |
|
The Python path to the application’s settings module, such as |
|
Will skip over out-of-order missing migrations, you can only use this parameter with Choices:
|
|
From the Django docs: Controls the test runner class that is used to execute tests. This parameter is passed as-is to |
|
An optional path to a virtualenv installation to use while running the manage application. |
Notes
Note
virtualenv
(http://www.virtualenv.org) must be installed on the remote host if the virtualenv parameter is specified.This module will create a virtualenv if the virtualenv parameter is specified and a virtual environment does not already exist at the given location.
This module assumes English error messages for the
createcachetable
command to detect table existence, unfortunately.To be able to use the
migrate
command with django versions < 1.7, you must havesouth
installed and added as an app in your settings.To be able to use the
collectstatic
command, you must have enabled staticfiles in your settings.Your
manage.py
application must be executable (rwxr-xr-x), and must have a valid shebang, i.e.#!/usr/bin/env python
, for invoking the appropriate Python interpreter.
Examples
- name: Run cleanup on the application installed in django_dir
community.general.django_manage:
command: cleanup
project_path: "{{ django_dir }}"
- name: Load the initial_data fixture into the application
community.general.django_manage:
command: loaddata
project_path: "{{ django_dir }}"
fixtures: "{{ initial_data }}"
- name: Run syncdb on the application
community.general.django_manage:
command: syncdb
project_path: "{{ django_dir }}"
settings: "{{ settings_app_name }}"
pythonpath: "{{ settings_dir }}"
virtualenv: "{{ virtualenv_dir }}"
- name: Run the SmokeTest test case from the main app. Useful for testing deploys
community.general.django_manage:
command: test
project_path: "{{ django_dir }}"
apps: main.SmokeTest
- name: Create an initial superuser
community.general.django_manage:
command: "createsuperuser --noinput --username=admin [email protected]"
project_path: "{{ django_dir }}"
Authors
Scott Anderson (@tastychutney)