Helper for django applications development
Project description
Helper for django applications development
django-app-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 develop.py script, modified to handle generic application development process.
Supported versions
Python: 2.7, 3.5, 3.6, 3.7
Django: 1.11, 2.0, 2.1
django CMS: 3.4, 3.5, 3.6
Newer versions might work but are not tested yet.
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 Project settings with Django App Helper 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:
django-app-helper <application> <command> [options ...]
where <application> is the django application name and <command> is one of the available commands. Options vary for each command.
Base test class
A base test class is available to provide helpers and methods that implements repetitive tasks during development or compatibility shims (especially for django CMS).
Bootstrapping
To bootstrap a project using django-app-helper you may want to have a look at cookiecutter-djangopackage-helper, a cookiecutter template for django-app-helper.
To use it follows usage
Runner
By using the integrated runned in the settings file you’ll be able to run the commands without invoking django-app-helper: see Integrated runner for reference.
Installation
Installing from pip:
pip install django-app-helper
Installing from source:
pip install git+https://github.com/nephila/django-app-helper#egg=django-app-helper
Requirements
django CMS optional; required only to work with --cms option
docopt
tox
dj-database-url
Documentation
Documentation is available on readthedocs.
