Skip to main content

djangocms-helper

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 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,2

django CMS: 3.4 - 3.7

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 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.

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 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 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.

Metadata

Release files for djangocms-helper 1.2.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for djangocms-helper 1.2.5
File Size Uploaded Provenance
djangocms-helper-1.2.5.tar.gz 40.5 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for djangocms-helper 1.2.5
File Interpreter ABI Platform
djangocms_helper-1.2.5-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 87.3 kB

Release files / djangocms-helper-1.2.5.tar.gz

Download URL djangocms-helper-1.2.5.tar.gz
Size 40.5 kB
Tags Source
SHA-256 checksum
How to use checksums
41973cb2effdfc05492ceb427afeb23caf6c126a334c9684e4c60b113504d249
BLAKE2b-256 checksum
How to use checksums
3d1023dbc17a45803b6fda624868b5ee56d343c0f3168af984b3338cb795a49d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

Release files / djangocms_helper-1.2.5-py2.py3-none-any.whl

Download URL djangocms_helper-1.2.5-py2.py3-none-any.whl
Size 46.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
e7e81db034d3f4cb8c55a17d26b8851775e60788e58849bc0fc5537ce562f3c7
BLAKE2b-256 checksum
How to use checksums
0eb1f78aa1cf009670712c015cbe2badddf55c61036f97a6c03511347eeebb6a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

Security for djangocms-helper 1.2.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

1.2.5 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page