djangocms-helper
Helper for django CMS plugin development
djangocms-helper is a set of commands to handle django CMS plugins development process.
It's a modified version of django CMS's own develop.py
script, modified
to handle generic plugins development process.
warning
Since version 0.7 django CMS is no more a hard dependency; install it
manually to enable --cms
option
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;
Usage
The command must be executed in the main plugin directory (i.e. in the same
directory as the setup.py
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. Optins vary for each command.
Runner
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.
Installation
Installing from pip:
pip install djangocms-helper
Installing from source:
pip install git+https://github.com/nephila/djangocms-helper#egg=djangocms-helper
Requirements
- django CMS 3.0 (django CMS 3.0.4 is required for pyflake command), optional; required only
to work with
--cms
option - docopt
- tox
- dj-database-url
Documentation
Documentation is available on readthedocs.
Authors
djangocms-helper was written by Iacopo Spalletti with help from other contributors.
Thanks
The general logic and part of the code of the whole application is heavily taken from django CMS's own develop.py so all the contributors deserve a huge thanks for their work.