codingjoe · codingjoe · Nov 22, 2022 · Nov 22, 2022
diff --git a/.editorconfig b/.editorconfig
@@ -10,7 +10,7 @@ insert_final_newline = true
 charset = utf-8
 end_of_line = lf
 
-[*.{json,yml,yaml,js,jsx}]
+[*.{json,yml,yaml,js,jsx,toml}]
 indent_size = 2
 
 [*.{html,htm}]

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -13,33 +13,32 @@ jobs:
       fail-fast: false
       matrix:
         lint-command:
-          - "bandit -r mailauth -x tests"
-          - "black --check --diff ."
-          - "flake8 ."
-          - "isort --check-only --diff ."
-          - "pydocstyle ."
+          - bandit -r . -x ./tests
+          - black --check --diff .
+          - flake8 .
+          - isort --check-only --diff .
+          - pydocstyle .
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
           python-version: "3.x"
-          cache: 'pip'
-          cache-dependency-path: 'requirements.txt'
-      - run: python -m pip install -r requirements.txt
+          cache: pip
+          cache-dependency-path: linter-requirements.txt
+      - run: python -m pip install -r linter-requirements.txt
       - run: ${{ matrix.lint-command }}
 
   dist:
     runs-on: ubuntu-latest
     steps:
-      - run: sudo apt install -y gettext
+      - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
           python-version: "3.x"
-      - uses: actions/checkout@v3
       - name: Install Python dependencies
