alfer-django-authx 0.1.1

Reusable Django authentication package with email-based authentication, OTP verification, password reset, and JWT support.

django-authx

Reusable Django authentication package with email-based authentication, OTP verification, and JWT support.

---

🚀 Features

• Email-based authentication (no username)
• Signup with email & password
• Email OTP verification
• Resend OTP support
• Forgot password (OTP-based)
• Reset password via OTP
• JWT authentication (access + refresh tokens)
• Role-based permissions (Admin / Manager / User)
• Fully configurable via .env
• Clean and consistent API response format
• Production-ready structure
• Custom signals for extensibility

---

📦 Installation

pip install alfer-django-authx


## 🔔 Available Signals

The package exposes the following Django signals:

- `otp_created`
- `user_verified`
- `password_reset_done`

These can be used to hook in custom business logic such as:
- sending notifications
- audit logging
- onboarding flows
- analytics events

## Required Configuration

At minimum, configure these in your Django project:

### `INSTALLED_APPS`
```python
INSTALLED_APPS = [
    ...
    "rest_framework",
    "rest_framework_simplejwt",
    "authx.apps.AuthxConfig",
]


# AUTH_USER_MODEL
AUTH_USER_MODEL = "authx.User"
# AUTHENTICATION_BACKENDS
AUTHENTICATION_BACKENDS = [
    "authx.backends.EmailBackend",
    "django.contrib.auth.backends.ModelBackend",
]
# REST_FRAMEWORK
REST_FRAMEWORK = {
    "DEFAULT_AUTHENTICATION_CLASSES": (
        "rest_framework_simplejwt.authentication.JWTAuthentication",
    ),
    "EXCEPTION_HANDLER": "authx.exceptions.custom_exception_handler",
}