Bring up to date with upstream v4.0.0

.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: CI
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - 'v*'
+  pull_request:
+    branches:
+      - master
+jobs:
+  Lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - uses: pre-commit/[email protected]

.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Release
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - '*'
+
+jobs:
+  Build:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3"
+          cache: pip
+          cache-dependency-path: setup.cfg
+      # TODO: look into using python-babel instead of requiring gettext as system dependency
+      - run: sudo apt-get update && sudo apt-get install -y --no-install-recommends gettext
+      - run: pip install -U build
+      - run: python -m build
+      - uses: actions/upload-artifact@v3
+        with:
+          name: dist
+          path: dist/

.github/workflows/test.yml

@@ -0,0 +1,50 @@
+name: Test
+on:
+  - pull_request
+  - push
+  - workflow_dispatch
+jobs:
+  Build:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3"
+          cache: pip
+          cache-dependency-path: setup.cfg
+      # TODO: look into using python-babel instead of requiring gettext as system dependency
+      - run: sudo apt-get update && sudo apt-get install -y --no-install-recommends gettext
+      - run: pip install -U build
+      - run: python -m build
+      - uses: actions/upload-artifact@v3
+        with:
+          name: dist
+          path: dist/
+  Test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        include:
+          - python-version: "3.8"
+          - python-version: "3.9"
+          - python-version: "3.10"
+          - python-version: "3.11"
+          - python-version: "3.12"
+    steps:
+      - uses: actions/checkout@v4
+      - name: "Set up Python ${{ matrix.python-version }}"
+        uses: actions/setup-python@v5
+        with:
+          python-version: "${{ matrix.python-version }}"
+          cache: pip
+          cache-dependency-path: setup.cfg
+      # TODO: look into using python-babel instead of requiring gettext as system dependency
+      - run: sudo apt-get update && sudo apt-get install -y --no-install-recommends gettext
+      # TODO: look into using python-babel instead of requiring django to be ambiently installed
+      #       so tox can build messages
+      - run: pip install -U tox tox-gh-actions django
+      # TODO: postgres setup and proper djangomain testing
+      - run: python -m tox
+      - uses: codecov/codecov-action@v3

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.8
+    hooks:
+      - id: ruff
+        args:
+          - --fix
+      - id: ruff-format
+        exclude: '.*migrations.*'

.readthedocs.yaml

@@ -0,0 +1,16 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/_ext/djangodummy/requirements.txt

AUTHORS.rst

@@ -30,6 +30,7 @@ Contributors
 * Chris Brantley
 * Christopher Glass
 * David Sanders
+* Emad Rad
 * Éric Araujo
 * Evan Borgstrom
 * Frankie Dintino

CONTRIBUTING.rst

@@ -0,0 +1,5 @@
+.. image:: https://jazzband.co/static/img/jazzband.svg
+   :target: https://jazzband.co/
+   :alt: Jazzband
+
+This is a `Jazzband <https://jazzband.co>`_ project. By contributing you agree to abide by the `Contributor Code of Conduct <https://jazzband.co/about/conduct>`_ and follow the `guidelines <https://jazzband.co/about/guidelines>`_.

README.rst

@@ -1,11 +1,20 @@
-.. image::  https://travis-ci.org/django-polymorphic/django-polymorphic.svg?branch=master
-    :target: http://travis-ci.org/django-polymorphic/django-polymorphic
-.. image:: https://img.shields.io/pypi/v/django-polymorphic.svg
-    :target: https://pypi.python.org/pypi/django-polymorphic/
-.. image:: https://img.shields.io/codecov/c/github/django-polymorphic/django-polymorphic/master.svg
-    :target: https://codecov.io/github/django-polymorphic/django-polymorphic?branch=master
-.. image:: https://readthedocs.org/projects/django-polymorphic/badge/?version=stable
-    :target: https://django-polymorphic.readthedocs.io/en/stable/
+.. list-table::
+    :header-rows: 0
+    :widths: auto
+
+    * - .. image:: https://github.com/jazzband/django-polymorphic/actions/workflows/test.yml/badge.svg
+          :target: https://github.com/jazzband/django-polymorphic/actions/workflows/test.yml
+      - .. image:: https://img.shields.io/pypi/v/django-polymorphic.svg
+          :target: https://pypi.python.org/pypi/django-polymorphic/
+      - .. image:: https://img.shields.io/codecov/c/github/jazzband/django-polymorphic/master.svg
+          :target: https://codecov.io/github/jazzband/django-polymorphic?branch=master
+      - .. image:: https://readthedocs.org/projects/django-polymorphic/badge/?version=stable
+          :target: https://django-polymorphic.readthedocs.io/en/stable/
+      - .. image:: https://jazzband.co/static/img/badge.svg
+          :target: https://jazzband.co/
+          :alt: Jazzband
+
+
 
 Polymorphic Models for Django
 =============================
@@ -53,7 +62,7 @@ Features
   * Filtering model types: ``instance_of(...)`` and ``not_instance_of(...)``
   * Combining querysets of different models (``qs3 = qs1 | qs2``)
   * Support for custom user-defined managers.
-* Uses the minumum amount of queries needed to fetch the inherited models.
+* Uses the minimum amount of queries needed to fetch the inherited models.
 * Disabling polymorphic behavior when needed.
 
 
@@ -76,6 +85,14 @@ Install using ``pip``\ ...
 
     $ pip install django-polymorphic
 
