Skip to main content

Helpers for django CMS plugin development

Project description

Latest PyPI version Monthly downloads Python versions Latest Travis CI build status Test coverage Test coverage Code Climate

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.

Supported versions

Python: 2.6, 2.7, 3.3, 3.4, 3.5

Django: 1.6 to 1.10

django CMS: 3.0 to 3.4

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. Options vary for each command.

Bootstrapping

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

djangocms-helper-0.9.9.tar.gz (38.1 kB view details)

Uploaded Source

Built Distribution

djangocms_helper-0.9.9-py2.py3-none-any.whl (47.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file djangocms-helper-0.9.9.tar.gz.

File metadata

File hashes

Hashes for djangocms-helper-0.9.9.tar.gz
Algorithm Hash digest
SHA256 c016d4a27dee45694e77cbd8e8f7d6f013cdf9385ec7e90936c6f14c43b49282
MD5 1bc195a2aac3184d031994d622dbaa49
BLAKE2b-256 b0d6885636e8872dc9e7fe3cf74440b6913674004f52a9085e5878a5a34f1673

See more details on using hashes here.

File details

Details for the file djangocms_helper-0.9.9-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for djangocms_helper-0.9.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f79be7ca283f20f198ac9fc81e4c6f5430ce050cdf6753de171aa09d52762979
MD5 73c3948ef65c90173c3f536d927dfba3
BLAKE2b-256 d2d9276296855e24cf57ba757b85b6c4b6dfb11cfab7ad2c7194d797b89da640

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page