Update classifiers and add support for Django 5.0 (#1)

As well as adding Django 5.0 I have restored Django 3.2 to the mix - it works, without
any code changes, so may we as well retain it.

.github/workflows/tox.yml

@@ -0,0 +1,108 @@
+name: Python / Django
+
+on:
+  push:
+    branches:
+      - master
+
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  format:
+    name: Check formatting
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        toxenv: [fmt, lint, mypy]
+    env:
+      TOXENV: ${{ matrix.toxenv }}
+
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python (3.11)
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install xmlsec
+        run: sudo apt-get install -y libxml2-dev libxmlsec1-dev libxmlsec1-openssl
+
+      - name: Install and run tox
+        run: |
+          pip install tox
+          tox
+
+  checks:
+    name: Run Django checks
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        toxenv: ["django-checks"]
+    env:
+      TOXENV: ${{ matrix.toxenv }}
+
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python (3.11)
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install xmlsec
+        run: sudo apt-get install -y libxml2-dev libxmlsec1-dev libxmlsec1-openssl
+
+      - name: Install and run tox
+        run: |
+          pip install tox
+          tox
+
+  test:
+    name: Run tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        # build LTS version, next version, HEAD
+        django: ["32", "42", "50", "main"]
+        exclude:
+          - python: "3.8"
+            django: "50"
+          - python: "3.8"
+            django: "main"
+          - python: "3.9"
+            django: "50"
+          - python: "3.9"
+            django: "main"
+          - python: "3.10"
+            django: "main"
+          - python: "3.11"
+            django: "32"
+          - python: "3.12"
+            django: "32"
+          - python: "3.12"
+            django: "42"
+
+    env:
+      TOXENV: django${{ matrix.django }}-py${{ matrix.python }}
+
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install xmlsec
+        run: sudo apt-get install -y libxml2-dev libxmlsec1-dev libxmlsec1-openssl
+
+      - name: Install and run tox
+        run: |
+          pip install tox
+          tox

.gitignore

@@ -1,6 +1,7 @@
 .coverage
 .env
 .tox
+.python-version
 .venv
 *.bak
 *.crt
@@ -9,4 +10,5 @@
 *.key
 *.lock
 *.pyc
+*.whl
 staticfiles

.pre-commit-config.yaml

@@ -1,41 +1,20 @@
 repos:
-  # python import sorting - will amend files
-  - repo: https://github.com/pre-commit/mirrors-isort
-    rev: v5.10.1
-    hooks:
-      - id: isort
-
   # python code formatting - will amend files
   - repo: https://github.com/ambv/black
-    rev: 23.3.0
+    rev: 23.10.1
     hooks:
       - id: black
 
-  - repo: https://github.com/rtts/djhtml
-    rev: 3.0.6
-    hooks:
-    - id: djhtml
-
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.3.1
-    hooks:
-      - id: pyupgrade
-
-  # Flake8 includes pyflakes, pycodestyle, mccabe, pydocstyle, bandit
-  - repo: https://github.com/pycqa/flake8
-    rev: 6.0.0
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    # Ruff version.
+    rev: "v0.1.5"
     hooks:
-      - id: flake8
-        additional_dependencies:
-          - flake8-bandit
-          - flake8-blind-except
-          - flake8-docstrings
-          - flake8-logging-format
-          - flake8-print
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
 
   # python static type checking
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.1.1
+    rev: v1.7.0
     hooks:
       - id: mypy
         args:
@@ -45,4 +24,3 @@ repos:
           - --no-implicit-optional
           - --ignore-missing-imports
           - --follow-imports=silent
-        exclude: ^tests

.ruff.toml

@@ -0,0 +1,66 @@
+line-length = 88
+ignore = [
+    "D100",  # Missing docstring in public module
+    "D101",  # Missing docstring in public class
+    "D102",  # Missing docstring in public method
+    "D103",  # Missing docstring in public function
+    "D104",  # Missing docstring in public package
+    "D105",  # Missing docstring in magic method
+    "D106",  # Missing docstring in public nested class
+    "D107",  # Missing docstring in __init__
+    "D203",  # 1 blank line required before class docstring
+    "D212",  # Multi-line docstring summary should start at the first line
+    "D213",  # Multi-line docstring summary should start at the second line
+    "D404",  # First word of the docstring should not be "This"
+    "D405",  # Section name should be properly capitalized
+    "D406",  # Section name should end with a newline
+    "D407",  # Missing dashed underline after section
+    "D410",  # Missing blank line after section
+    "D411",  # Missing blank line before section
+    "D412",  # No blank lines allowed between a section header and its content
+    "D416",  # Section name should end with a colon
+    "D417",
+    "D417",  # Missing argument description in the docstring
+]
+select = [
+    "A",  # flake8 builtins
+    "C9", # mcabe
+    "D",  # pydocstyle
+    "E",  # pycodestyle (errors)
+    "F",  # Pyflakes
+    "I",  # isort
+    "S",  # flake8-bandit
+    "T2", # flake8-print
+    "W",  # pycodestype (warnings)
+]
+
+[isort]
+combine-as-imports = true
+
+[mccabe]
+max-complexity = 8
+
+[per-file-ignores]
+"*tests/*" = [
+    "D205",  # 1 blank line required between summary line and description
+    "D400",  # First line should end with a period
+    "D401",  # First line should be in imperative mood
+    "D415",  # First line should end with a period, question mark, or exclamation point
+    "E501",  # Line too long
+    "E731",  # Do not assign a lambda expression, use a def
+    "S101",  # Use of assert detected
+    "S105",  # Possible hardcoded password
+    "S106",  # Possible hardcoded password
+    "S113",  # Probable use of requests call with timeout set to {value}
+]
+"*/migrations/*" = [
+    "E501",  # Line too long
+]
+"*/settings.py" = [
+    "F403",  # from {name} import * used; unable to detect undefined names
+    "F405",  # {name} may be undefined, or defined from star imports:
+]
+"*/settings/*" = [
+    "F403",  # from {name} import * used; unable to detect undefined names
+    "F405",  # {name} may be undefined, or defined from star imports:
+]

README.md

@@ -4,7 +4,7 @@ Django app to manage SAML Identity Providers
 
 ## Version support
 
-This app support Django 4.1+ and Python 3.8+.
+This app support Django 3.2+ and Python 3.8+.
 
 ## Background
 
@@ -44,6 +44,11 @@ You must supply three SAML settings that should be available from your
 test IdP provider. If you have a Google Workspace account, that can be
 used - see https://admin.google.com/ac/security/ssocert for details.
 
+## Local install & setup
+
+If you are having problems installing `xmlsec` locally, try this:
+https://github.com/xmlsec/python-xmlsec/issues/254
+
 ## DISCLAIMER
 
 The demo app demonstrate SSO using SAML2.0, which means it's _destined_

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-simple-saml"
-version = "0.1.0"
+version = "0.2.0"
 description = "Django app for managing multiple SAML Identity Providers."
 license = "MIT"
 authors = ["YunoJuno <[email protected]>"]
@@ -10,39 +10,39 @@ homepage = "https://github.com/yunojuno/django-simple-saml"
 repository = "https://github.com/yunojuno/django-simple-saml"
 documentation = "https://github.com/yunojuno/django-simple-saml"
 classifiers = [
-    "Development Status :: 4 - Beta",
     "Environment :: Web Environment",
     "Framework :: Django",
+    "Framework :: Django :: 3.2",
+    "Framework :: Django :: 4.0",
     "Framework :: Django :: 4.1",
+    "Framework :: Django :: 4.2",
+    "Framework :: Django :: 5.0",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
 ]
 packages = [{ include = "simple_saml" }]
 
 [tool.poetry.dependencies]
 python = "^3.8"
-django = "^4.1"
+django = "^3.2 | ^4.0 | ^5.0"
 social-auth-app-django = "*"
 python3-saml = "*"
 dj_database_url = { version = "*", optional=true}
+django-sslserver = { version = "*", optional=true}
 psycopg2-binary = { version = "*", optional=true}
 gunicorn = { version = "*", optional=true}
-whitenoise = "*"
+whitenoise = { version = "*", optional=true}
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 black = "*"
 coverage = "*"
-django-sslserver = { version = "*", optional=true}
-flake8 = "*"
-flake8-bandit = "*"
-flake8-blind-except = "*"
-flake8-docstrings = "*"
-# flake8-logging-format = "*"
-flake8-print = "*"
 freezegun = "*"
-isort = "*"
 mypy = "*"
 pre-commit = "*"
 pytest = "*"
@@ -51,8 +51,8 @@ pytest-django = "*"
 tox = "*"
 
 [tool.poetry.extras]
-heroku = ["dj-database-url", "psycopg2-binary", "gunicorn"]
-localhost = ["django-sslserver"]
+heroku = ["dj-database-url", "psycopg2-binary", "gunicorn", "whitenoise"]
+localhost = ["django-sslserver", "whitenoise"]
 
 [build-system]
 requires = ["poetry>=0.12"]