Initial code release

Author: codingjoe

.bandit

@@ -0,0 +1,2 @@
+[bandit]
+exclude: tests

.editorconfig

@@ -0,0 +1,23 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf
+
+[*.{json,yml,yaml,js,jsx}]
+indent_size = 2
+
+[*.{html,htm}]
+indent_size = 2
+
+[LICENSE]
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab

.fussyfox.yml

@@ -0,0 +1,4 @@
+- bandit
+- flake8
+- isort
+- pydocstyle

.gitignore

@@ -0,0 +1,65 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+db.sqlite3
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+
+
+tests/local.py
+docs/_build/
+venv
+.python-version

.travis.yml

@@ -0,0 +1,43 @@
+language: python
+dist: xenial
+python:
+  - "3.6"
+  - "3.7"
+env:
+  - DJANGO=20
+  - DJANGO=21
+  - DJANGO=22
+  - DJANGO=master
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - env: DJANGO=master
+
+install: pip install tox-travis codecov
+before_script:
+  - |
+    if [[ -z $TOXENV ]]; then
+      export TOXENV=py$(echo $TRAVIS_PYTHON_VERSION | sed -e 's/\.//g')-dj$DJANGO
+    fi
+  - echo $TOXENV
+script: tox
+after_success: codecov
+
+jobs:
+  include:
+    - python: "3.7"
+      env: TOXENV=docs
+    - stage: deploy
+      if: tag IS present
+      python: "3.7"
+      install: skip
+      script: skip
+      after_success: true
+      deploy:
+        provider: pypi
+        user: codingjoe
+        distributions: sdist bdist_wheel
+        on:
+          tags: true
+        password:

CONTRIBUTING.rst

@@ -0,0 +1,21 @@
+============
+Contributing
+============
+
+To install the development requirements simply run::
+
+    python setup.py develop
+
+To run test suite run::
+
+    python setup.py test
+
+... and to run the entire test suite, simply use tox::
+
+    pip install --upgrade tox
+    tox
+
+To build the documentation run::
+
+    python setup.py build_sphinx
+    open docs/_build/html/index.html

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Johannes Hoppe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1,6 @@
+include *.rst
+recursive-include mailauth/templates *
+recursive-include mailauth/contrib/admin/templates *
+recursive-include mailauth/contrib/admin/static *
+recursive-include mailauth/contrib/admin/locale *
+prune tests

README.rst

@@ -0,0 +1,91 @@
+================
+Django Mail Auth
+================
+
+|version| |ci| |coverage| |license|
+
+.. figure:: sample.png
+    :width: 425
+    :alt: screenshot from a login form
+
+Django Mail Auth is a lightweight authentication backend for Django,
+that does not require users to remember passwords.
+
+Django Mail Auth features:
+
+- custom user model support
+- drop in Django admin support
+- drop in Django User replacement
+- extendable SMS support
+
+This project was originally inspired by `Is it time for password-less login?`__ by `Ben Brown`_.
+
+__ http://notes.xoxco.com/post/27999787765/is-it-time-for-password-less-login
+.. _`Ben Brown`: http://twitter.com/benbrown
+
+Installation
+------------
+
+Run this command to install ``django-mail-auth``::
+
+    pip install django-mail-auth
+
+
+Setup
+-----
+
+First add `mailauth` to you installed apps::
+
+    INSTALLED_APPS = [
+        # Django's builtin apps…
+
+        'mailauth',
+        'mailauth.contrib.admin',  # optional
+        'mailauth.contrib.auth',  # optional
+
+        # other apps…
+    ]
+
+`mailauth.contrib.admin` is optional and will replace the admin's login
+with token based authentication too.
+
+`mailauth.contrib.auth` is optional and provides a new Django User model.
+The new User model needs to be enabled via the ``AUTH_USER_MODEL`` setting::
+
+    AUTH_USER_MODEL = 'mailauth.EmailUser'
+
+Next you will need to add the new authentication backend::
+
+        AUTHENTICATION_BACKENDS = (
+        # default, but now optional
+        # This should be removed if
+        'django.contrib.auth.backends.ModelBackend',
+
+        # The new access token based authentication backend
+        'mailauth.backends.MailAuthBackend',
+    )
+
+Django's `ModelBackend` is only only needed, if you still want to support
+password based authentication. If you don't, simply remove it from the list.
+
+Last but not least, go to your URL root config `urls.py` and add the following::
+
+    from django.urls import path
+
+
+    urlpatterns = [
+        path('accounts/', include('mailauth.urls')),
+    ]
+
+That's it!
+
+.. note:: Don't forget to setup you Email backend!
+
+.. |version| image:: https://img.shields.io/pypi/v/django-mail-auth.svg
+   :target: https://pypi.python.org/pypi/django-mail-auth/
+.. |ci| image:: https://travis-ci.com/codingjoe/django-mail-auth.svg?branch=master
+   :target: https://travis-ci.com/codingjoe/django-mail-auth
+.. |coverage| image:: https://codecov.io/gh/codingjoe/django-mail-auth/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/codingjoe/django-mail-auth
+.. |license| image:: https://img.shields.io/badge/license-APL2-blue.svg
+   :target: LICENSE