-        run: python -m pip install --upgrade pip setuptools wheel twine readme-renderer
-      - run: python setup.py sdist bdist_wheel
+        run: python -m pip install --upgrade pip build wheel twine readme-renderer
+      - run: python -m build --sdist --wheel
       - run: python -m twine check dist/*
       - uses: actions/upload-artifact@v3
         with:
@@ -51,16 +50,14 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
-          python-version: "3.x"
-          cache: 'pip'
-          cache-dependency-path: 'requirements.txt'
-      - run: python -m pip install --upgrade pip setuptools wheel
-      - run: python -m pip install -r requirements.txt
-      - run: python setup.py develop
-      - run: python setup.py build_sphinx -W
+          python-version: "3.11"
+      - run: sudo apt install -y python3-enchant
+      - run: python -m pip install sphinxcontrib-spelling
+      - run: python -m pip install -e '.[docs]'
+      - run: python -m sphinx -W -b spelling docs docs/_build
 
   SQLite:
-    needs: [lint, dist, docs]
+    needs: [ lint, dist, docs ]
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -69,50 +66,48 @@ jobs:
           - "3.10"
           - "3.11"
     steps:
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-      - run: python -m pip install --upgrade pip setuptools wheel
-      - uses: actions/checkout@v3
-      - run: python setup.py test
-      - name: Codecov
-        run: |
-          python -m pip install codecov
-          codecov
+      - run: python -m pip install -e '.[test]'
+      - run: python -m pytest
+      - uses: codecov/codecov-action@v2
+        with:
+          flags: ${{ matrix.python-version }}
 
-  extras:
-    needs: [lint, dist, docs]
+  contrib:
+    needs: [ lint, dist, docs ]
     runs-on: ubuntu-latest
     strategy:
       matrix:
         extras:
           - wagtail
-        python-version: ["3.x"]
+        python-version: [ "3.x" ]
     steps:
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-      - run: python -m pip install --upgrade pip setuptools wheel
-      - uses: actions/checkout@v3
-      - run: python -m pip install -e ".[${{ matrix.extras }}]"
-      - run: python setup.py test
-      - name: Codecov
-        run: |
-          python -m pip install codecov
-          codecov
+      - run: python -m pip install -e ".[test,${{ matrix.extras }}]"
+      - run: python -m pytest
+      - uses: codecov/codecov-action@v2
+        with:
+          flags: ${{ matrix.extras }}
 
 
   PostgreSQL:
-    needs: [lint, dist, docs]
+    needs: [ lint, dist, docs ]
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10"]
+        python-version: [ "3.10" ]
         django-version:
           - "4.0"
           - "4.1"
+        extras:
+          - postgres
     services:
       postgres:
         image: postgres
@@ -127,21 +122,19 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-      - run: python -m pip install --upgrade pip setuptools wheel
       - uses: actions/checkout@v3
-      - run: python -m pip install "psycopg2-binary<2.9" Django~=${{ matrix.django-version }}.0
-      - run: python setup.py test
+      - run: python -m pip install Django~=${{ matrix.django-version }}.0 -e ".[test,${{ matrix.extras }}]"
+      - run: python -m pytest
         env:
           DB_PORT: ${{ job.services.postgres.ports[5432] }}
           DB: pg
-      - name: Codecov
-        run: |
-          python -m pip install codecov
-          codecov
+      - uses: codecov/codecov-action@v2
+        with:
+          flags: ${{ matrix.extras }}
 
   analyze:
     name: CodeQL
-    needs: [SQLite, extras, PostgreSQL]
+    needs: [ SQLite, contrib, PostgreSQL ]
     runs-on: ubuntu-latest
     permissions:
       actions: read

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -13,12 +13,9 @@ jobs:
     - uses: actions/setup-python@v4
       with:
         python-version: "3.x"
-    - name: Install Python dependencies
-      run: python -m pip install --upgrade pip setuptools wheel twine
-    - name: Build dist packages
-      run: python setup.py sdist bdist_wheel
-    - name: Upload packages
-      run: python -m twine upload dist/*
+    - run: python -m pip install --upgrade pip build wheel twine
+    - run: python -m build --sdist --wheel
+    - run: python -m twine upload dist/*
       env:
         TWINE_USERNAME: __token__
         TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -63,3 +63,4 @@ tests/local.py
 docs/_build/
 venv
 .python-version
+_version.py
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,20 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -4,29 +4,22 @@ Contributing
 
 To install the development requirements simply run::
 
-    python setup.py develop
+    python -m pip install -e '.[test]'
 
 To run test suite run::
 
-    python setup.py test
-
-... and to run the entire test suite, simply use tox::
-
-    pip install --upgrade tox
-    tox
+    python -m pytest
 
 To build the documentation run::
 
-    python setup.py build_sphinx
-    open docs/_build/html/index.html
-
+    python -m sphinx -W -b spelling docs docs/_build
 
 The sample app
 ==============
 
 To run a full example — e.g. to debug frontend code – you can run::
 
-    python setup.py develop
+    python -m pip install -e .
     python tests/testapp/manage.py migrate
     python tests/testapp/manage.py createsuperuser
     # You will be asked for the email address of your new superuser

diff --git a/README.rst b/README.rst
@@ -89,7 +89,7 @@ Next you will need to add the new authentication backend::
 Django's ``ModelBackend`` is 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::
+Last but not least, go to your URL root configuration ``urls.py`` and add the following::
 
     from django.urls import path
 

diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,7 @@
+# Security Policy
+
+## Security contact information
+
+To report a security vulnerability, please use the
+[Tidelift security contact](https://tidelift.com/security).
+Tidelift will coordinate the fix and disclosure.
diff --git a/docs/conf.py b/docs/conf.py
@@ -10,7 +10,7 @@
 django.setup()
 
 project = "Django Mail Auth"
-copyright = "2019, Johannes Hoppe"
+copyright = "2022, Johannes Maron"
 release = get_distribution("django-mail-auth").version
 version = ".".join(release.split(".")[:2])
 
@@ -31,6 +31,16 @@
     ),
 }
 
+try:
+    import sphinxcontrib.spelling  # noqa
+except ImportError:
+    pass
+else:
+    extensions.append("sphinxcontrib.spelling")
+
+    spelling_word_list_filename = "spelling_wordlist.txt"
+    spelling_show_suggestions = True
+
 
 autodoc_default_options = {
     "show-inheritance": True,

diff --git a/docs/customizing.rst b/docs/customizing.rst
@@ -15,7 +15,7 @@ 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
+The following example is for a login SMS. This will require a
 custom user model with a unique ``phone_number`` field::
 
     from django import forms
@@ -58,7 +58,7 @@ custom user model with a unique ``phone_number`` field::
             )
 
 
-To add the new login form, simply add a new login view to your URL config with
+To add the new login form, simply add a new login view to your URL configuration with
 the custom form::
 
     from django.urls import path

diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
@@ -0,0 +1,17 @@
+admin
+anonymize
+anonymized
+anonymization
+Auth
+boolean
+backend
+Django
+frontend
+mixin
+mixins
+namespace
+subclasses
+tuple
+tuples
+triple
+URL
diff --git a/requirements.txt → linter-requirements.txt b/requirements.txt → linter-requirements.txt
@@ -1,7 +1,5 @@
-Django>=2.2
-Wagtail>=2.8
 bandit==1.7.4
 black==22.10.0
 flake8==5.0.4
 isort==5.10.1
-pydocstyle==6.1.1
+pydocstyle[toml]==6.1.1
diff --git a/mailauth/__init__.py b/mailauth/__init__.py
@@ -1 +1,5 @@
-"""Django authentication via login urls, no password required."""
+"""Django authentication via login URLs, no passwords required."""
+from . import _version
+
+__version__ = _version.version
+VERSION = _version.version_tuple
diff --git a/mailauth/forms.py b/mailauth/forms.py
@@ -53,12 +53,11 @@ def get_mail_context(self, request, user):
         Returns:
             dict:
                 A context dictionary including:
-
-                - site
-                - site_name
-                - token
-                - login_url
-                - user
+                - ``site``
+                - ``site_name``
+                - ``token``
+                - ``login_url``
+                - ``user``
 
         """
         token = self.get_token(user)
@@ -79,7 +78,7 @@ def save(self):
         Called from the login view, if the form is valid.
 
         This method must be implemented by subclasses. This method
-        should trigger the login url to be sent to the user.
+        should trigger the login URL to be sent to the user.
         """
         raise NotImplementedError