beat.web.ui.registration.views module

Views which allow users to create and activate accounts.

beat.web.ui.registration.views.activate(request, activation_key, template_name='registration/activate.html', extra_context=None)

Activate a User’s account from an activation key, if their key is valid and hasn’t expired.

By default, use the template registration/activate.html; to change this, pass the name of a template as the keyword argument template_name.

Required arguments

activation_key

The activation key to validate and use for activating the User.

Optional arguments

extra_context

A dictionary of variables to add to the template context. Any callable object in this dictionary will be called to produce the end result which appears in the context.

template_name

A custom template to use.

Context:

account

The User object corresponding to the account, if the activation was successful. False if the activation was not successful.

expiration_days

The number of days for which activation keys stay valid after registration.

Any extra variables supplied in the extra_context argument (see above).

Template:

registration/activate.html or template_name keyword argument.

beat.web.ui.registration.views.register(request, success_url=None, form_class=<class 'beat.web.ui.registration.forms.RegistrationFormTermsOfService'>, template_name='registration/registration_form.html', extra_context=None)

Allow a new user to register an account.

Following successful registration, issue a redirect; by default, this will be whatever URL corresponds to the named URL pattern registration_complete, which will be /accounts/register/complete/ if using the included URLConf. To change this, point that named pattern at another URL, or pass your preferred URL as the keyword argument success_url.

By default, registration.forms.RegistrationForm will be used as the registration form; to change this, pass a different form class as the form_class keyword argument. The form class you specify must have a method save which will create and return the new User.

By default, use the template registration/registration_form.html; to change this, pass the name of a template as the keyword argument template_name.

Required arguments

None.

Optional arguments

form_class

The form class to use for registration.

extra_context

A dictionary of variables to add to the template context. Any callable object in this dictionary will be called to produce the end result which appears in the context.

success_url

The URL to redirect to on successful registration.

template_name

A custom template to use.

Context:

form

The registration form.

Any extra variables supplied in the extra_context argument (see above).

Template:

registration/registration_form.html or template_name keyword argument.