Helpers for django CMS plugin development
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.
- --cms: Loads configuration to properly run a django CMS-based application;
- --extra-settings: Path to a helper file to set extra settings; see Customizing settings for details;
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.
Test command allows to run the application test suite using test environemnt similar to the django CMS testsuite.
Currently two different tests layouts are supported:
tests outside the application module:
setup.py tests __init__.py test_module1.py ....
tests inside the application:
setup.py application tests __init__.py test_module1.py ...
Depending on the used test runner you may need to setup your tests accordingly.
Currently supported test runners are:
- Django’s DiscoverRunner (default)
- Django’s DjangoTestSuiteRunner (option --simple-runner)
- Nose’s NoseTestSuiteRunner (option --nose-runner)
You can also write your own runner an use it with --runner option.
- <test-label>: a space-separated list of tests to run;
- --runner: custom test runner to use in dotted path notation;
- --failfast: whether to stop at first test failure;
- --migrate: whether to apply south migrations when running tests;
- --xvfb: whether to configure xvfb (for frontend tests);
- --nose-runner: use django nose test suite
- --simple-runner use Django DjangoTestSuiteRunner
Starts a django shell for the test project.
Compiles the locale messages.
Updates the locale messages for the current application.
Updates the application migrations (south migrations or Django migrations according to the current installed Django version). For South, it automatically handles initial / auto options.
Performs static analysis using pyflakes with the same configuration as django CMS.
Installing from pip:
pip install djangocms-helper
Installing from source:
pip install git+https://github.com/nephila/djangocms-helper#egg=djangocms-helper
- django CMS 3.0 (django CMS 3.0.4 is required for pyflake command)
djangocms-helper was written by Iacopo Spalletti.