docs/conf.py

@@ -0,0 +1,30 @@
+"""Sphinx configuration file."""
+import os
+import sys
+
+import django
+from pkg_resources import get_distribution
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.testapp.settings")
+sys.path.insert(0, os.path.abspath('..'))
+django.setup()
+
+project = "Django Mail Auth"
+copyright = "2019, Johannes Hoppe"
+release = get_distribution('django-mail-user').version
+version = '.'.join(release.split('.')[:2])
+
+master_doc = 'index'
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.doctest',
+]
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'django': ('https://docs.djangoproject.com/en/stable/',
+               'https://docs.djangoproject.com/en/stable/_objects/'),
+}

docs/contributing.rst

@@ -0,0 +1 @@
+.. include:: ../CONTRIBUTING.rst

docs/customizing.rst

@@ -0,0 +1,78 @@
+===========
+Customizing
+===========
+
+Django Mail Auth can be easily extend. Besides template adaptations it is
+possible to send send different messages like SMS. To make those changes you
+will need to write a custom login form.
+
+Custom login form
+-----------------
+
+Custom login forms need to inherit from :class:`.BaseLoginForm` and override
+the :meth:`save<.BaseLoginForm.save>` method.
+
+The following example is for a login SMS via twilio. This will require a
+custom user model with a unique ``phone_number`` field::
+
+    from django import forms
+    from django.contrib.auth import get_user_model
+    from django.template import loader
+    from mailauth.forms import BaseLoginForm
+
+
+    class SmsLoginForm(BaseLoginForm):
+        phone_number = forms.CharField()
+
+        template_name = 'registration/login_sms.txt
+        from_number = None
+
+        def __init__(self, *args, **kwargs):
+            self.twilio_client = TwilioRestClient(
+                settings.TWILIO_SID,
+                settings.TWILIO_AUTH_TOKEN
+            )
+            super().__init__(*args, **kwargs)
+
+        def save(self):
+            phone_number = self.cleaned_data['phone_number']
+            user = get_user_model().objects.get(
+                phone_number=phone_number
+            )
+            context = self.get_context(self.request, user)
+
+            from_number = self.from_number or getattr(
+                settings, 'DEFAULT_FROM_NUMBER'
+            )
+            sms_content = loader.render_to_string(
+                self.template_name, context
+            )
+
+            self.twilio_client.messages.create(
+                to=user.phone_number,
+                from_=from_number,
+                body=sms_content
+            )
+
+
+To add the new login form, simply add a new login view to your URL config with
+the custom form::
+
+    from django.urls import path
+    from mailauth.views import LoginView
+
+    from .forms import SmsLoginForm
+
+    urlpatterns = [
+        path(
+            'login/sms/',
+            LoginView.as_view(form_class=SmsLoginForm),
+            name='login-sms'
+        ),
+    ]
+
+API documentation
+-----------------
+
+.. autoclass:: mailauth.forms.BaseLoginForm
+    :members: