Set Sphinx project settings in conf.py file

Add Django 2.2 LTS support
Drop Django 1.11 LTS support
Add request argument to `ModelSelect2Mixin.filter_queryset`

.editorconfig

@@ -0,0 +1,20 @@
+# 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
+
+[LICENSE]
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab

.fussyfox.yml

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

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: codingjoe
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Exception & Traceback**
+Should you have run into an exception, please provide us with the exception as well as with the full traceback.
+
+**Code Snippet**
+Please provide us with a code example on how to reproduce the error.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/problem-with-django-admin.md

@@ -0,0 +1,13 @@
+---
+name: Problem with Django admin
+about: You are facing a problem integrating django-select2 into Django's admin interface
+title: ''
+labels: wontfix
+assignees: ''
+
+---
+
+Django-Select2 does NOT support Django admin, since Django admin has a built-in feature called `autocomplete_fields`. Autocomplete fields are superior and we recommend using them, instead of this package for the admin.
+
+You can find more information here:
+https://docs.djangoproject.com/en/stable/ref/contrib/admin/#django.contrib.admin.ModelAdmin.autocomplete_fields

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,17 @@
+---
+name: Question
+about: You have a question about Django-Select2
+title: ''
+labels: question
+assignees: ''
+
+---
+
+**Goal**
+Please describe your goal in all detail. What are you trying to do
+
+**Problem**
+Please describe your problem in all detail. Where are you struggling?
+
+**Code Snippet**
+Please provide a code snippet of your problem.

.gitignore

@@ -20,3 +20,6 @@ venv/
 geckodriver.log
 ghostdriver.log
 .coverage
+
+coverage.xml
+.eggs/

.travis.yml

@@ -1,74 +1,87 @@
 language: python
-sudo: true
 dist: xenial
-cache:
-- apt
-- pip
-services:
-- redis
-addons:
-  apt:
-    packages:
-    - chromium-chromedriver
-    - python3-enchant
-    - python-enchant
-    - graphviz
+
 python:
   - "3.6"
   - "3.7"
 env:
-  matrix:
-  - DJANGO=111
   - DJANGO=20
   - DJANGO=21
+  - DJANGO=22
   - DJANGO=master
-  - TOXENV=qa
-  - TOXENV=docs
+
 matrix:
   fast_finish: true
   allow_failures:
-  - env: DJANGO=master
-  exclude:
-    - python: "3.7"
-      env: TOXENV=docs
-    - python: "3.7"
-      env: DJANGO=111
-    - python: "3.6"
-      env: TOXENV=qa
-install:
-- pip install --upgrade pip tox
-- pip install -U codecov
+    - env: DJANGO=master
+
+addons:
+  apt:
+    packages:
+      - chromium-chromedriver
+
+install: pip install tox-travis codecov
+
 before_script:
