Skip to main content

Helper for django applications development

Project description

Join the Gitter chat Latest PyPI version Python versions Latest Travis CI build status Test coverage Code Climate License

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.2 (3.0 when not using django CMS integration)

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

Authors

django-app-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

django-app-helper-2.0.1.tar.gz (41.0 kB view details)

Uploaded Source

Built Distribution

django_app_helper-2.0.1-py2.py3-none-any.whl (47.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-app-helper-2.0.1.tar.gz.

File metadata

  • Download URL: django-app-helper-2.0.1.tar.gz
  • Upload date:
  • Size: 41.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.7.3

File hashes

Hashes for django-app-helper-2.0.1.tar.gz
Algorithm Hash digest
SHA256 4b7128627f1edfd818c393b906c17f8d9745b3f3f423c725738d50d2353a8ec9
MD5 e13e608db975a9b68d39bb8be9f59061
BLAKE2b-256 55288c454a82eb80680aa13649abe48d92f27ed3ce76d62de9b61e18e8de54bf

See more details on using hashes here.

Provenance

File details

Details for the file django_app_helper-2.0.1-py2.py3-none-any.whl.

File metadata

  • Download URL: django_app_helper-2.0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 47.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.7.3

File hashes

Hashes for django_app_helper-2.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 068ac0ca363382fa0d2c33c7d42f2f4027625a12fa8007f7213d1d6f423a903b
MD5 290fb2303f3d199016614715ecccbe68
BLAKE2b-256 19609d9eaa2160f02c1458494407f755919ed6bb4a425c7157ddc3f82bbd3150

See more details on using hashes here.

Provenance

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