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

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.0a1.tar.gz (41.1 kB view details)

Uploaded Source

Built Distribution

django_app_helper-2.0.0a1-py2.py3-none-any.whl (47.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-app-helper-2.0.0a1.tar.gz.

File metadata

  • Download URL: django-app-helper-2.0.0a1.tar.gz
  • Upload date:
  • Size: 41.1 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for django-app-helper-2.0.0a1.tar.gz
Algorithm Hash digest
SHA256 2bbb048e2135bd8fb8023e6c1e71bd89eb6b4598d4200f4c199e4fc1558d85d9
MD5 dbf50fc2a3cc58d24cfb10cfbd82504a
BLAKE2b-256 63473ab43552e22b8c87e82a74db82a0c4c13634b63fc166017d8d80116962fa

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: django_app_helper-2.0.0a1-py2.py3-none-any.whl
  • Upload date:
  • Size: 47.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using 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

File hashes

Hashes for django_app_helper-2.0.0a1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a08586a0e6ee0bd3f9dd168d5ce5dfb7be220f43fa1c21eb709162bdd4dffd00
MD5 33536f54f8a00382ddb4169c88ea29f4
BLAKE2b-256 9ed0548218d6422f1aca0a63aa6645d43ba31547c98d213fc7d1b14cd5bf418d

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