-- ln -s /usr/lib/chromium-browser/chromedriver ~/bin/chromedriver
-- nvm install --lts
-- npm install -g standard
-- |
-  if [[ -z $TOXENV ]]; then
-    export TOXENV=py$(echo $TRAVIS_PYTHON_VERSION | sed -e 's/\.//g')-dj$DJANGO
-  fi
-- echo $TOXENV
-script:
-- standard
-- tox -e $TOXENV
-after_success:
-- codecov
-before_deploy:
-  - git stash --all
-  - ./set_version.py
-_deploy_provider: &_deploy_provider
-  skip_cleanup: true
-  on:
-    tags: true
-    repo: applegrew/django-select2
-deploy:
-  - <<: *_deploy_provider
-    provider: pypi
-    distributions: sdist bdist_wheel
-    user: codingjoe
-    password:
-      secure: fEP9K7y0ZF9fRvQEUN4kgPXQEZvi3Cx3ikUebG2UM/2uhcaUQm0+KpgZ2S+lvOTYcBnNgzPzFsVIZMcVcTxwIKuQDEMq9y2eop2hnisb9KXsIm9qPYSzOnRm74VuiOt4hNOZMe0qVBK2cO3vC9NDXuzdI8A0JynJhthfl4t+kFM=
-  - <<: *_deploy_provider
-    provider: npm
-    email: info@johanneshoppe.com
-    api_key:
-      secure: PV38cQx9qhEFkpSdytbM72UzIMCfhpjmRJ8dzT+bCAaOIs5rEcyKN+h1r5ranunCxWyuFsMW4A2iW/SCxnKCR/oPAguuwUbT5ogBXlsskqPFWUxuoTHYMrd+zB+SC6+bMgq+o5ul+kJCYtEkWP6cMlIEzKyTLab7m5PsnDXNVnI=
+  - ln -s /usr/lib/chromium-browser/chromedriver ~/bin/chromedriver
+  - |
+    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
+
+stages:
+  - test
+  - name: deploy
+    if: tag is present
+
+jobs:
+  include:
+    - python: "3.5"
+      env: TOXENV=docs
+      addons:
+        apt:
+          packages:
+            - python3-enchant
+            - python-enchant
+            - graphviz
+    - language: node_js
+      addons: {}
+      install: npm install
+      script: npm test
+      node_js: lts/*
+      cache: npm
+    - stage: deploy
+      python: "3.7"
+      install: skip
+      script: skip
+      after_success: true
+      deploy:
+          provider: pypi
+          distributions: sdist bdist_wheel
+          on:
+            tags: true
+          user: codingjoe
+          password:
+            secure: fEP9K7y0ZF9fRvQEUN4kgPXQEZvi3Cx3ikUebG2UM/2uhcaUQm0+KpgZ2S+lvOTYcBnNgzPzFsVIZMcVcTxwIKuQDEMq9y2eop2hnisb9KXsIm9qPYSzOnRm74VuiOt4hNOZMe0qVBK2cO3vC9NDXuzdI8A0JynJhthfl4t+kFM=
+    - stage: deploy
+      language: node_js
+      node_js: lts/*
+      python: "3.7"
+      install: skip
+      script: skip
+      after_success: true
+      skip_cleanup: true
+      before_deploy:
+        - ./set_version.py
+      deploy:
+        provider: npm
+        on:
+          tags: true
+        email: info@johanneshoppe.com
+        api_key:
+          secure: PV38cQx9qhEFkpSdytbM72UzIMCfhpjmRJ8dzT+bCAaOIs5rEcyKN+h1r5ranunCxWyuFsMW4A2iW/SCxnKCR/oPAguuwUbT5ogBXlsskqPFWUxuoTHYMrd+zB+SC6+bMgq+o5ul+kJCYtEkWP6cMlIEzKyTLab7m5PsnDXNVnI=

CHANGELOG.md

@@ -1,218 +0,0 @@
-Changelog Summary
-=================
-
-Changes for django-select2 v6.0.1 and later are logged on the [github releases page](https://github.com/applegrew/django-select2/releases).
-
-### v6.0.0
-
-* Add Support for Django 2.0
-* Drop Python 2 support
-* Drop Python 3.5 support
-* Drop Django 1.8 support
-* Drop Django 1.10 support
-
-### v5.10.0
-* Add support for dependent select fields [321](github.com/applegrew/django-select2/pull/321/).
-
-### v5.9.0
-* Add support for Django 1.11 LTS
-* Drop support for Django 1.9
-
-### v5.8.10
-* Fixes tests for Django 1.10+
-* retain order of choices [299](https://github.com/applegrew/django-select2/pull/299)
-
-### v5.8.9
-* Fixes tests.  No functional change from 5.8.8.
-
-### v5.8.8
-* Upgrade Select2 to version 4.0.3
-
-### v5.8.7
-* Fix #285 -- Do not evaluate queryset in `render_options`.
-
-### v5.8.3
-* Remove six dependency -- User django.utils.six instead.
-
-### v5.8.2
-* Fixes #260 -- Fixes bug in render choices
-
-### v5.8.0
-* Changed signature of `render` and `render_choices` to satisfy Django 1.10 changes.
-* Changed widgets' inheritance tree to be more consistent.
-
-### v5.7.1
-* Fixes pickle bug of lazy object
-
-### v5.7.0
-* Security fix that allows a `field_id` to only be used for the intended JSON endpoint.
-  
-      Prior to that change you could use any `field_id` on any select2 JSON endpoint.
-      Even if the id was intended to be used on a private endpoint if could be used on
-      the default one and therefore leak sensitive data.
-      
-* Breaking change on how `Heavy` widgets are being cached.
-      
-      Heavy widgets used to add themselves to the cache. Now they add a dictionary to
-      the cache containing themselves and the target url.
-      
-      ```python
-      {
-          'widget': self,
-          'url': self.get_url(),
-      }
-      ```
-
-### v5.6.0
-* Added `label_from_instance` method for model widgets to define custom option labels.
-
-### v5.5.0
-* Added settings to delivery static assets from different source.
-
-### v5.4.2
-* Fixed initial data not being shown for heavy widgets.
-
-### v5.4.1
-* Fixed memory leak in `ModelSelect2Mixin` and subclasses
-
-### v5.4.0
-* Added `Select2TagWidget` a light widget with tagging support
-
-### v5.3.0
-* Added djangoSelect2 jQuery plugin to support
-  dynamic field initialisation
-
-### v5.2.0
-* Added pagination
-
-### v5.1.0
-* Added search term splitting
-* Model widgets get smarter pickling to reduce size and avoid pickling issues
-
-### v5.0.0
-Version 5 is a complete rewrite of the package to drastically reduce
-the code base and to ensure a future maintainability.
-
-While we feature set remained unchanged, the API changed completely.
-Major changes:
-* Fields have been removed in favor of widgets.
-* All version 4 settings have been removed.
-* Template tags have been removed.
-* 3rd party javascript is served by a CDN.
-* No more inline javascript code.
-
-### v4.3.2
-
-* Use `django.contrib.staticfiles.templatetags.staticfiles.static` over `django.templatetags.static.static` to allow hashing.
-* Py23 unicode fixes
-
-
-### v4.3.1
-
-* Build failure fix.
-
-### v4.3.0
-
-* Now the package supports both Python2 and Python3.
-* Django 1.8 support added.
-* Many bug fixes.
-
-### v4.2.2
-
-* Misc fixes and enhancements - [61](https://github.com/applegrew/django-select2/pull/61), [64](https://github.com/applegrew/django-select2/issues/64).
-
-### v4.2.1
-
-* Finally fixed performance issue[#54](https://github.com/applegrew/django-select2/issues/54) (and issue[#41](https://github.com/applegrew/django-select2/issues/41)) in widgets when backing field is based on models and the field has an initial value.
-
-### v4.2.0
-
-* Updated Select2 to version 3.4.2. **Please note**, that if you need any of the Select2 locale files, then you need to download them yourself from http://ivaynberg.github.com/select2/ and add to your project.
-* Tagging support added. See [Field API reference](http://django-select2.readthedocs.org/en/latest/ref_fields.html) in documentation.
-
-### v4.1.0
-
-* Updated Select2 to version 3.4.1. **Please note**, that if you need any of the Select2 locale files, then you need to download them yourself from http://ivaynberg.github.com/select2/ and add to your project.
-* Address isssue[#36](https://github.com/applegrew/django-select2/issues/36) - Fix importerror under django1.6.
-* Fixed the way `setup.py` handles Unicode files while minifying them during package build.
-* Address isssue[#39](https://github.com/applegrew/django-select2/issues/39) - MultipleSelect2HiddenInput.render() should use mark_safe().
-* Address isssue[#45](https://github.com/applegrew/django-select2/issues/45) - MultipleSelect2HiddenInput returns bad has_changed value.
-
-### v4.0.0
-
-* Main version number bumped to bring your attention to the fact that the default Id generation scheme has now changed. Now Django Select2 will use hashed paths of fields to generate their Ids. The old scheme of generating random Ids are still there. You can enable that by setting `GENERATE_RANDOM_SELECT2_ID` to `True`.
-
-### v3.3.1
-
-* Addressed issue[#30](https://github.com/applegrew/django-select2/issues/30).
-* Merged pull request[#31](https://github.com/applegrew/django-select2/issues/31).
-* Added `light` parameter to `import_django_select2_js`, `import_django_select2_css` and `import_django_select2_js_css` template tags. Please see doc's "Getting Started", for more details.
-
-### v3.3.0
-
-* Updated Select2 to version 3.3.1.
-* Added multi-process support. ([Issue#28](https://github.com/applegrew/django-select2/issues/28)).
-* Addressed issue[#26](https://github.com/applegrew/django-select2/issues/26).
-* Addressed issue[#24](https://github.com/applegrew/django-select2/issues/24).
-* Addressed issue[#23](https://github.com/applegrew/django-select2/issues/23).
-* Addressed some typos.
-
-### v3.2.0
-
-* Fixed issue[#20](https://github.com/applegrew/django-select2/issues/20). Infact while fixing that I realised that heavy components do not need the help of cookies, infact due to a logic error in previous code the cookies were not being used anyway. Now Django Select2 does not use cookies etc.
-* Few more bugs fixed in `heav_data.js`.
-* Now production code will use minimized versions of js and css files.
-* Codes added in `setup.py` to automate the task of minimizing js and css files, using a web service.
-
-### v3.1.5
-
-* Merged pull request (issue[#17](https://github.com/applegrew/django-select2/issues/17)). Which allows the user to pass some extra data to Select2 clients-side component.
-* Updated License. The previous one was inadequently worded. Now this project use Apache 2.0 license.
-
-### v3.1.4
-
-* Manually merged changes from pull request (issue[#16](https://github.com/applegrew/django-select2/issues/16)).
-* Django Select2 widgets now allow passing of any Select2 Js options. Previously it used to allow only white-listed options. Now it will block only black-listed options. For example, Light Select2 widgets won't allow you to set `multiple` option, since it is an error to set them when Select2 Js is bound to `<select>` fields.
-
-### v3.1.3
-
-* Addressed enhancement issue[#12](https://github.com/applegrew/django-select2/issues/12).
-* Addressed enhancement issue[#11](https://github.com/applegrew/django-select2/issues/11).
-* Addressed performance issue[#8](https://github.com/applegrew/django-select2/issues/8).
-
-### v3.1.2
-
-* Fixed issue[#7](https://github.com/applegrew/django-select2/issues/7).
-
-### v3.1.1
-
-* Bumping up minor version since Select2 JS has been updated to version 3.2. It seems Select2 JS now includes new higher resolution icons for [Retina displays](http://en.wikipedia.org/wiki/Retina_Display).
-* Fixed an issue in `setup.py` because of which `templatetags` directory was not included in last PIP releases' tar file.
-
-### v3.0.2
-
-* Added `AUTO_RENDER_SELECT2_STATICS` settings. This, when specified and set to `False` in `settings.py` then Django_Select2 widgets won't automatically include the required scripts and stylesheets. When this setting is `True` (default) then every Select2 field on the page will output `<script>` and `<link>` tags to include the required JS and CSS files. This is convinient but will output the same JS and CSS files multiple times if there are more than one Select2 fields on the page.
-* Added `django_select2_tags` template tags to manually include the required JS and CSS files, when `AUTO_RENDER_SELECT2_STATICS` is turned off.
-
-### v3.0.1
-
-* Revised the design of heavy fields. The previous design didn't quite make it easy to back heavy fields by big data sources. See `fields.HeavyChoiceField` class and its methods' docs for more info.
-* Updated docs.
-* Some more fixes for issue[#4](https://github.com/applegrew/django-select2/issues/4).
-* Updated Select2 JS to version 3.1.
-
-### v3.0
-
-* Added docs.
-* Some bug fixes. See issue[#4](https://github.com/applegrew/django-select2/issues/4).
-* `widgets.Select2Mixin.__init__` now accepts `select2_options` kwarg to override its `options` settings. Previously `attrs` were being used for this too. This means backward compatibility has been broken here. `attrs` will no longer override `options` values. **The major release version has been changed to 3, because of this backward incompatible change.**
-
-### v2.0.1
-
-* Auto id registration fixes.
-
-### v2.0
-
-* Mostly major bug fixes in code and design. The changes were many, raising the possibility of backward incompatibility. However, the backward incompatibility would be subtle.
-
-* Auto fields (sub-classes of AutoViewFieldMixin) now accepts `auto_id` parameter. This can be used to provide custom id for the field. The default is 'module.field_class_name'. Ideally only the first instance of an auto field is registered. This parameter can be used to force registration of additional instances by passing a unique value.

LICENSE

@@ -1,13 +1,21 @@
-Copyright 2017 Johannes Hoppe
+MIT License
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+Copyright (c) 2017 Johannes Hoppe
 
-    http://www.apache.org/licenses/LICENSE-2.0
+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:
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+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,2 @@
+include django_select2/static/django_select2/django_select2.js
+prune tests

django_select2/forms.py

@@ -50,6 +50,7 @@ from itertools import chain
 from pickle import PicklingError  # nosec
 
 from django import forms
+from django.contrib.admin.widgets import SELECT2_TRANSLATIONS
 from django.core import signing
 from django.db.models import Q
 from django.forms.models import ModelChoiceIterator
@@ -60,7 +61,7 @@ from .cache import cache
 from .conf import settings
 
 
-class Select2Mixin(object):
+class Select2Mixin:
     """
     The base mixin of all Select2 widgets.
 
@@ -99,22 +100,12 @@ class Select2Mixin(object):
             https://docs.djangoproject.com/en/stable/topics/forms/media/#media-as-a-dynamic-property
         """
         lang = get_language()
-        i18n_name = None
         select2_js = (settings.SELECT2_JS,) if settings.SELECT2_JS else ()
         select2_css = (settings.SELECT2_CSS,) if settings.SELECT2_CSS else ()
 
-        try:
-            from django.contrib.admin.widgets import SELECT2_TRANSLATIONS
-            i18n_name = SELECT2_TRANSLATIONS.get(lang)
-            if i18n_name not in settings.SELECT2_I18N_AVAILABLE_LANGUAGES:
-                i18n_name = None
-        except ImportError:
-            # TODO: select2 widget feature needs to be backported into Django 1.11
-            try:
-                i = [x.lower() for x in settings.SELECT2_I18N_AVAILABLE_LANGUAGES].index(lang)
-                i18n_name = settings.SELECT2_I18N_AVAILABLE_LANGUAGES[i]
-            except ValueError:
-                pass
+        i18n_name = SELECT2_TRANSLATIONS.get(lang)
+        if i18n_name not in settings.SELECT2_I18N_AVAILABLE_LANGUAGES:
+            i18n_name = None
 
         i18n_file = ('%s/%s.js' % (settings.SELECT2_I18N_PATH, i18n_name),) if i18n_name else ()
 
@@ -126,7 +117,7 @@ class Select2Mixin(object):
     media = property(_get_media)
 
 
-class Select2TagMixin(object):
+class Select2TagMixin:
     """Mixin to add select2 tag functionality."""
 
     def build_attrs(self, *args, **kwargs):
@@ -194,7 +185,7 @@ class Select2TagWidget(Select2TagMixin, Select2Mixin, forms.SelectMultiple):
     pass
 
 
-class HeavySelect2Mixin(object):
+class HeavySelect2Mixin:
     """Mixin that adds select2's AJAX options and registers itself on Django's cache."""
 
     dependent_fields = {}
@@ -317,7 +308,7 @@ class HeavySelect2TagWidget(HeavySelect2Mixin, Select2TagWidget):
 # Auto Heavy widgets
 
 
-class ModelSelect2Mixin(object):
+class ModelSelect2Mixin:
     """Widget mixin that provides attributes and methods for :class:`.AutoResponseView`."""
 
     model = None
@@ -352,7 +343,7 @@ class ModelSelect2Mixin(object):
         self.queryset = kwargs.pop('queryset', self.queryset)
         self.search_fields = kwargs.pop('search_fields', self.search_fields)
         self.max_results = kwargs.pop('max_results', self.max_results)
-        defaults = {'data_view': 'django_select2-json'}
+        defaults = {'data_view': 'django_select2:auto-json'}
         defaults.update(kwargs)
         super(ModelSelect2Mixin, self).__init__(*args, **defaults)
 
@@ -370,17 +361,19 @@ class ModelSelect2Mixin(object):
                     queryset.query,
                 ],
             'cls': self.__class__,
-            'search_fields': self.search_fields,
-            'max_results': self.max_results,
-            'url': self.get_url(),
-            'dependent_fields': self.dependent_fields,
+            'search_fields': tuple(self.search_fields),
+            'max_results': int(self.max_results),
+            'url': str(self.get_url()),
+            'dependent_fields': dict(self.dependent_fields),
         })
 
-    def filter_queryset(self, term, queryset=None, **dependent_fields):
+    def filter_queryset(self, request, term, queryset=None, **dependent_fields):
         """
         Return QuerySet filtered by search_fields matching the passed term.
 
         Args:
+            request (django.http.request.HttpRequest): The request is being passed from
+                the JSON view and can be used to dynamically alter the response queryset.
             term (str): Search term
             queryset (django.db.models.query.QuerySet): QuerySet to select choices from.
             **dependent_fields: Dependent fields and their values. If you want to inherit

django_select2/urls.py

@@ -3,14 +3,18 @@ Django-Select2 URL configuration.
 
 Add `django_select` to your ``urlconf`` **if** you use any 'Model' fields::
 
-    url(r'^select2/', include('django_select2.urls')),
+    from django.urls import path
+
+
+    path('select2/', include('django_select2.urls')),
 
 """
-from django.conf.urls import url
+from django.urls import path
 
 from .views import AutoResponseView
 
+app_name = 'django_select2'
+
 urlpatterns = [
-    url(r"^fields/auto.json$",
-        AutoResponseView.as_view(), name="django_select2-json"),
+    path("fields/auto.json", AutoResponseView.as_view(), name="auto-json"),
 ]

django_select2/views.py

@@ -54,7 +54,7 @@ class AutoResponseView(BaseListView):
             for form_field_name, model_field_name in self.widget.dependent_fields.items()
             if form_field_name in self.request.GET and self.request.GET.get(form_field_name, '') != ''
         }
-        return self.widget.filter_queryset(self.term, self.queryset, **kwargs)
+        return self.widget.filter_queryset(self.request, self.term, self.queryset, **kwargs)
 
     def get_paginate_by(self, queryset):
         """Paginate response by size of widget's `max_results` parameter."""

docs/conf.py

@@ -1,53 +1,52 @@
-import datetime
-import os
-import sys
-
-# This is needed since django_select2 requires django model modules
-# and those modules assume that django settings is configured and
-# have proper DB settings.
-# Using this we give a proper environment with working django settings.
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.testapp.settings")
-
-# 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
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('../tests.testapp'))
-sys.path.insert(0, os.path.abspath('..'))
-
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.inheritance_diagram',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.viewcode',
-    'sphinxcontrib.spelling',
-]
-
-intersphinx_mapping = {
-    'python': ('http://docs.python.org/3', None),
-    'django': ('https://docs.djangoproject.com/en/stable/',
-               'https://docs.djangoproject.com/en/stable/_objects/'),
-}
-
-# spell check
-spelling_word_list_filename = 'spelling_wordlist.txt'
-spelling_show_suggestions = True
-
-master_doc = 'index'
-
-# General information about the project.
-project = 'django-select2'
-year = datetime.datetime.now().strftime("%Y")
-copyright = '%s, Johannes Hoppe' % year
-
-autodoc_default_flags = ['members', 'show-inheritance']
-autodoc_member_order = 'bysource'
-
-inheritance_graph_attrs = dict(rankdir='TB')
-
-inheritance_node_attrs = dict(shape='rect', fontsize=14, fillcolor='gray90',
-                              color='gray30', style='filled')
-
-inheritance_edge_attrs = dict(penwidth=0.75)
-
-html_theme = 'sphinx_rtd_theme'
+import os
+import sys
+
+from pkg_resources import get_distribution
+
+# This is needed since django_select2 requires django model modules
+# and those modules assume that django settings is configured and
+# have proper DB settings.
+# Using this we give a proper environment with working django settings.
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.testapp.settings")
+
+# 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
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('../tests.testapp'))
+sys.path.insert(0, os.path.abspath('..'))
+
+
+project = "Django-Select2"
+author = "Johannes Hoppe"
+copyright = "2017, Johannes Hoppe"
+release = get_distribution('django_select2').version
+version = '.'.join(release.split('.')[:2])
+
+
+master_doc = 'index'  # default in Sphinx v2
+
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.inheritance_diagram',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.doctest',
+]
+
+intersphinx_mapping = {
+    'python': ('http://docs.python.org/3', None),
+    'django': ('https://docs.djangoproject.com/en/stable/',
+               'https://docs.djangoproject.com/en/stable/_objects/'),
+}
+
+autodoc_default_flags = ['members', 'show-inheritance']
+autodoc_member_order = 'bysource'
+
+inheritance_graph_attrs = dict(rankdir='TB')
+
+inheritance_node_attrs = dict(shape='rect', fontsize=14, fillcolor='gray90',
+                              color='gray30', style='filled')
+
+inheritance_edge_attrs = dict(penwidth=0.75)

docs/get_started.rst

@@ -39,6 +39,8 @@ Replacing::
 
 with::
 
+        from django_select2.forms import Select2MultipleWidget
+        
         class MyForm(forms.Form):
             things = ModelMultipleChoiceField(queryset=Thing.objects.all(), widget=Select2MultipleWidget)
 

package.json

@@ -11,7 +11,7 @@
     "test": "tests"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "standard"
   },
   "repository": {
     "type": "git",
@@ -30,5 +30,8 @@
   "peerDependencies": {
     "select2": "*",
     "jquery": ">= 1.2"
+  },
+  "devDependencies": {
+    "standard": "*"
   }
 }

requirements-dev.txt

@@ -1,15 +0,0 @@
-coverage
-django-appconf
-flake8
-pep8-naming
-mccabe
-isort
-pydocstyle
-pytest
-pytest-django
-selenium
-sphinx
-sphinx_rtd_theme
-sphinxcontrib-spelling
-pyenchant
-django-redis

requirements.txt

@@ -1 +0,0 @@
-django-appconf>=0.6.0

setup.cfg

@@ -1,11 +1,12 @@
 [metadata]
 name = django-select2
 author = Johannes Hoppe
-author-email = info@johanneshoppe.com
-summary = Select2 option fields for Django.
-description-file = README.rst
-home-page = https://github.com/applegrew/django-select2
-license = Apache-2
+author_email = info@johanneshoppe.com
+description = Select2 option fields for Django
+long_description = file: README.rst
+url = https://github.com/applegrew/django-select2
+license = MIT
+license_file = LICENSE
 classifier =
     Development Status :: 5 - Production/Stable
     Environment :: Web Environment
@@ -16,44 +17,68 @@ classifier =
     Programming Language :: Python :: 3
     Framework :: Django
 
-[files]
-packages =
-    django_select2
+[options]
+include_package_data = True
+packages = find:
+install_requires =
+    django>=2.0
+    django-appconf>=0.6.0
+setup_requires =
+    setuptools_scm
+    sphinx
+    pytest-runner
+tests_require =
+    pytest
+    pytest-cov
+    pytest-django
+    selenium
 
-[pbr]
-skip_authors = true
-skip_changelog = true
+[bdist_wheel]
+universal = 1
+
+[bdist_rpm]
+requires =
+    python-django-appconf >= 2.0
+    python-django-appconf >= 0.6
+
+[aliases]
+test = pytest
 
 [build_sphinx]
-builders = spelling,html
 source-dir = docs
 build-dir = docs/_build
-warning-is-error = 1
 
 [tool:pytest]
-norecursedirs = env docs
-addopts = --tb=short -rxs
+addopts = --cov=django_select2 --cov-report xml
 DJANGO_SETTINGS_MODULE=tests.testapp.settings
 
+[tox:tox]
+envlist = py{35,36,37}-dj{22,21,20,master},docs
+
+[testenv]
+passenv=CI
+deps =
+    dj20: https://github.com/django/django/archive/stable/2.0.x.tar.gz#egg=django
+    dj21: https://github.com/django/django/archive/stable/2.1.x.tar.gz#egg=django
+    dj22: https://github.com/django/django/archive/stable/2.2.x.tar.gz#egg=django
+    djmaster: https://github.com/django/django/archive/master.tar.gz#egg=django
+commands = python setup.py test
+
+[testenv:docs]
+commands = python setup.py build_sphinx -W -b doctest -b html
+
 [flake8]
 max-line-length = 120
-max-complexity = 10
 statistics = true
 show-source = true
-exclude = docs,runtests.py,setup.py,.tox,env
 
-[pep257]
-match = (?!setup).*.py
-match-dir = (?!tests|env|docs|\.).*
+[pydocstyle]
+add_ignore = D1
 
 [isort]
 atomic = true
 multi_line_output = 5
 line_length = 79
-skip = manage.py,docs,.tox,env
 known_first_party = django_select2, tests
-known_third_party = django
+default_section=THIRDPARTY
 combine_as_imports = true
-
-[bdist_rpm]
-requires = python-django-appconf >= 0.6

setup.py

@@ -2,7 +2,4 @@
 
 from setuptools import setup
 
-setup(
-    setup_requires=['pbr'],
-    pbr=True,
-)
+setup(use_scm_version=True)

tests/conftest.py

@@ -22,10 +22,9 @@ def random_name(n):
 @pytest.yield_fixture(scope='session')
 def driver():
     chrome_options = webdriver.ChromeOptions()
-    chrome_options.add_argument('headless')
-    chrome_options.add_argument('window-size=1200x800')
+    chrome_options.headless = True
     try:
-        b = webdriver.Chrome(chrome_options=chrome_options)
+        b = webdriver.Chrome(options=chrome_options)
     except WebDriverException as e:
         pytest.skip(force_text(e))
     else:

tests/test_forms.py

@@ -1,13 +1,13 @@
-import collections
 import json
 import os
+from collections.abc import Iterable
 
 import pytest
 from django.core import signing
 from django.db.models import QuerySet
+from django.urls import reverse
 from django.utils import translation
 from django.utils.encoding import force_text
-from django.utils.six import text_type
 from selenium.common.exceptions import NoSuchElementException
 from selenium.webdriver.common.by import By
 from selenium.webdriver.support import expected_conditions
@@ -25,13 +25,8 @@ from tests.testapp.forms import (
 )
 from tests.testapp.models import Artist, City, Country, Genre, Groupie
 
-try:
-    from django.urls import reverse
-except ImportError:
-    from django.core.urlresolvers import reverse
 
-
-class TestSelect2Mixin(object):
+class TestSelect2Mixin:
     url = reverse('select2_widget')
     form = forms.AlbumSelect2WidgetForm()
     multiple_form = forms.AlbumSelect2MultipleWidgetForm()
@@ -40,7 +35,7 @@ class TestSelect2Mixin(object):
     def test_initial_data(self, genres):
         genre = genres[0]
         form = self.form.__class__(initial={'primary_genre': genre.pk})
-        assert text_type(genre) in form.as_p()
+        assert str(genre) in form.as_p()
 
     def test_initial_form_class(self):
         widget = self.widget_cls(attrs={'class': 'my-class'})
@@ -147,7 +142,7 @@ class TestSelect2Mixin(object):
         )
 
 
-class TestSelect2MixinSettings(object):
+class TestSelect2MixinSettings:
     def test_default_media(self):
         sut = Select2Widget()
         result = sut.media.render()
@@ -240,12 +235,12 @@ class TestHeavySelect2Mixin(TestSelect2Mixin):
 
     def test_get_url(self):
         widget = self.widget_cls(data_view='heavy_data_1', attrs={'class': 'my-class'})
-        assert isinstance(widget.get_url(), text_type)
+        assert isinstance(widget.get_url(), str)
 
     def test_can_not_pickle(self):
         widget = self.widget_cls(data_view='heavy_data_1', attrs={'class': 'my-class'})
 
-        class NoPickle(object):
+        class NoPickle:
             pass
 
         widget.no_pickle = NoPickle()
@@ -260,7 +255,7 @@ class TestModelSelect2Mixin(TestHeavySelect2Mixin):
     def test_initial_data(self, genres):
         genre = genres[0]
         form = self.form.__class__(initial={'primary_genre': genre.pk})
-        assert text_type(genre) in form.as_p()
+        assert str(genre) in form.as_p()
 
     def test_label_from_instance_initial(self, genres):
         genre = genres[0]
@@ -326,34 +321,34 @@ class TestModelSelect2Mixin(TestHeavySelect2Mixin):
             widget.get_search_fields()
 
         widget.search_fields = ['title__icontains']
-        assert isinstance(widget.get_search_fields(), collections.Iterable)
-        assert all(isinstance(x, text_type) for x in widget.get_search_fields())
+        assert isinstance(widget.get_search_fields(), Iterable)
+        assert all(isinstance(x, str) for x in widget.get_search_fields())
 
     def test_filter_queryset(self, genres):
         widget = TitleModelSelect2Widget(queryset=Genre.objects.all())
-        assert widget.filter_queryset(genres[0].title[:3]).exists()
+        assert widget.filter_queryset(None, genres[0].title[:3]).exists()
 
         widget = TitleModelSelect2Widget(search_fields=['title__icontains'],
                                          queryset=Genre.objects.all())
-        qs = widget.filter_queryset(" ".join([genres[0].title[:3], genres[0].title[3:]]))
+        qs = widget.filter_queryset(None, " ".join([genres[0].title[:3], genres[0].title[3:]]))
         assert qs.exists()
 
     def test_model_kwarg(self):
         widget = ModelSelect2Widget(model=Genre, search_fields=['title__icontains'])
         genre = Genre.objects.last()
-        result = widget.filter_queryset(genre.title)
+        result = widget.filter_queryset(None, genre.title)
         assert result.exists()
 
     def test_queryset_kwarg(self):
         widget = ModelSelect2Widget(queryset=Genre.objects.all(), search_fields=['title__icontains'])
         genre = Genre.objects.last()
-        result = widget.filter_queryset(genre.title)
+        result = widget.filter_queryset(None, genre.title)
         assert result.exists()
 
     def test_ajax_view_registration(self, client):
         widget = ModelSelect2Widget(queryset=Genre.objects.all(), search_fields=['title__icontains'])
         widget.render('name', 'value')
-        url = reverse('django_select2-json')
+        url = reverse('django_select2:auto-json')
         genre = Genre.objects.last()
         response = client.get(url, data=dict(field_id=signing.dumps(id(widget)), term=genre.title))
         assert response.status_code == 200, response.content
@@ -366,14 +361,14 @@ class TestModelSelect2Mixin(TestHeavySelect2Mixin):
         widget.render('name', 'value')
         cached_widget = cache.get(widget._get_cache_key())
         assert cached_widget['max_results'] == widget.max_results
-        assert cached_widget['search_fields'] == widget.search_fields
+        assert cached_widget['search_fields'] == tuple(widget.search_fields)
         qs = widget.get_queryset()
         assert isinstance(cached_widget['queryset'][0], qs.__class__)
-        assert text_type(cached_widget['queryset'][1]) == text_type(qs.query)
+        assert str(cached_widget['queryset'][1]) == str(qs.query)
 
     def test_get_url(self):
         widget = ModelSelect2Widget(queryset=Genre.objects.all(), search_fields=['title__icontains'])
-        assert isinstance(widget.get_url(), text_type)
+        assert isinstance(widget.get_url(), str)
 
     def test_custom_to_field_name(self):
         the_best_band_in_the_world = Artist.objects.create(title='Take That')
@@ -398,7 +393,7 @@ class TestHeavySelect2TagWidget(TestHeavySelect2Mixin):
         assert 'data-minimum-input-length="3"' in output
 
 
-class TestHeavySelect2MultipleWidget(object):
+class TestHeavySelect2MultipleWidget:
     url = reverse('heavy_select2_multiple_widget')
     form = forms.HeavySelect2MultipleWidgetForm()
     widget_cls = HeavySelect2MultipleWidget
@@ -428,7 +423,7 @@ class TestHeavySelect2MultipleWidget(object):
         assert result_title == 'One'
 
 
-class TestAddressChainedSelect2Widget(object):
+class TestAddressChainedSelect2Widget:
     url = reverse('model_chained_select2_widget')
     form = forms.AddressChainedSelect2WidgetForm()
 

tests/test_views.py

@@ -16,13 +16,13 @@ except ImportError:
     from django.core.urlresolvers import reverse
 
 
-class TestAutoResponseView(object):
+class TestAutoResponseView:
     def test_get(self, client, artists):
         artist = artists[0]
         form = AlbumModelSelect2WidgetForm()
         assert form.as_p()
         field_id = signing.dumps(id(form.fields['artist'].widget))
-        url = reverse('django_select2-json')
+        url = reverse('django_select2:auto-json')
         response = client.get(url, {'field_id': field_id, 'term': artist.title})
         assert response.status_code == 200
         data = json.loads(response.content.decode('utf-8'))
@@ -31,25 +31,25 @@ class TestAutoResponseView(object):
 
     def test_no_field_id(self, client, artists):
         artist = artists[0]
-        url = reverse('django_select2-json')
+        url = reverse('django_select2:auto-json')
         response = client.get(url, {'term': artist.title})
         assert response.status_code == 404
 
     def test_wrong_field_id(self, client, artists):
         artist = artists[0]
-        url = reverse('django_select2-json')
+        url = reverse('django_select2:auto-json')
         response = client.get(url, {'field_id': 123, 'term': artist.title})
         assert response.status_code == 404
 
     def test_field_id_not_found(self, client, artists):
         artist = artists[0]
         field_id = signing.dumps(123456789)
-        url = reverse('django_select2-json')
+        url = reverse('django_select2:auto-json')
         response = client.get(url, {'field_id': field_id, 'term': artist.title})
         assert response.status_code == 404
 
     def test_pagination(self, genres, client):
-        url = reverse('django_select2-json')
+        url = reverse('django_select2:auto-json')
         widget = ModelSelect2Widget(
             max_results=10,
             model=Genre,
@@ -72,7 +72,7 @@ class TestAutoResponseView(object):
         assert data['more'] is False
 
     def test_label_from_instance(self, artists, client):
-        url = reverse('django_select2-json')
+        url = reverse('django_select2:auto-json')
 
         form = AlbumModelSelect2WidgetForm()
         form.fields['artist'].widget = ArtistCustomTitleWidget()
@@ -96,6 +96,6 @@ class TestAutoResponseView(object):
         widget_dict = cache.get(cache_key)
         widget_dict['url'] = 'yet/another/url'
         cache.set(cache_key, widget_dict)
-        url = reverse('django_select2-json')
+        url = reverse('django_select2:auto-json')
         response = client.get(url, {'field_id': field_id, 'term': artist.title})
         assert response.status_code == 404

tests/testapp/forms.py

@@ -10,7 +10,7 @@ from tests.testapp import models
 from tests.testapp.models import Album, City, Country
 
 
-class TitleSearchFieldMixin(object):
+class TitleSearchFieldMixin:
     search_fields = [
         'title__icontains',
         'pk__startswith'

tests/testapp/settings.py

@@ -20,12 +20,6 @@ INSTALLED_APPS = (
     'tests.testapp',
 )
 
-MIDDLEWARE = (
-    'django.contrib.sessions.middleware.SessionMiddleware',
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'django.contrib.messages.middleware.MessageMiddleware',
-)
-
 STATIC_URL = '/static/'
 
 MEDIA_ROOT = os.path.join(BASE_DIR, 'media')
@@ -50,14 +44,3 @@ SECRET_KEY = '123456'
 
 USE_L10N = True
 USE_I18N = True
-
-if os.environ.get('TRAVIS'):
-    CACHES = {
-        "default": {
-            "BACKEND": "django_redis.cache.RedisCache",
-            "LOCATION": "redis://127.0.0.1:6379/1",
-            "OPTIONS": {
-                "CLIENT_CLASS": "django_redis.client.DefaultClient",
-            }
-        }
-    }

tests/testapp/templates/form.html

@@ -1,4 +1,4 @@
-{% load staticfiles %}
+{% load static %}
 <!DOCTYPE html>
 <html>
 <head>

tests/testapp/urls.py

@@ -1,4 +1,4 @@
-from django.conf.urls import include, url
+from django.urls import include, path
 
 from .forms import (
     AddressChainedSelect2WidgetForm, AlbumModelSelect2WidgetForm,
@@ -8,28 +8,28 @@ from .forms import (
 from .views import TemplateFormView, heavy_data_1, heavy_data_2
 
 urlpatterns = [
-    url(r'^select2_widget/$',
-        TemplateFormView.as_view(form_class=Select2WidgetForm), name='select2_widget'),
-    url(r'^heavy_select2_widget/$',
-        TemplateFormView.as_view(form_class=HeavySelect2WidgetForm), name='heavy_select2_widget'),
-    url(r'^heavy_select2_multiple_widget/$',
-        TemplateFormView.as_view(form_class=HeavySelect2MultipleWidgetForm, success_url='/'),
-        name='heavy_select2_multiple_widget'),
+    path('select2_widget',
+         TemplateFormView.as_view(form_class=Select2WidgetForm), name='select2_widget'),
+    path('heavy_select2_widget',
+         TemplateFormView.as_view(form_class=HeavySelect2WidgetForm), name='heavy_select2_widget'),
+    path('heavy_select2_multiple_widget',
+         TemplateFormView.as_view(form_class=HeavySelect2MultipleWidgetForm, success_url='/'),
+         name='heavy_select2_multiple_widget'),
 
-    url(r'^model_select2_widget/$',
-        TemplateFormView.as_view(form_class=AlbumModelSelect2WidgetForm),
-        name='model_select2_widget'),
+    path('model_select2_widget',
+         TemplateFormView.as_view(form_class=AlbumModelSelect2WidgetForm),
+         name='model_select2_widget'),
 
-    url(r'^model_select2_tag_widget/$',
-        TemplateFormView.as_view(form_class=ModelSelect2TagWidgetForm),
-        name='model_select2_tag_widget'),
+    path('model_select2_tag_widget',
+         TemplateFormView.as_view(form_class=ModelSelect2TagWidgetForm),
+         name='model_select2_tag_widget'),
 
-    url(r'^model_chained_select2_widget/$',
-        TemplateFormView.as_view(form_class=AddressChainedSelect2WidgetForm),
-        name='model_chained_select2_widget'),
+    path('model_chained_select2_widget',
+         TemplateFormView.as_view(form_class=AddressChainedSelect2WidgetForm),
+         name='model_chained_select2_widget'),
 
-    url(r'^heavy_data_1/$', heavy_data_1, name='heavy_data_1'),
-    url(r'^heavy_data_2/$', heavy_data_2, name='heavy_data_2'),
+    path('heavy_data_1', heavy_data_1, name='heavy_data_1'),
+    path('heavy_data_2', heavy_data_2, name='heavy_data_2'),
 
-    url(r'^select2/', include('django_select2.urls')),
+    path('select2/', include('django_select2.urls')),
 ]

tox.ini

@@ -1,32 +0,0 @@
-[tox]
-envlist = py{36}-dj{111,20,21,master},qa,docs
-[testenv]
-setenv=
-    PYTHONPATH = {toxinidir}
-passenv=CI
-deps=
-    -rrequirements-dev.txt
-    dj111: https://github.com/django/django/archive/stable/1.11.x.tar.gz#egg=django
-    dj20: https://github.com/django/django/archive/stable/2.0.x.tar.gz#egg=django
-    dj21: https://github.com/django/django/archive/stable/2.1.x.tar.gz#egg=django
-    djmaster: https://github.com/django/django/archive/master.tar.gz#egg=django
-commands=
-    coverage run --source=django_select2 -m 'pytest' \
-        --basetemp={envtmpdir} \
-        --ignore=.tox \
-        {posargs}
-
-[testenv:qa]
-changedir={toxinidir}
-deps=
-    -rrequirements-dev.txt
-commands=
-    isort --check-only --recursive --diff {posargs}
-    flake8 --jobs=2 {posargs}
-    pydocstyle --verbose --explain --source --count {posargs}
-
-[testenv:docs]
-deps=
-    -rrequirements-dev.txt
-    https://github.com/django/django/archive/stable/1.11.x.tar.gz#egg=django
-commands=python setup.py build_sphinx