community.general.django_manage module – Manages a Django application
Note
This module is part of the community.general collection (version 5.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
.
You need further requirements to be able to use this module,
see Requirements for details.
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 the virtualenv 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 |
---|---|
When a virtualenv is set but the virtual environment does not exist, the current behavior is to create a new virtual environment. That behavior is deprecated and if that case happens it will generate a deprecation warning. Set this flag to Please note that you will receive no further warning about this being removed until the module will start failing in such cases from community.general 9.0.0 on. Choices:
|
|
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. The commands listed below are built in this module and have some basic parameter validation.
Other commands can be entered, but will fail if they are unknown to Django. Other commands that may prompt for user input should be run with the |
|
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 |
|
A directory to add to the Python path. Typically used to include the settings module if it is located external to the application directory. This would be equivalent to adding pythonpath‘s value to the |
|
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:
|
|
Controls the test runner class that is used to execute tests. This parameter is passed as-is to |
|
An optional path to a |
Notes
Note
ATTENTION - DEPRECATION: Support for Django releases older than 4.1 will be removed in community.general version 9.0.0 (estimated to be released in May 2024). Please notice that Django 4.1 requires Python 3.8 or greater.
virtualenv
(http://www.virtualenv.org) must be installed on the remote host if the virtualenv parameter is specified. This requirement is deprecated and will be removed in community.general version 9.0.0.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 behavior is deprecated and will be removed in community.general version 9.0.0.
The parameter virtualenv will remain in use, but it will require the specified virtualenv to exist. The recommended way to create one in Ansible is by using ansible.builtin.pip.
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.
See Also
See also
- django-admin and manage.py Reference
Reference for
django-admin
ormanage.py
commands.- Django Download page
The page showing how to get Django and the timeline of supported releases.
- What Python version can I use with Django?
From the Django FAQ, the response to Python requirements for the framework.
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 }}"
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication