Merge pull request #1202 from ddabble/update-dependencies

ddabble · web-flow · commit 4357cd5454d3 · 2023-07-05T18:02:12.000+02:00
Update Python and Django versions
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -11,17 +11,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12-dev']
-        django-version: ['3.2', '4.0', '4.1', 'main']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12-dev']
+        django-version: ['3.2', '4.1', '4.2', 'main']
 
         exclude:
-          - python-version: '3.7'
-            django-version: '4.0'
-          - python-version: '3.7'
-            django-version: '4.1'
-          - python-version: '3.7'
-            django-version: 'main'
-
           - python-version: '3.8'
             django-version: 'main'
 
@@ -30,13 +23,9 @@ jobs:
 
           - python-version: '3.11'
             django-version: '3.2'
-          - python-version: '3.11'
-            django-version: '4.0'
 
           - python-version: '3.12-dev'
             django-version: '3.2'
-          - python-version: '3.12-dev'
-            django-version: '4.0'
 
     services:
 
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -50,4 +50,4 @@ repos:
     rev: v3.8.0
     hooks:
       - id: pyupgrade
-        args: [--py37-plus]
+        args: [--py38-plus]
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,23 @@
+---
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: requirements/docs.txt
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -9,8 +9,11 @@ Unreleased
   ``SIMPLE_HISTORY_ENFORCE_HISTORY_MODEL_PERMISSIONS`` is set to ``True``
   in ``settings`` (gh-1017).
 - Fixed ``SimpleHistoryAdmin`` not properly integrating with custom user models (gh-1177)
-- Support Indonesian translation
-- Support Urdu translation
+- Support Indonesian translation (gh-1198)
+- Support Urdu translation (gh-1199)
+- Dropped support for Python 3.7, which reached end-of-life on 2023-06-27 (gh-1202)
+- Dropped support for Django 4.0, which reached end-of-life on 2023-04-01 (gh-1202)
+- Added support for Django 4.2 (gh-1202)
 
 3.3.0 (2023-03-08)
 ------------------
diff --git a/README.rst b/README.rst
@@ -18,7 +18,7 @@ django-simple-history
    :alt: PyPI Version
 
 .. image:: https://api.codeclimate.com/v1/badges/66cfd94e2db991f2d28a/maintainability
-   :target: https://codeclimate.com/github/treyhunner/django-simple-history/maintainability
+   :target: https://codeclimate.com/github/jazzband/django-simple-history/maintainability
    :alt: Maintainability
 
 .. image:: https://pepy.tech/badge/django-simple-history
@@ -41,9 +41,10 @@ This app supports the following combinations of Django and Python:
 ==========  ========================
   Django      Python
 ==========  ========================
-3.2         3.7, 3.8, 3.9, 3.10
-4.0         3.8, 3.9, 3.10
-4.1         3.8, 3.9, 3.10, 3.11
+3.2         3.8, 3.9, 3.10
+4.1         3.8, 3.9, 3.10, 3.11, 3.12-dev
+4.2         3.8, 3.9, 3.10, 3.11, 3.12-dev
+main        3.10, 3.11, 3.12-dev
 ==========  ========================
 
 Getting Help
diff --git a/docs/conf.py b/docs/conf.py
@@ -11,8 +11,7 @@
 # serve to show the default.
 import os
 import sys
-
-from pkg_resources import get_distribution
+from importlib import metadata
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -48,7 +47,7 @@
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-release = get_distribution("django-simple-history").version
+release = metadata.version("django-simple-history")
 # for example take major/minor
 version = ".".join(release.split(".")[:2])
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,8 +1,8 @@
 django-simple-history
 =====================
 
-.. image:: https://secure.travis-ci.org/jazzband/django-simple-history.svg?branch=master
-   :target: http://travis-ci.org/jazzband/django-simple-history
+.. image:: https://github.com/jazzband/django-simple-history/actions/workflows/test.yml/badge.svg
+   :target: https://github.com/jazzband/django-simple-history/actions/workflows/test.yml
    :alt: Build Status
 
 .. image:: https://readthedocs.org/projects/django-simple-history/badge/?version=latest
@@ -18,7 +18,7 @@ django-simple-history
    :alt: PyPI Version
 
 .. image:: https://api.codeclimate.com/v1/badges/66cfd94e2db991f2d28a/maintainability
-   :target: https://codeclimate.com/github/treyhunner/django-simple-history/maintainability
+   :target: https://codeclimate.com/github/jazzband/django-simple-history/maintainability
    :alt: Maintainability
 
 .. image:: https://pepy.tech/badge/django-simple-history
@@ -41,9 +41,10 @@ This app supports the following combinations of Django and Python:
 ==========  =======================
   Django      Python
 ==========  =======================
-3.2         3.7, 3.8, 3.9, 3.10
-4.0         3.8, 3.9, 3.10
-4.1         3.8, 3.9, 3.10, 3.11
+3.2         3.8, 3.9, 3.10
+4.1         3.8, 3.9, 3.10, 3.11, 3.12-dev
+4.2         3.8, 3.9, 3.10, 3.11, 3.12-dev
+main        3.10, 3.11, 3.12-dev
 ==========  =======================
 
 Contribute
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,10 +1,10 @@
 [tool.black]
 line-length = 88
-target-version = ["py37"]
+target-version = ["py38"]
 
 [tool.isort]
 profile = "black"
-py_version = "37"
+py_version = "38"
 
 [tool.coverage.run]
 parallel = true
diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -1 +1,3 @@
+# Install this project in editable mode, so that its package metadata can be queried
+-e .
 Sphinx==5.3.0
diff --git a/requirements/postgres.txt b/requirements/postgres.txt
@@ -1 +1,4 @@
+# DEV: Replace this with `psycopg[binary]` when the minimum required Django version is
+#      4.2 or higher, as this is likely to be deprecated in the future
+#      (see https://docs.djangoproject.com/en/4.2/releases/4.2/#psycopg-3-support)
 psycopg2-binary==2.9.6
diff --git a/runtests.py b/runtests.py
@@ -145,6 +145,16 @@ def __getitem__(self, item):
 
 DEFAULT_SETTINGS["MIDDLEWARE"] = MIDDLEWARE
 
+# DEV: Merge these settings into DEFAULT_SETTINGS when the minimum required
+#      Django version is 4.2 or higher
+if django.VERSION >= (4, 2):
+    DEFAULT_SETTINGS["STORAGES"] = {
+        "default": {
+            # Speeds up tests and prevents locally storing files created through them
+            "BACKEND": "django.core.files.storage.InMemoryStorage",
+        },
+    }
+
 
 def main():
     parser = ArgumentParser(description="Run package tests.")
diff --git a/setup.py b/setup.py
@@ -18,6 +18,12 @@
         author_email="corey@qr7.com",
         maintainer="Trey Hunner",
         url="https://github.com/jazzband/django-simple-history",
+        project_urls={
+            "Documentation": "https://django-simple-history.readthedocs.io/",
+            "Changelog": "https://github.com/jazzband/django-simple-history/blob/master/CHANGES.rst",  # noqa: E501
+            "Source": "https://github.com/jazzband/django-simple-history",
+            "Tracker": "https://github.com/jazzband/django-simple-history/issues",
+        },
         packages=[
             "simple_history",
             "simple_history.management",
@@ -31,17 +37,17 @@
             "Intended Audience :: Developers",
             "Framework :: Django",
             "Framework :: Django :: 3.2",
-            "Framework :: Django :: 4.0",
             "Framework :: Django :: 4.1",
+            "Framework :: Django :: 4.2",
             "Programming Language :: Python",
             "Programming Language :: Python :: 3",
-            "Programming Language :: Python :: 3.7",
             "Programming Language :: Python :: 3.8",
             "Programming Language :: Python :: 3.9",
             "Programming Language :: Python :: 3.10",
             "Programming Language :: Python :: 3.11",
+            "Programming Language :: Python :: 3.12",
             "License :: OSI Approved :: BSD License",
         ],
-        python_requires=">=3.7",
+        python_requires=">=3.8",
         include_package_data=True,
     )
diff --git a/simple_history/__init__.py b/simple_history/__init__.py
@@ -1,10 +1,6 @@
-from pkg_resources import DistributionNotFound, get_distribution
+from importlib import metadata
 
-try:
-    __version__ = get_distribution(__name__).version
-except DistributionNotFound:
-    # package is not installed
-    pass
+__version__ = metadata.version("django-simple-history")
 
 
 def register(
diff --git a/simple_history/models.py b/simple_history/models.py
@@ -625,7 +625,9 @@ def get_meta_options(self, model):
         if self.app:
             meta_fields["app_label"] = self.app
         if self._date_indexing == "composite":
-            meta_fields["index_together"] = (("history_date", model._meta.pk.attname),)
+            meta_fields["indexes"] = (
+                models.Index(fields=("history_date", model._meta.pk.attname)),
+            )
         return meta_fields
 
     def post_save(self, instance, created, using=None, **kwargs):
diff --git a/simple_history/tests/tests/test_index.py b/simple_history/tests/tests/test_index.py
@@ -14,5 +14,5 @@ class Foo(models.Model):
             history = HistoricalRecords()
 
         self.assertEqual(
-            ("history_date", "id"), Foo.history.model._meta.index_together[0]
+            ["history_date", "id"], Foo.history.model._meta.indexes[0].fields
         )
diff --git a/tox.ini b/tox.ini
@@ -1,25 +1,25 @@
 [tox]
 envlist =
-    py{37,38,39,310}-dj32-{sqlite3,postgres,mysql,mariadb},
-    py{38,39}-dj{40,41}-{sqlite3,postgres,mysql,mariadb},
-    py310-dj{40,41,main}-{sqlite3,postgres,mysql,mariadb},
-    py311-dj{41,main}-{sqlite3,postgres,mysql,mariadb},
+    py{38,39,310}-dj32-{sqlite3,postgres,mysql,mariadb},
+    py{38,39,310,311,312}-dj41-{sqlite3,postgres,mysql,mariadb},
+    py{38,39,310,311,312}-dj42-{sqlite3,postgres,mysql,mariadb},
+    py{310,311,312}-djmain-{sqlite3,postgres,mysql,mariadb},
     docs,
     lint
 
 [gh-actions]
 python =
-    3.7: py37
-    3.8: py38, docs, lint
+    3.8: py38
     3.9: py39
     3.10: py310
-    3.11: py311
+    3.11: py311, docs, lint
+    3.12: py312
 
 [gh-actions:env]
 DJANGO =
     3.2: dj32
-    4.0: dj40
     4.1: dj41
+    4.2: dj42
     main: djmain
 
 [flake8]
@@ -32,8 +32,8 @@ exclude = __init__.py,simple_history/registry_tests/migration_test_app/migration
 deps =
     -rrequirements/test.txt
     dj32: Django>=3.2,<3.3
-    dj40: Django>=4.0,<4.1
     dj41: Django>=4.1,<4.2
+    dj42: Django>=4.2,<4.3
     djmain: https://github.com/django/django/tarball/main
     postgres: -rrequirements/postgres.txt
     mysql: -rrequirements/mysql.txt

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+# Install this project in editable mode, so that its package metadata can be queried`
	`2`	`+-e .`
`1`	`3`	`Sphinx==5.3.0`