Skip to main content

Internal authentication package using Django Allauth, DRF and SimpleJWT

Project description

Bunifu Django Auth

A standardized authentication framework for Django projects built on:

  • Django
  • Django Allauth
  • Django REST Framework
  • SimpleJWT

Designed for internal organizational consistency and centralized user model management.


Features

  • Email-based authentication
  • JWT access & refresh tokens
  • Token rotation & blacklisting
  • DRF-ready endpoints
  • Automatic safe default configuration
  • Pluggable and override-friendly
  • Production-ready test suite (pytest + factoryboy)

Installation

TestPypi Repository

using uv or pip

uv add bunifu-django-auth
---------------------
pip install bunifu-django-auth 

Quick Start

Add to Installed Apps

INSTALLED_APPS = [
    "allauth",
    "allauth.account",
    "rest_framework",
    "rest_framework_simplejwt",
    "rest_framework_simplejwt.token_blacklist",
    "bunifu_django_auth",
]

Register auth user model

AUTH_USER_MODEL="bunifu_django_auth.BunifuUser"

Include URLs

from django.urls import path, include

urlpatterns = [
    path("auth/", include("bunifu_django_auth.urls")),
    # add allauth urls for the allauth paths
    path("accounts/", include("allauth.urls")),
]

Include the JWTAuthorization

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

Ensure the allauth middleware is added as below

MIDDLEWARE = [
    ...
    # add this
    "allauth.account.middleware.AccountMiddleware"
]

Migrate the tables

python manage.py migrate

That’s it.

No additional configuration required.


Available Endpoints

Endpoint Method Description
/auth/register/ POST Register new user
/auth/login/ POST Obtain JWT access & refresh tokens
/auth/refresh/ POST Refresh access token
/auth/logout/ POST Blacklist refresh token

Default Configuration

The package automatically applies safe defaults:

  • Email authentication
  • JWT token rotation
  • 15-minute access tokens
  • 7-day refresh tokens
  • Refresh token blacklisting
  • DRF JWT authentication backend

All settings can be overridden in the host project.

Example:

SIMPLE_JWT = {
    "ACCESS_TOKEN_LIFETIME": timedelta(minutes=5),
}

Overriding custom user model abstract

from django.db import models
from bunifu_django_auth.models import BunifuAbstractUser

class CustomUser(BunifuAbstractUser):
    user_stats = models.JSONField(default=list)

Then in the settings

AUTH_USER_MODEL = "your_app.CustomUser"

Overriding Serializers

You may override serializers if needed:

BUNIFU_REGISTER_SERIALIZER = "yourapp.serializers.CustomRegisterSerializer"

Running Tests

pytest

With coverage:

pytest --cov=bunifu_django_auth

License

MIT License © 2026 Bunifu

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bunifu_django_auth-0.3.0.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bunifu_django_auth-0.3.0-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file bunifu_django_auth-0.3.0.tar.gz.

File metadata

  • Download URL: bunifu_django_auth-0.3.0.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for bunifu_django_auth-0.3.0.tar.gz
Algorithm Hash digest
SHA256 0a339a83ca3352b5c06f144536764bebbd9775aefa2183cb1956722a57c3e10f
MD5 d17a94d6a1b0a355b5f1bdb3f65d7b59
BLAKE2b-256 d8af3efd36184fbf131fc209f957af178d04d8b0dfb18e7832dfb35733a72731

See more details on using hashes here.

File details

Details for the file bunifu_django_auth-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for bunifu_django_auth-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9ac3e5b09ddbdf0f31b0454d8e0504429fb3a965e49f16e949372271bc60bce6
MD5 83c839bf3bd5d1a03a1a57284c2ae071
BLAKE2b-256 a93f0f5ac2d739683bf7cf0db4de9571a7db4755436a933483d75d9a5fecaf97

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page