Built on top of django-registration
, django-inviting handles registration through invitations.
- Invitations can be optional or required to be registered.
- Admin integration
- Adding available invitations with custom performance and rewarding algorithms. (for invite only mode)
This application depends on django-registration
.
- Add
"django-inviting"
directory to your Python path. - Add
"invitation"
to yourINSTALLED_APPS
tuple found in your settings file. - Include
"invitation.urls"
to your URLconf.
TODO
You can configure django-inviting
app's behaviour with the following settings:
- INVITATION_INVITE_ONLY
Set this to True if you want registration to be only possible via invitations. Default value is
False
.- INVITATION_EXPIRE_DAYS
How many days before an invitation is expired. Default value is
15
.- INVITATION_INITIAL_INVITATIONS
How many invitations are available to new users. If
INVITATION_INVITE_ONLY
isFalse
this setting has no effect. Default value is10
.- INVITATION_PERFORMANCE_FUNC
A method that takes an
InvitationStats
instance and returns afloat
between0.0
and1.0
. You can supply a custom performance method by reference or by import path as a string. Default value isNone
. If a custom performance function is not supplied one of the default performance functions ininvitation.models
will be used according toINVITATION_INVITE_ONLY
value.- INVITATION_REWARD_THRESHOLD
A
float
that determines which users are rewarded. Default value is0.75
.