+
+At the moment we have an unoffical version (4.0.0a). While we wait to gain access to pip. If you want to use the latest version (which works for Django >4.0.0). You can install it using
+
+.. code:: bash
+
+    pip install git+https://github.com/jazzband/[email protected]#egg=django-polymorphic
+
+
 License
 =======
 

docs/_ext/djangodummy/requirements.txt

@@ -1,5 +1,6 @@
 # for readthedocs
 # Remaining requirements are picked up from setup.py
-Django == 3.2.9
+Django == 3.2.25
 django-extra-views == 0.14.0
 sphinxcontrib-django == 0.5.1
+sphinx_rtd_theme==2.0.0

docs/admin.rst

@@ -239,7 +239,7 @@ This class implements the following features:
 * It allows to set :attr:`~polymorphic.admin.PolymorphicChildModelAdmin.base_form` so the derived class will automatically include other fields in the form.
 * It allows to set :attr:`~polymorphic.admin.PolymorphicChildModelAdmin.base_fieldsets` so the derived class will automatically display any extra fields.
 * Although it must be registered with admin site, by default it's hidden from admin site index page.
-  This can be overriden by adding :attr:`~polymorphic.admin.PolymorphicChildModelAdmin.show_in_index` = ``True`` in admin class.
+  This can be overridden by adding :attr:`~polymorphic.admin.PolymorphicChildModelAdmin.show_in_index` = ``True`` in admin class.
 
 
 .. _django-reversion: https://github.com/etianen/django-reversion

docs/advanced.rst

@@ -136,7 +136,7 @@ If you insert ``.non_polymorphic()`` anywhere into the query chain, then
 django_polymorphic will simply leave out the final step of retrieving the
 real objects, and the manager/queryset will return objects of the type of
 the base class you used for the query, like vanilla Django would
-(``ModelA`` in this example). 
+(``ModelA`` in this example).
 
 >>> qs=ModelA.objects.non_polymorphic().all()
 >>> qs
@@ -183,12 +183,12 @@ About Queryset Methods
     queryset or list  of base model objects efficiently into the real objects.
     For example, you could do ``base_objects_queryset=ModelA.extra(...).non_polymorphic()``
     and then call ``real_objects=base_objects_queryset.get_real_instances()``. Or alternatively
-    .``real_objects=ModelA.objects.get_real_instances(base_objects_queryset_or_object_list)``
+    ``real_objects=ModelA.objects.get_real_instances(base_objects_queryset_or_object_list)``
 
 *   ``values()`` & ``values_list()`` currently do not return polymorphic
     results. This may change in the future however. If you want to use these
     methods now, it's best if you use ``Model.base_objects.values...`` as
-    this is guaranteed to not change. 
+    this is guaranteed to not change.
 
 *   ``defer()`` and ``only()`` work as expected. On Django 1.5+ they support
     the ``ModelX___field`` syntax, but on Django 1.4 it is only possible to
@@ -252,7 +252,7 @@ Restrictions & Caveats
     the resulting objects are required to have a unique primary key within
     the result set.
 
-*   Diamond shaped inheritance: There seems to be a general problem 
+*   Diamond shaped inheritance: There seems to be a general problem
     with diamond shaped multiple model inheritance with Django models
     (tested with V1.1 - V1.3).
     An example is here: http://code.djangoproject.com/ticket/10808.
@@ -267,7 +267,7 @@ Restrictions & Caveats
 *   When using the ``dumpdata`` management command on polymorphic tables
     (or any table that has a reference to
     :class:`~django.contrib.contenttypes.models.ContentType`),
-    include the ``--natural`` flag in the arguments.
+    include the ``--natural-foreign`` and ``--natural-primary`` flags in the arguments.
 
 
 
@@ -288,4 +288,3 @@ Restrictions & Caveats
     - http://groups.google.com/group/django-users/browse_thread/thread/52f72cffebb705e/bc18c18b2e83881e?lnk=gst&q=model+inheritance#bc18c18b2e83881e
     - http://code.djangoproject.com/ticket/10808
     - http://code.djangoproject.com/ticket/7270
-

docs/api/polymorphic.admin.rst

@@ -90,4 +90,3 @@ These classes are useful when existing parts of the admin classes.
 
 .. autoclass:: polymorphic.admin.PolymorphicInlineAdminFormSet
     :show-inheritance:
-

docs/contributing.rst

@@ -3,7 +3,7 @@ Contributing
 
 You can contribute to *django-polymorphic* to forking the code on GitHub:
 
-  https://github.com/django-polymorphic/django-polymorphic
+  https://github.com/jazzband/django-polymorphic
 
 
 Running tests
@@ -13,7 +13,7 @@ We require features to be backed by a unit test.
 This way, we can test *django-polymorphic* against new Django versions.
 To run the included test suite, execute::
 
-    ./runtests.py
+    pytest
 
 To test support for multiple Python and Django versions, run tox from the repository root::
 
@@ -24,8 +24,6 @@ The Python versions need to be installed at your system.
 On Linux, download the versions at http://www.python.org/download/releases/.
 On MacOS X, use Homebrew_ to install other Python versions.
 
-We currently support Python 3.5, 3.6, 3.7, and 3.8.
-
 
 Example project
 ----------------

docs/index.rst

@@ -81,4 +81,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

example/example/urls.py

@@ -1,5 +1,5 @@
 from django.contrib import admin
-from django.urls import include, path, reverse_lazy
+from django.urls import path, reverse_lazy
 from django.views.generic import RedirectView
 
 admin.autodiscover()

example/example/wsgi.py

@@ -13,6 +13,7 @@
 framework.
 
 """
+
 import os
 
 # This application object is used by any WSGI server configured to use this