Installation

Requirements

Python 3.8 to 3.12 supported.

Django 3.2 to 5.0 supported.

Installation

1. Install with pip:

   python -m pip install django-invitations
   

2. Add "invitations" to INSTALLED_APPS:

   INSTALLED_APPS = [
       ...
       "invitations",
       ...
   ]
   

Note

django-allauth support

For django-allauth support, "invitations" must come after "allauth" in the INSTALLED_APPS list.

3. If using django-allauth, then add this configuration to your settings.py file:

   # django-allauth configuration:
   ACCOUNT_ADAPTER = "invitations.models.InvitationsAdapter"
   
   # django-invitations configuration:
   INVITATIONS_ADAPTER = ACCOUNT_ADAPTER
   

4. Add invitations URLs to your urlpatterns:

   from django.urls import include, path
   
   urlpatterns = [
       ...
       path("invitations/", include('invitations.urls', namespace='invitations')),
       ...
   ]
   

5. Run migrations:

   python manage.py migrate