Metadata-Version: 2.1
Name: django-app-helper
Version: 2.1.0
Summary: Helper for django applications development
Home-page: https://github.com/nephila/django-app-helper
Author: Iacopo Spalletti
Author-email: i.spalletti@nephila.it
License: GPLv2+
Description: =================
        Django App helper
        =================
        
        |Gitter| |PyPiVersion| |PyVersion| |Status| |TestCoverage| |CodeClimate| |License|
        
        .. warning::  This project used to be called djangocms-helper. It's been renamed
                      in version 2.0 to clarify that it's not limited to django CMS apps.
        
                      See `Migrating from djangocms-helper to django-app-helper`_ for further information.
        
        ******************************************
        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.
        
        It supports both tests writted using Django ``TestCase`` and pytest ones
        (see `pytest support`_).
        
        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 <i.spalletti@nephila.it>`_ 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.
        
        
        
        .. |Gitter| image:: https://img.shields.io/badge/GITTER-join%20chat-brightgreen.svg?style=flat-square
            :target: https://gitter.im/nephila/applications
            :alt: Join the Gitter chat
        
        .. |PyPiVersion| image:: https://img.shields.io/pypi/v/django-app-helper.svg?style=flat-square
            :target: https://pypi.python.org/pypi/django-app-helper
            :alt: Latest PyPI version
        
        .. |PyVersion| image:: https://img.shields.io/pypi/pyversions/django-app-helper.svg?style=flat-square
            :target: https://pypi.python.org/pypi/django-app-helper
            :alt: Python versions
        
        .. |Status| image:: https://img.shields.io/travis/nephila/django-app-helper.svg?style=flat-square
            :target: https://travis-ci.org/nephila/django-app-helper
            :alt: Latest Travis CI build status
        
        .. |TestCoverage| image:: https://img.shields.io/coveralls/nephila/django-app-helper/master.svg?style=flat-square
            :target: https://coveralls.io/r/nephila/django-app-helper?branch=master
            :alt: Test coverage
        
        .. |License| image:: https://img.shields.io/github/license/nephila/django-app-helper.svg?style=flat-square
           :target: https://pypi.python.org/pypi/django-app-helper/
            :alt: License
        
        .. |CodeClimate| image:: https://codeclimate.com/github/nephila/django-app-helper/badges/gpa.svg?style=flat-square
           :target: https://codeclimate.com/github/nephila/django-app-helper
           :alt: Code Climate
        
        .. _Migrating from djangocms-helper to django-app-helper: https://django-app-helper.readthedocs.io/en/latest/migrating.html
        .. _Project settings with Django App Helper: https://django-app-helper.readthedocs.io/en/latest/settings.html
        .. _Integrated runner: https://django-app-helper.readthedocs.io/en/latest/runner.html
        .. _cookiecutter: https://github.com/audreyr/cookiecutter
        .. _cookiecutter-djangopackage-helper: https://github.com/nephila/cookiecutter-djangopackage-helper
        .. _readthedocs: https://django-app-helper.readthedocs.io
        .. _django CMS's: https://github.com/divio/django-cms:
        .. _usage: https://github.com/nephila/cookiecutter-djangopackage-helper#usage
        .. _pytest support: https://django-app-helper.readthedocs.io/en/latest/pytest.html
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Provides-Extra: pyflakes
Provides-Extra: cms
