Homepage | Simple index

Helper for django applications development

author Iacopo Spalletti
  • License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
  • Development Status :: 5 - Production/Stable
  • Framework :: Django
  • Framework :: Django :: 1.8
  • Framework :: Django :: 1.9
  • Framework :: Django :: 1.10
  • Framework :: Django :: 1.11
  • Programming Language :: Python
  • Programming Language :: Python :: 2
  • Programming Language :: Python :: 2.7
  • Programming Language :: Python :: 3
  • Programming Language :: Python :: 3.4
  • Programming Language :: Python :: 3.5
  • Programming Language :: Python :: 3.6
license GPLv2+
File Size Python Type Tox results History
37 KB
Uploaded to nephila/dev by nephila 2018-09-16 15:45:59
47 KB
Python Wheel
Uploaded to nephila/dev by nephila 2018-09-16 15:45:59

Join the Gitter chat Latest PyPI version Python versions Latest Travis CI build status Test coverage Code Climate License

Helper for django applications development

djangocms-helper is a set of commands and helper methods to make developing and testing reusable Django applications easier.

Being born in the django CMS ecosystem, it provides a lot of utility functions to develop, run and test django CMS applications.

It’s a modified version of django CMS’s own script, modified to handle generic application development process.

Supported versions

Python: 2.7, 3.4, 3.5, 3.6

Django: 1.8 to 1.11 (limited 2.0 support)

django CMS: 3.4, 3.5


Starting from version 1.1, compatibily nose test runnerhas been dropped. Pin your test requirements accordingly (djangocms-helper<1.0).


Starting from version 1.0, compatibily with Python 2.6, Python 3.3, Django<=1.7 and django CMS<=3.3 has been dropped. Pin your test requirements accordingly (djangocms-helper<1.0).

Common options

  • --cms: Loads configuration to properly run a django CMS-based application;
  • --extra-settings: Path to a helper file to set extra settings; see Settings section for details;


The command must be executed in the main plugin directory (i.e. in the same directory as the file) as it needs to import files relative to the current directory.

The basic command structure is:

djangocms-helper <application> <command> [options ...]

where <application> is the django application name and <command> is one of the available commands. Options vary for each command.


To bootstrap a project using djangocms-helper you may want to have a look at cookiecutter-djangopackage-helper, a cookiecutter template for djangocms-helper.

To use it follows usage instructions


By using the integrated runned in the settings file you’ll be able to run the commands without invoking djangocms-helper: see Integrate runner for reference.


Installing from pip:

pip install djangocms-helper

Installing from source:

pip install git+


  • django CMS optional; required only to work with --cms option
  • docopt
  • tox
  • dj-database-url


Documentation is available on readthedocs.


djangocms-helper was written by Iacopo Spalletti with help from other contributors.


The general logic and part of the code of the whole application is heavily taken from django CMS’s own so all the contributors deserve a huge thanks for their work.