Skip to main content

django-unique-user-email

Project description

django-unique-user-email

Enable login-by-email with the default User model for your Django project by making auth.User.email unique.

A quick note on why?

Django's leaky battery is its recommendation that you create a custom user model. Auth is so central and so standard that, into the high-nines (99.99%?), the vast majority of projects should never need to customise the central auth model. This is a battery that Django should very much provide.

There's a complexity tax from exposing the auth model. There's a performance tax as the auth model becomes a generic dumping ground for User related data that has nothing to do with authentication. There's a learning tax as users hit the custom user model, and the (frankly, misplaced) warnings about it's importance.

Again, the vast majority of projects should never need to customise the central auth model.

Can I login with my email?

Most projects, all folks wanted was login-by-email. By making the default auth.User model have unique email field, and a few other bits and bobs, this is enabled.

The goal of this package is to give you the tools you need for login-by-email with Django's default User model. I believe this should be a option in Django itself, so it's a proof-of-concept for a future discussion there too.

A longer discussion, Coming Soon. Until then I did a blog post that says a little more.

Overview

  • Install from pip:

      pip install django-unique-user-email
    
  • Add to INSTALLED_APPS

      INSTALLED_APPS = [
          "django.contrib.admin",
          "django.contrib.auth",
          "django.contrib.contenttypes",
          "django.contrib.sessions",
          "django.contrib.messages",
          "django.contrib.staticfiles",
    
          "unique_user_email",
          ...
      ]
    
  • Migrate to add the unique constraint to User.email.

  • Install auth backend to allow email login

      AUTHENTICATION_BACKENDS = [
          'unique_user_email.backend.EmailBackend',
          'django.contrib.auth.backends.ModelBackend',
      ]
    
  • Use the custom AuthenticationForm to login with username or email.

      # urls.py
      from django.contrib.auth.views import LoginView
      from unique_user_email.forms import AuthenticationForm
    
      urlpatterns = [
          # Route LoginView before other auth views to match first.
          # https://docs.djangoproject.com/en/dev/topics/auth/default/#module-django.contrib.auth.views
          path(
              "accounts/login/",
              LoginView.as_view(form_class=AuthenticationForm),
              name="login",
          ),
          ...
      ]
    

Fuller tutorial, Coming Soon.

Testing

  • Clone the repo, create a virtual environment, and pip install -e . the package.

  • You can run with just test.

    This wraps the full command:

      django-admin test --settings=tests.settings --pythonpath=.
    

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

django-unique-user-email-23.2.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

django_unique_user_email-23.2-py2.py3-none-any.whl (6.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-unique-user-email-23.2.tar.gz.

File metadata

File hashes

Hashes for django-unique-user-email-23.2.tar.gz
Algorithm Hash digest
SHA256 1da83203fcecedcf57da8542fa67ce24ff89f6b16be082448da836e61be69d05
MD5 1b4a1768a0bd8229dcf88c359844973d
BLAKE2b-256 45d6f58c29f99628b2f3af6129406a31b09185a46fa87e25086d95e371e3deeb

See more details on using hashes here.

Provenance

File details

Details for the file django_unique_user_email-23.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_unique_user_email-23.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cf613006ef0112f4952eebccc3d8e1df1583abac90550eb20abd02d8834e6219
MD5 b97375f00af1b1a0bf279aff0fd8dd45
BLAKE2b-256 3efc7256e1385d2ce944c87424493394e3884d5660d99fa825fdce3bfb543fdb

See more details on using hashes here.

Provenance

Supported by

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