django-solomon 0.4.2__tar.gz → 0.5.0__tar.gz

{django_solomon-0.4.2 → django_solomon-0.5.0}/CHANGELOG.md

@@ -5,25 +5,21 @@ All notable changes to django-solomon will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.4.2] - 2025-04-21
+## [0.5.0] - 2025-04-21
 
-### Improved
-
-- Enhanced case-insensitive email uniqueness constraint implementation
-- Added regression test to verify constraint behavior
-
-## [0.4.1] - 2025-04-20
-
-### Fixed
-
-- Resolved issue with Django migration system detecting duplicate constraints
-- Prevented unnecessary migration files from being created
+### Added
 
-## [0.4.0] - 2025-04-20
+- Added a custom user model that implements the `AbstractUser` model
+- System check to validate that the user model has a unique email field
+- Comprehensive test suite for system checks
+- Improved documentation for CustomUser model
+- Added documentation for system checks
+- New models.md documentation file
+- Updated README to mention CustomUser model and system checks
 
-### Added
+## [0.4.x] - 2025-04-20
 
-- Unique constraint on auth.User email field (case-insensitive)
+- All versions of the 0.4.x series were yanked due to a implemention error.
 
 ## [0.3.0] - 2025-04-20
 

{django_solomon-0.4.2 → django_solomon-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-solomon
-Version: 0.4.2
+Version: 0.5.0
 Summary: A Django app for passwordless authentication using magic links.
 Project-URL: Home, https://django-solomon.rtfd.io/
 Project-URL: Documentation, https://django-solomon.rtfd.io/
@@ -30,7 +30,7 @@ License: MIT License
         SOFTWARE.
 License-File: LICENSE
 Keywords: django
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django :: 4.2
 Classifier: Framework :: Django :: 5.0
@@ -65,6 +65,7 @@ A Django app for passwordless authentication using magic links.
 ## Features
 
 - Passwordless authentication using magic links sent via email
+- Email-based authentication with a built-in CustomUser model
 - Configurable link expiration time
 - Blacklist functionality to block specific email addresses
 - Support for auto-creating users when they request a magic link
@@ -72,7 +73,7 @@ A Django app for passwordless authentication using magic links.
 - Privacy-focused IP anonymization
 - Customizable templates for emails and pages
 - Compatible with Django's authentication system
-- Enforces unique email addresses for users (case-insensitive)
+- System checks to ensure proper configuration
 
 ## Installation
 
@@ -92,7 +93,15 @@ INSTALLED_APPS = [
 ]
 ```
 
-2. Add the authentication backend to your settings:
+2. Configure the user model in your settings:
+
+```python
+AUTH_USER_MODEL = 'django_solomon.CustomUser'
+```
+
+This setting is required for django-solomon to work properly, as it needs a user model with a unique email field for email-based authentication. You can also use your own custom user model as long as it has a unique email field.
+
+3. Add the authentication backend to your settings:
 
 ```python
 AUTHENTICATION_BACKENDS = [
@@ -101,7 +110,7 @@ AUTHENTICATION_BACKENDS = [
 ]
 ```
 
-3. Include the django-solomon URLs in your project's `urls.py`:
+4. Include the django-solomon URLs in your project's `urls.py`:
 
 ```python
 from django.urls import include, path
@@ -113,7 +122,7 @@ urlpatterns = [
 ]
 ```
 
-4. Set the login URL in your settings to use django-solomon's login view:
+5. Set the login URL in your settings to use django-solomon's login view:
 
 ```python
 LOGIN_URL = 'django_solomon:login'
@@ -121,7 +130,7 @@ LOGIN_URL = 'django_solomon:login'
 
 This ensures that when users need to authenticate, they'll be redirected to the magic link login page.
 
-5. Configure your email settings to ensure emails can be sent:
+6. Configure your email settings to ensure emails can be sent:
 
 ```python
 EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'

{django_solomon-0.4.2 → django_solomon-0.5.0}/README.md

@@ -13,6 +13,7 @@ A Django app for passwordless authentication using magic links.
 ## Features
 
 - Passwordless authentication using magic links sent via email
+- Email-based authentication with a built-in CustomUser model
 - Configurable link expiration time
 - Blacklist functionality to block specific email addresses
 - Support for auto-creating users when they request a magic link
@@ -20,7 +21,7 @@ A Django app for passwordless authentication using magic links.
 - Privacy-focused IP anonymization
 - Customizable templates for emails and pages
 - Compatible with Django's authentication system
-- Enforces unique email addresses for users (case-insensitive)
+- System checks to ensure proper configuration
 
 ## Installation
 
@@ -40,7 +41,15 @@ INSTALLED_APPS = [
 ]
 ```
 
-2. Add the authentication backend to your settings:
+2. Configure the user model in your settings:
+
+```python
+AUTH_USER_MODEL = 'django_solomon.CustomUser'
+```
+
+This setting is required for django-solomon to work properly, as it needs a user model with a unique email field for email-based authentication. You can also use your own custom user model as long as it has a unique email field.
+
+3. Add the authentication backend to your settings:
 
 ```python
 AUTHENTICATION_BACKENDS = [
@@ -49,7 +58,7 @@ AUTHENTICATION_BACKENDS = [
 ]
 ```
 
-3. Include the django-solomon URLs in your project's `urls.py`:
+4. Include the django-solomon URLs in your project's `urls.py`:
 
 ```python
 from django.urls import include, path
@@ -61,7 +70,7 @@ urlpatterns = [
 ]
 ```
 
-4. Set the login URL in your settings to use django-solomon's login view:
+5. Set the login URL in your settings to use django-solomon's login view:
 
 ```python
 LOGIN_URL = 'django_solomon:login'
@@ -69,7 +78,7 @@ LOGIN_URL = 'django_solomon:login'
 
 This ensures that when users need to authenticate, they'll be redirected to the magic link login page.
 
-5. Configure your email settings to ensure emails can be sent:
+6. Configure your email settings to ensure emails can be sent:
 
 ```python
 EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'

{django_solomon-0.4.2 → django_solomon-0.5.0}/docs/installation.md

@@ -69,7 +69,19 @@ INSTALLED_APPS = [
 ]
 ```
 
-### 2. Configure Authentication Backend
+### 2. Configure User Model
+
+django-solomon requires a user model with a unique email field for email-based authentication. You can either use the provided CustomUser model or your own custom model that meets this requirement.
+
+To use the CustomUser model from django-solomon, add the following to your settings:
+
+```python
+AUTH_USER_MODEL = 'django_solomon.CustomUser'
+```
+
+If you're using your own custom user model, ensure it has a unique email field.
+
+### 3. Configure Authentication Backend
 
 Add the authentication backend to your settings:
 
@@ -80,7 +92,7 @@ AUTHENTICATION_BACKENDS = [
 ]
 ```
 
-### 3. Include URLs
+### 4. Include URLs
 
 Include the django-solomon URLs in your project's `urls.py`:
 
@@ -94,7 +106,7 @@ urlpatterns = [
 ]
 ```
 
-### 4. Set Login URL
+### 5. Set Login URL
 
 Set the login URL in your settings to use django-solomon's login view:
 
@@ -104,7 +116,7 @@ LOGIN_URL = 'django_solomon:login'
 
 This ensures that when users need to authenticate, they'll be redirected to the magic link login page.
 
-### 5. Configure Email Settings
+### 6. Configure Email Settings
 
 Configure your email settings to ensure magic link emails can be sent:
 

django_solomon-0.5.0/docs/models.md

@@ -0,0 +1,145 @@
+---
+hide:
+  - navigation
+---
+
+# Models and System Checks
+
+This guide provides detailed information about the models and system checks in django-solomon.
+
+## Models
+
+### CustomUser
+
+django-solomon includes a `CustomUser` model that extends Django's `AbstractUser` model to provide email-based authentication.
+
+#### Features
+
+- Uses email as the unique identifier for authentication instead of username
+- Automatically sets the username to the email address
+- Includes a custom manager (`CustomUserManager`) for creating users and superusers
+
+#### Implementation
+
+```python
+class CustomUser(AbstractUser):
+    email = models.EmailField(_("email address"), unique=True)
+
+    USERNAME_FIELD = "email"
+    REQUIRED_FIELDS = ["username"]
+
+    objects = CustomUserManager()
+
+    def __str__(self):
+        return self.email
+
+    def save(self, *args, **kwargs):
+        self.username = self.email
+        super().save(*args, **kwargs)
+```
+
+#### CustomUserManager
+
+The `CustomUserManager` provides methods for creating users and superusers with email-based authentication:
+
+```python
+class CustomUserManager(BaseUserManager):
+    """
+    Custom user model manager where email is the unique identifiers
+    for authentication instead of usernames.
+    """
+
+    def create_user(self, email, password, **extra_fields):
+        """
+        Create and save a user with the given email and password.
+        """
+        if not email:
+            raise ValueError(_("The Email must be set"))
+        email = self.normalize_email(email)
+        user = self.model(email=email, **extra_fields)
+        user.set_password(password)
+        user.save()
+        return user
+
+    def create_superuser(self, email, password, **extra_fields):
+        """
+        Create and save a SuperUser with the given email and password.
+        """
+        extra_fields.setdefault("is_staff", True)
+        extra_fields.setdefault("is_superuser", True)
+        extra_fields.setdefault("is_active", True)
+
+        if extra_fields.get("is_staff") is not True:
+            raise ValueError(_("Superuser must have is_staff=True."))
+        if extra_fields.get("is_superuser") is not True:
+            raise ValueError(_("Superuser must have is_superuser=True."))
+        return self.create_user(email, password, **extra_fields)
+```
+
+### MagicLink
+
+The `MagicLink` model is used to store magic links for authentication. It includes:
+
+- A reference to the user
+- A unique token
+- Creation and expiration timestamps
+- A flag to track if the link has been used
+- Optional IP address tracking
+
+### BlacklistedEmail
+
+The `BlacklistedEmail` model is used to store email addresses that are blocked from using the magic login feature.
+
+## System Checks
+
+django-solomon includes system checks to ensure that your Django project is properly configured to work with the package.
+
+### User Model Email Check
+
+The `check_user_model_email` function checks that the user model has a unique email field, which is required for email-based authentication.
+
+```python
+@register()
+def check_user_model_email(app_configs, **kwargs):
+    """
+    Check that the user model has a unique email field.
+    """
+    errors = []
+
+    # Get the user model
+    user_model = apps.get_model(settings.AUTH_USER_MODEL)
+
+    # Check if email field exists
+    try:
+        email_field = user_model._meta.get_field("email")
+    except Exception:
+        errors.append(
+            Error(
+                "User model does not have an email field.",
+                hint="Make sure your user model has an email field.",
+                obj=settings.AUTH_USER_MODEL,
+                id="django_solomon.E001",
+            )
+        )
+        return errors
+
+    # Check if email field is unique
+    if not email_field.unique:
+        errors.append(
+            Error(
+                "User model email field must be unique.",
+                hint="Set unique=True on the email field of your user model.",
+                obj=settings.AUTH_USER_MODEL,
+                id="django_solomon.E002",
+            )
+        )
+
+    return errors
+```
+
+This check ensures that:
+
+1. The user model has an email field
+2. The email field is set as unique
+
+These requirements are essential for the email-based authentication that django-solomon provides.

{django_solomon-0.4.2 → django_solomon-0.5.0}/docs/settings.md

@@ -9,7 +9,8 @@ This guide provides detailed information about all the configurable settings in
 
 ## Overview
 
-django-solomon provides several settings that you can customize in your Django settings file. These settings control various aspects of the magic link authentication system, including link expiration, user creation, templates, and more.
+django-solomon provides several settings that you can customize in your Django settings file. These settings control
+various aspects of the magic link authentication system, including link expiration, user creation, templates, and more.
 
 ## Core Settings
 
@@ -28,7 +29,8 @@ SOLOMON_LINK_EXPIRATION = 600
 
 **Default:** `True`
 
-If enabled, only one active magic link is allowed per user. When a new magic link is requested, any existing active links for the same user will be marked as used.
+If enabled, only one active magic link is allowed per user. When a new magic link is requested, any existing active
+links for the same user will be marked as used.
 
 ```python
 # Allow multiple active magic links per user
@@ -63,7 +65,8 @@ SOLOMON_LOGIN_REDIRECT_URL = '/dashboard/'
 
 **Default:** `True`
 
-If enabled, allows superusers (admin users) to log in using magic links. If disabled, superusers will need to use the standard Django admin login.
+If enabled, allows superusers (admin users) to log in using magic links. If disabled, superusers will need to use the
+standard Django admin login.
 
 ```python
 # Disable magic link authentication for superusers
@@ -74,7 +77,8 @@ SOLOMON_ALLOW_ADMIN_LOGIN = False
 
 **Default:** `True`
 
-If enabled, allows staff users to log in using magic links. If disabled, staff users will need to use the standard Django admin login.
+If enabled, allows staff users to log in using magic links. If disabled, staff users will need to use the standard
+Django admin login.
 
 ```python
 # Disable magic link authentication for staff users
@@ -89,7 +93,8 @@ django-solomon can track and validate IP addresses for enhanced security while r
 
 **Default:** `False`
 
-If enabled, validates that magic links are used from the same IP address they were created from. This adds an extra layer of security by preventing magic links from being used if intercepted by an attacker on a different network.
+If enabled, validates that magic links are used from the same IP address they were created from. This adds an extra
+layer of security by preventing magic links from being used if intercepted by an attacker on a different network.
 
 ```python
 # Enable IP validation for magic links
@@ -100,7 +105,9 @@ SOLOMON_ENFORCE_SAME_IP = True
 
 **Default:** `True`
 
-If enabled, anonymizes IP addresses before storing them. For IPv4 addresses, the last octet is removed (e.g., 192.168.1.1 becomes 192.168.1.0). For IPv6 addresses, the last 80 bits (last 5 segments) are removed. This enhances user privacy while still allowing for IP validation.
+If enabled, anonymizes IP addresses before storing them. For IPv4 addresses, the last octet is removed (e.g.,
+192.168.1.1 becomes 192.168.1.0). For IPv6 addresses, the last 80 bits (last 5 segments) are removed. This enhances user
+privacy while still allowing for IP validation.
 
 ```python
 # Disable IP anonymization (store full IP addresses)
@@ -109,7 +116,8 @@ SOLOMON_ANONYMIZE_IP = False
 
 ## Template Settings
 
-django-solomon uses several templates for rendering emails and pages. You can customize these templates by providing your own versions.
+django-solomon uses several templates for rendering emails and pages. You can customize these templates by providing
+your own versions.
 
 ### SOLOMON_MAIL_TEXT_TEMPLATE
 
@@ -126,7 +134,8 @@ SOLOMON_MAIL_TEXT_TEMPLATE = "myapp/emails/magic_link.txt"
 
 **Default:** `"django_solomon/email/magic_link.mjml"`
 
-The template to use for HTML magic link emails (MJML format). django-solomon uses MJML for creating responsive HTML emails.
+The template to use for HTML magic link emails (MJML format). django-solomon uses MJML for creating responsive HTML
+emails.
 
 ```python
 # Use a custom MJML email template
@@ -148,7 +157,8 @@ SOLOMON_LOGIN_FORM_TEMPLATE = "myapp/auth/login_form.html"
 
 **Default:** `"django_solomon/base/invalid_magic_link.html"`
 
-The template to use for the invalid magic link page, which is shown when a user tries to use an expired or already used magic link.
+The template to use for the invalid magic link page, which is shown when a user tries to use an expired or already used
+magic link.
 
 ```python
 # Use a custom invalid magic link template
@@ -168,7 +178,8 @@ SOLOMON_MAGIC_LINK_SENT_TEMPLATE = "myapp/auth/link_sent.html"
 
 ## Email Settings
 
-django-solomon uses Django's email system to send magic links. You should configure Django's email settings in your settings file:
+django-solomon uses Django's email system to send magic links. You should configure Django's email settings in your
+settings file:
 
 ```python
 # Example email configuration for Gmail
@@ -191,18 +202,18 @@ EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
 
 Here's a summary of all available settings:
 
-| Setting                               | Default                                         | Description                                                                            |
-|---------------------------------------|-------------------------------------------------|----------------------------------------------------------------------------------------|
-| `SOLOMON_LINK_EXPIRATION`             | `300`                                           | The expiration time for magic links in seconds                                         |
-| `SOLOMON_ONLY_ONE_LINK_ALLOWED`       | `True`                                          | If enabled, only one active magic link is allowed per user                             |
-| `SOLOMON_CREATE_USER_IF_NOT_FOUND`    | `False`                                         | If enabled, creates a new user when a magic link is requested for a non-existent email |
-| `SOLOMON_LOGIN_REDIRECT_URL`          | `settings.LOGIN_REDIRECT_URL`                   | The URL to redirect to after successful authentication                                 |
-| `SOLOMON_ALLOW_ADMIN_LOGIN`           | `True`                                          | If enabled, allows superusers to log in using magic links                              |
-| `SOLOMON_ALLOW_STAFF_LOGIN`           | `True`                                          | If enabled, allows staff users to log in using magic links                             |
-| `SOLOMON_MAIL_TEXT_TEMPLATE`          | `"django_solomon/email/magic_link.txt"`         | The template to use for plain text magic link emails                                   |
-| `SOLOMON_MAIL_MJML_TEMPLATE`          | `"django_solomon/email/magic_link.mjml"`        | The template to use for HTML magic link emails (MJML format)                           |
-| `SOLOMON_LOGIN_FORM_TEMPLATE`         | `"django_solomon/base/login_form.html"`         | The template to use for the login form page                                            |
-| `SOLOMON_INVALID_MAGIC_LINK_TEMPLATE` | `"django_solomon/base/invalid_magic_link.html"` | The template to use for the invalid magic link page                                    |
-| `SOLOMON_MAGIC_LINK_SENT_TEMPLATE`    | `"django_solomon/base/magic_link_sent.html"`    | The template to use for the magic link sent confirmation page                          |
+| Setting                               | Default                                         | Description                                                                             |
+|---------------------------------------|-------------------------------------------------|-----------------------------------------------------------------------------------------|
+| `SOLOMON_LINK_EXPIRATION`             | `300`                                           | The expiration time for magic links in seconds                                          |
+| `SOLOMON_ONLY_ONE_LINK_ALLOWED`       | `True`                                          | If enabled, only one active magic link is allowed per user                              |
+| `SOLOMON_CREATE_USER_IF_NOT_FOUND`    | `False`                                         | If enabled, creates a new user when a magic link is requested for a non-existent email  |
+| `SOLOMON_LOGIN_REDIRECT_URL`          | `settings.LOGIN_REDIRECT_URL`                   | The URL to redirect to after successful authentication                                  |
+| `SOLOMON_ALLOW_ADMIN_LOGIN`           | `True`                                          | If enabled, allows superusers to log in using magic links                               |
+| `SOLOMON_ALLOW_STAFF_LOGIN`           | `True`                                          | If enabled, allows staff users to log in using magic links                              |
+| `SOLOMON_MAIL_TEXT_TEMPLATE`          | `"django_solomon/email/magic_link.txt"`         | The template to use for plain text magic link emails                                    |
+| `SOLOMON_MAIL_MJML_TEMPLATE`          | `"django_solomon/email/magic_link.mjml"`        | The template to use for HTML magic link emails (MJML format)                            |
+| `SOLOMON_LOGIN_FORM_TEMPLATE`         | `"django_solomon/base/login_form.html"`         | The template to use for the login form page                                             |
+| `SOLOMON_INVALID_MAGIC_LINK_TEMPLATE` | `"django_solomon/base/invalid_magic_link.html"` | The template to use for the invalid magic link page                                     |
+| `SOLOMON_MAGIC_LINK_SENT_TEMPLATE`    | `"django_solomon/base/magic_link_sent.html"`    | The template to use for the magic link sent confirmation page                           |
 | `SOLOMON_ENFORCE_SAME_IP`             | `False`                                         | If enabled, validates that magic links are used from the same IP they were created from |
 | `SOLOMON_ANONYMIZE_IP`                | `True`                                          | If enabled, anonymizes IP addresses before storing them                                 |

{django_solomon-0.4.2 → django_solomon-0.5.0}/justfile

@@ -46,7 +46,8 @@ VENV_DIRNAME := ".venv"
 
 # run test suite
 @test: check_uv
-    uv run pytest --cov --cov-report=html --cov-report=term -n auto
+    uv run python -m coverage run -m django test --settings tests.settings --parallel auto
+    uv run python -m coverage report
 
 # run test suite
 @test-all: check_uv

{django_solomon-0.4.2 → django_solomon-0.5.0}/mkdocs.yml

@@ -28,6 +28,7 @@ nav:
   - Home: "index.md"
   - Installation: "installation.md"
   - Settings: "settings.md"
+  - Models: "models.md"
   - Templates: "templates.md"
   - Contributing: "contributing.md"
   - Changelog: "changelog.md"

{django_solomon-0.4.2 → django_solomon-0.5.0}/pyproject.toml

@@ -6,7 +6,7 @@ readme = "README.md"
 license = { file = "LICENSE" }
 keywords = ["django"]
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3.10",
@@ -37,13 +37,9 @@ Repository = "https://codeberg.org/oliverandrich/django-solomon"
 
 [dependency-groups]
 dev = [
-    "pytest-cov>=5.0.0",
-    "pytest-django>=4.9.0",
-    "pytest-mock>=3.14.0",
-    "pytest-randomly>=3.15.0",
-    "pytest>=8.3.3",
     "django-stubs[compatible-mypy]>=5.1.1",
-    "pytest-xdist>=3.6.1",
+    "coverage[toml]",
+    "django-rich",
 ]
 
 [build-system]

{django_solomon-0.4.2 → django_solomon-0.5.0}/src/django_solomon/admin.py

@@ -1,7 +1,9 @@
 from django.contrib import admin
+from django.contrib.auth.admin import UserAdmin
 from django.utils.translation import gettext_lazy as _
 
-from django_solomon.models import BlacklistedEmail, MagicLink
+from django_solomon.forms import CustomUserCreationForm, CustomUserChangeForm
+from django_solomon.models import BlacklistedEmail, MagicLink, CustomUser
 
 
 @admin.register(BlacklistedEmail)
@@ -43,3 +45,36 @@ class MagicLinkAdmin(admin.ModelAdmin):
     def is_valid(self, obj: MagicLink) -> bool:
         """Display if the magic link is valid."""
         return obj.is_valid
+
+
+@admin.register(CustomUser)
+class CustomUserAdmin(UserAdmin):
+    add_form = CustomUserCreationForm
+    form = CustomUserChangeForm
+    model = CustomUser
+    list_display = (
+        "email",
+        "is_superuser",
+        "is_staff",
+        "is_active",
+    )
+    list_filter = (
+        "is_superuser",
+        "is_staff",
+        "is_active",
+    )
+    fieldsets = (
+        (None, {"fields": ("email", "password")}),
+        ("Permissions", {"fields": ("is_staff", "is_active", "groups", "user_permissions")}),
+    )
+    add_fieldsets = (
+        (
+            None,
+            {
+                "classes": ("wide",),
+                "fields": ("email", "password1", "password2", "is_staff", "is_active", "groups", "user_permissions"),
+            },
+        ),
+    )
+    search_fields = ("email",)
+    ordering = ("email",)

django_solomon-0.5.0/src/django_solomon/apps.py

@@ -0,0 +1,10 @@
+from django.apps import AppConfig
+
+
+class DjangoSolomonConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "django_solomon"
+
+    def ready(self):
+        # Import checks when app is ready
+        import django_solomon.checks  # noqa

{django_solomon-0.4.2 → django_solomon-0.5.0}/src/django_solomon/backends.py

@@ -2,10 +2,11 @@ from typing import Any
 
 from django.conf import settings
 from django.contrib.auth.backends import ModelBackend
+from django.contrib.auth.base_user import AbstractBaseUser
 from django.http import HttpRequest
 from django.utils.translation import gettext_lazy as _
 
-from django_solomon.models import MagicLink, UserType
+from django_solomon.models import MagicLink
 from django_solomon.utilities import get_client_ip
 
 
@@ -15,7 +16,7 @@ class MagicLinkBackend(ModelBackend):
         request: HttpRequest | None = None,
         token: str | None = None,
         **kwargs: Any,  # noqa: ARG002
-    ) -> UserType | None:
+    ) -> AbstractBaseUser | None:
         """
         Authenticates a user based on the provided magic link token. This method validates
         the token, ensures the token is not expired, and checks if the user associated

django_solomon-0.5.0/src/django_solomon/checks.py

@@ -0,0 +1,42 @@
+# django_solomon/checks.py
+from django.apps import apps
+from django.conf import settings
+from django.core.checks import Error, register
+
+
+@register()
+def check_user_model_email(app_configs, **kwargs):  # noqa: ARG001
+    """
+    Check that the user model has a unique email field.
+    """
+    errors = []
+
+    # Get the user model
+    user_model = apps.get_model(settings.AUTH_USER_MODEL)
+
+    # Check if email field exists
+    try:
+        email_field = user_model._meta.get_field("email")
+    except Exception:
+        errors.append(
+            Error(
+                "User model does not have an email field.",
+                hint="Make sure your user model has an email field.",
+                obj=settings.AUTH_USER_MODEL,
+                id="django_solomon.E001",
+            )
+        )
+        return errors
+
+    # Check if email field is unique
+    if not email_field.unique:
+        errors.append(
+            Error(
+                "User model email field must be unique.",
+                hint="Set unique=True on the email field of your user model.",
+                obj=settings.AUTH_USER_MODEL,
+                id="django_solomon.E002",
+            )
+        )
+
+    return errors