Metadata-Version: 1.0
Name: django-wizard
Version: 0.1.3
Summary: A wizard that helps to control page flow.
Home-page: https://github.com/imtapps/django-wizard
Author: Matthew J. Morrison
Author-email: mattjmorrison@mattjmorrison.com
License: UNKNOWN
Description: Django Wizard
        
        Django wizard uses Step classes to control page flow.
        
        To create a wizard, you need a url route defined that is going to point to a
        view and take a step parameter, like this:
        
        url(r'^(?P<step>[a-zA-Z]+)?$', views.NewWizard.as_view(), name='new_wizard'),
        
        That view then must instantiate the wizard passing it the url name, and a list of steps.
        Then the wizard's handle_request method should be called and returned with the request
        and the current step name (From the url)
        
        IE:
        def my_view(request, step):
            Wizard('new_wizard', [('StepOne', mysteps.StepOne), ('StepTwo', mysteps.StepTwo)])
            return wizard.handle_request(request, step)
        
        
        The wizard also has a defaulted navigation_opts argument that can be passed in the __init__
        navigation options are a dictionary with a key of a string that will map to a field in
        the Request, and the value is an int. These tell the wizard what direction to go and how far
        in which scenarios.
        
        The defaults are:
        
        wizard_save: 0
        wizard_continue: 1
        wizard_previous: -1
        wizard_next: 1
        
        The view can also set a few additional things on the wizard:
        
        set_redirect_args(*args, **kwargs)
            - use this to tell the wizard what it needs to privode to django's reverse function
              when doing redirects
        
        set_step_init_args(*args, **kwargs)
            - use this to supply additional arguments to your step class __init__'s
        
        set_common_template_args(dict)
            - use this to add stuff that will always be available in all of your wizard created
              templates
        
        A Step class is just an object that must the following methods
        
        display
            - only takes self as an argument and returns the object that should be
              passed to django's template engine
        
        save
            - only takes self as an argument and returns nothing
        
        template
            - only takes self as an argument and must return the template object to be used
              by the wizard to render the response
        
            IE: return loader.get_template('some_template_file.html')
        
        prereq
            - only takes self as an argument and can raise a wizard.PrereqMissing when
              an error occurs in the page flow
        
        when each step is instantiated by the wizard it is passed any url args or kwargs that
        may be present
        
        The wizard then adds the following properties
        
        _key = which is the string used as the step's key
        _wizard = is the current instance of the wizard
        _current_step is the key of the current_step
        
        PrereqMissing is an exception that can modify the standard page flow
            - the __init__ accepts an optional step key, a request and a message
        
            - if the step key is provided, the wizard will redirect to that step
        
            - if a request and message are provided it will add the message to
              django's messaging framework
        
        SaveStepException is an exception that can be raised in the save method that
              lets the wizard know that the step could not be saved and needs to be repeated
        
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
