Integration

TODO: write complete description

This section describes step by step integration of django-plans with your application.

Enable plans application in django

Add this app to your INSTALED_APPS in django settings.py:

INSTALLED_APPS += ('plans', )

You should also define all other variables in settings.py marked as required. They are described in detail in section Configuration via settings.

Don’t forget to run:

$ python manage.py syncdb

If you are going to use South migrations please read section Working with South migrations.

Enable context processor

Section Templates describes a very helpful content processor that you should definitely enable in your project settings in this way:

from django.conf import global_settings

TEMPLATE_CONTEXT_PROCESSORS = global_settings.TEMPLATE_CONTEXT_PROCESSORS + (
    'plans.context_processors.account_status'
    )

Send signal when user account is fully activated

You need to explicitly tell django-plans that user has fully activated account. django-plans provides a special signal that it listen to.

plans.signals.activate_user_plan(user)

You should send this signal providing user argument as an object of auth.User. django-plans will use this information to initialize plan for this user, i.e. set account expiration date and will mark the default plan as active for this account.

Note

If you use django-registration app for managing user registration process, you are done. django-plans automagically integrates with this app (if it is available) and will activate user plan when django-registration send it’s signal after account activation.

Project Versions

Table Of Contents

Previous topic

Installation

Next topic

Configuration via settings

This Page