File: installation.rst

package info (click to toggle)
django-invitations 2.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 456 kB
  • sloc: python: 1,484; makefile: 27; sh: 6
file content (48 lines) | stat: -rw-r--r-- 829 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
Installation
============

Requirements
------------

Python 3.7 to 3.10 supported.

Django 3.2 to 4.0 supported.

Installation
------------

1. Install with **pip**:

   .. code-block:: sh

       python -m pip install django-invitations

2. Add "invitations" to INSTALLED_APPS

   .. code-block:: python

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

.. note:: **Allauth support**

   For allauth support ``invitations`` must come after ``allauth`` in the INSTALLED_APPS

3. Add invitations urls to your urlpatterns:

   .. code-block:: python

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

4. Run migrations

    .. code-block:: sh

        python manage.py migrate