Metadata-Version: 2.1
Name: django-app-helper
Version: 2.2.2
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+
Project-URL: Documentation, https://django-app-helper.readthedocs.io/
Description: =================
        Django App helper
        =================
        
        |Gitter| |PyPiVersion| |PyVersion| |GAStatus| |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 - 3.0
        
        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
        
        .. |GAStatus| image:: https://github.com/nephila/django-app-helper/workflows/Linting%20-%20Tests/badge.svg
            :target: https://github.com/nephila/django-app-helper
            :alt: Latest 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
        
        .. :changelog:
        
        *******
        History
        *******
        
        .. towncrier release notes start
        
        2.2.2 (2020-05-15)
        =======================
        
        Bugfixes
        --------
        
        - Fix pytest args splitting (#155)
        - Fix runserver autoreload with channels 2.4 (#157)
        
        
        2.2.1 (2020-04-23)
        ==================
        
        - Fix packaging error
        
        2.2.0 (2020-04-23)
        ==================
        
        Features
        --------
        
        - Add Django 3.0 / django CMS 3.7.2 support (#142)
        - Replace makefile with invoke (#143)
        
        
        2.1.1 (2020-02-04)
        ==================
        
        - Improved pytest compatibility
        
        2.1.0 (2019-12-27)
        ==================
        
        - Reformat code with black and improve flake8 configuration
        - Add pytest-compatible runner
        
        2.0.1 (2019-12-22)
        ==================
        
        - Add Django 3.0 preliminary support
        
        2.0.0 (2019-10-13)
        ==================
        
        - Rename application to django-app-helper
        
        1.2.5 (2019-08-16)
        ==================
        
        - Add django CMS 3.7
        - Add Django 2.2
        
        1.2.4 (2019-08-08)
        ==================
        
        - Fix regression introduced by #116
        
        1.2.3 (2019-08-05)
        ==================
        
        - Move pyflakes to extras_require
        - Fix error in get_request / post_request not preserving current_page
        
        1.2.2 (2019-07-05)
        ==================
        
        - Improve request generation by adding a more generic request method
        
        1.2.1 (2019-07-04)
        ==================
        
        - Fix error when creating users with non-writable email attribute
        
        1.2.0 (2019-03-22)
        ==================
        
        - Drop compatiblity with Django <1.11, Python 3.4
        - Add django CMS 3.6
        - Add django 2.0, 2.1
        
        1.1.1 (2019-07-03)
        ==================
        
        - Fix error when creating users with non-writable email attribute
        
        1.1.0 (2018-02-20)
        ==================
        
        - Remove Django <1.8, Python 2.6, 3.3 from setup.py
        - Add Django 1.11, Python 3.6
        - Switch to new-style middlewares for Django 1.10+
        - Create static methods to generate images
        - Fix persistent option behavior with arbitrary commands
        - Add minimal changes to allow third party application to run test on django 2.0
        - Fix options for channels runserver
        - Remove support for django-nose test runner
        
        1.0.0 (2017-07-25)
        ==================
        
        - Add ApphookReloadMiddleware in server mode
        - Add a default for FILE_UPLOAD_TEMP_DIR
        - Add fix for django CMS 3.4.4 render_plugin
        
        0.9.8 (2017-03-04)
        ==================
        
        - Fix compatibility with newer channels releases
        
        0.9.7 (2016-12-03)
        ==================
        
        - Add support for django-sekizai 0.10
        - Fix mock dependency in setup.py
        - Fix issue with server command in Django 1.10
        - Fix issue with urls.py in Django 1.10
        - Fix issue in tests with django CMS 3.4
        
        0.9.6 (2016-08-25)
        ==================
        
        - Add support for channels runserver.
        - Add verbosity level to server command.
        - Add support for Django 1.10.
        - Add support for django CMS 3.4.
        
        0.9.5 (2016-06-06)
        ==================
        
        - Fix issue with mocked session storage
        - Add verbosity level to tests
        - Fix user creation
        - Add option to allow parametrizing auto-created user
        - Fix extra_applications
        
        0.9.4 (2016-01-20)
        ==================
        
        - Add Naked setup mode
        - Add TEMPLATE_DIRS to special settings
        - Add TEMPLATE_LOADERS to special settings
        - Allow to specify a locale in makemessages
        
        0.9.3 (2015-10-07)
        ==================
        
        - Add --no-migrate option to skip migrations
        - Add secure argument to generate HTTPS requests
        - Better request mocking
        - Fix test on django CMS 3.2 (develop)
        - Add support for Python 3.5
        - Add --persistent option for persistent storage
        
        0.9.2 (2015-09-14)
        ==================
        
        - Add support for apphooks and parent pages in BaseTestCase.create_pages
        - If pages contains apphook, urlconf is reloaded automatically
        - Improve documentation
        - Add support for top-positioned MIDDLEWARE_CLASSES
        - Code cleanup
        
        0.9.1 (2015-08-30)
        ==================
        
        - Better support for aldryn-boilerplates
        
        0.9.0 (2015-08-20)
        ==================
        
        - Complete support for Django 1.8 / django CMS develop
        - Support for aldryn-boilerplates settings
        - Migrations are now enabled by default during tests
        - Minor BaseTestCase refactoring
        - Remove support for Django 1.5
        - Fix treebeard support
        - Minor fixes
        - Adds login_user_context method to BaseTestCase
        
        0.8.1 (2015-05-31)
        ==================
        
        - Add basic support for Django 1.8 / django CMS develop
        - Code cleanups
        - Smarter migration layout detection
        
        0.8.0 (2015-03-22)
        ==================
        
        - Add --native option to use native test command instead of django-app-helper one
        - Use django-discover-runner on Django 1.5 if present
        - Better handling of runner options
        - Add support for empty/dry-run arguments to makemigrations
        - Add USE_CMS flag to settings when using django CMS configuration
        
        0.7.0 (2015-01-22)
        ==================
        
        - Fix an error which prevents the runner to discover the settings
        - django CMS is no more a dependency, install it manually to enable django CMS support
        
        0.6.0 (2015-01-10)
        ==================
        
        - Add a runner to make cms_helper file itself a runner for django-app-helper
        - Fix issues with mptt / treebeard and Django 1.7
        - Fix some makemigrations / --migrate issues
        - Make django-app-helper less django CMS dependent
        
        0.5.0 (2015-01-01)
        ==================
        
        - Fixing bugs when using extra settings
        - Add messages framework to default environment
        - Add CSRF middleware / context_processor to default settings
        - Add base helper class for test cases
        - Complete Django 1.7 support
        - Smarter detection of migration operations in Django 1.6-
        - Add option to create migrations for external applications
        
        0.4.0 (2014-09-18)
        ==================
        
        - Add support for command line test runner options;
        - Add check command on Django 1.7+;
        - Add cms check command (which triggers cms inclusion);
        - Add squashmigration command Django 1.7+;
        - Add support for makemigrations merge on Django 1.7+;
        - Add helpers for custom user models;
        
        0.3.1 (2014-08-25)
        ==================
        
        - Add staticfiles application;
        - Add djangocms_admin_style if cms is enabled;
        
        0.3.0 (2014-08-14)
        ==================
        
        - Add support for django nose test runner;
        - Add default CMS template;
        
        0.2.0 (2014-08-12)
        ==================
        
        - Add option to customize sample project settings;
        - Add option to exclude django CMS from test project configurations;
        - Add support for Django 1.7;
        
        0.1.0 (2014-08-09)
        ==================
        
        - First public release.
        
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.2
Classifier: Framework :: Django :: 3.0
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
Classifier: Programming Language :: Python :: 3.8
Requires-Python: !=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7
Description-Content-Type: text/x-rst
Provides-Extra: pyflakes
Provides-Extra: cms
