apps.signup

A django application for managing creation and authentication of new user accounts.

apps.signup.urls

The urls module configures routes from URLs to views.

URL View name
/ SignUp signup
activation_sent ActivationSentView activation-sent
[AUTH-TOKEN-LINK] ActivateAccount activate

apps.signup.admin

The admin module defines app level interfaces for the website’s admin panel.

class broker_web.apps.signup.admin.CustomUserAdmin(model, admin_site)

Custom admin interface for user management

add_form

alias of broker_web.apps.signup.forms.CustomUserCreationForm

form

alias of broker_web.apps.signup.forms.CustomUserChangeForm

model

alias of broker_web.apps.signup.models.CustomUser

apps.signup.forms

The forms module defines views forms for data entry and query construction.

broker_web.apps.signup.forms.CustomUserChangeForm Custom form for modifying user data
broker_web.apps.signup.forms.CustomUserCreationForm Custom form for creating a new CustomUser
class broker_web.apps.signup.forms.CustomUserChangeForm(*args, **kwargs)

Custom form for modifying user data

class broker_web.apps.signup.forms.CustomUserCreationForm(*args, **kwargs)

Custom form for creating a new CustomUser

validate(value)

Check if value consists only of valid emails.

apps.signup.managers

The managers module defines Manager objects to handle DB changes

class broker_web.apps.signup.managers.CustomUserManager

Custom user model manager

create_superuser(email, password, **extra_fields)

Create and save a SuperUser with the given email and password.

create_user(email, password, **extra_fields)

Create and save a User with the given email and password.

apps.signup.models

The models module defines Model objects for representing backend DB constructs.

class broker_web.apps.signup.models.CustomUser(*args, **kwargs)

Custom user model for authentication

exception DoesNotExist
exception MultipleObjectsReturned

apps.signup.tokens

Custom token generation for user signup tasks

class broker_web.apps.signup.tokens.TokenGenerator

apps.signup.views

The views module defines View objects for converting web requests into rendered responses.

broker_web.apps.signup.views.ActivateAccount View that account verification
broker_web.apps.signup.views.ActivationSentView Render a template.
broker_web.apps.signup.views.SignUp View that handles CustomUser creation
class broker_web.apps.signup.views.ActivateAccount(**kwargs)

View that account verification

get(request, uidb64, token)

Handle an incoming HTTP request

Parameters:
  • request (HttpRequest) – Incoming HTTP request
  • uidb64 (str) – Base 64 encoded user id
  • token (str) – Activationn auth token
Returns:

Outgoing HTTPResponse

class broker_web.apps.signup.views.SignUp(**kwargs)

View that handles CustomUser creation

form_class

alias of broker_web.apps.signup.forms.CustomUserCreationForm

form_valid(form)

Sends email confirmation for new user creation

Called after form is validated

Parameters:form (django.forms.Form) – User creation form