Getting Started with dj-waanverse-auth¶

Welcome to dj-waanverse-auth, a library designed to streamline authentication and device management for your Django projects. Follow this guide to install and configure the package in your project.

Installation¶

Install the package via pip:

pip install dj-waanverse-auth

Setup¶

1. Add to Installed Apps¶

In your settings.py, include dj_waanverse_auth in the INSTALLED_APPS list:

INSTALLED_APPS = [
    # Django default apps
    "django.contrib.admin",
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",
    # Third-party and custom apps
    "dj_waanverse_auth",
    "rest_framework",
    "accounts",  # Replace with your custom user app
]

2. Add Middleware¶

Include the DeviceAuthMiddleware in your MIDDLEWARE settings:

MIDDLEWARE = [
    ...
    "dj_waanverse_auth.middleware.AuthCookieMiddleware",
]

3. Set Custom User Model¶

Set up the user model as described in Configuring User Model.

Specify your custom user model in settings.py:

AUTH_USER_MODEL = "accounts.Account"  # Replace `accounts.Account` with your custom user model

4. Configure Authentication Backends¶

Add the custom authentication backend to enable JWT-based authentication:

AUTHENTICATION_BACKENDS = [
    "dj_waanverse_auth.backends.AuthenticationBackend",  # Custom backend
    "django.contrib.auth.backends.ModelBackend",         # Default Django backend
]

5. Configure REST Framework¶

Set up the DEFAULT_AUTHENTICATION_CLASSES for Django REST Framework in settings.py:

REST_FRAMEWORK = {
    "DEFAULT_AUTHENTICATION_CLASSES": (
        "dj_waanverse_auth.authentication.JWTAuthentication",
    ),
}

6. Add Private/Public Key Paths¶

Add the PUBLIC_KEY_PATH and PRIVATE_KEY_PATH to the package's settings configuration in your settings.py:

WAANVERSE_AUTH_CONFIG = {
    "PUBLIC_KEY_PATH": "/path/to/public_key.pem",
    "PRIVATE_KEY_PATH": "/path/to/private_key.pem",
}

For a complete list of configurable settings, check out Configuration.

7. Configure URLs¶

Include the package's URLs in your project's URL configuration:

from django.urls import path, include

urlpatterns = [
    ...
    path("api/v1/", include("dj_waanverse_auth.urls")),
]

Final Steps¶

1. Apply Migrations¶

Run the following command to apply migrations:

python manage.py migrate

2. Start the Development Server¶

Run the server to ensure everything is configured correctly:

python manage.py runserver

3. Run Configuration Check¶

You can verify your setup and identify any missing required settings using the following command:

python manage.py auth-check

This will provide feedback on your configuration and highlight any missing settings or issues.

🎉 Congratulations! Your Django project is now set up to use dj-waanverse-auth for advanced authentication and device management.