Upgrade (#6)

Author: barseghyanartur

.coveralls.yml

@@ -0,0 +1 @@
+service_name: github-actions

.coverals.yml

@@ -15,6 +15,18 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+0.2.12
+------
+2021-11-25
+
+- Tested against Django 3.1 and 3.2.
+- Tested against Python 3.9 and 3.10.
+- Tested against Django REST Framework 3.12.
+- Drop Python 2.x support.
+- Drop Python 3.5 support.
+- Drop Django < 2.2 support.
+- Drop Django REST Framework < 3.9.x support.
+
 0.2.11
 ------
 2019-12-27

CHANGELOG.rst

@@ -27,14 +27,15 @@ Collection of various tricks for
 Prerequisites
 =============
 
-- Django 1.8, 1.9, 1.10, 1.11, 2.0, 2.1, 2.2 and 3.0.
-- Python 2.7, 3.5, 3.6, 3.7, 3.8
+- Django 2.2, 3.0, 3.1 and 3.2.
+- Python 3.6, 3.7, 3.8, 3.9 and 3.10.
 
 Dependencies
 ============
 
-- djangorestframework: Written with 3.6.3, tested with >=3.5.0,<=3.11.0. May
-  work on earlier versions, although not guaranteed.
+- djangorestframework: Initially written with 3.6.3, but nowadays tested
+  with >=3.9.2,<=3.11.0. May (still) work on earlier- or (even) support
+  later- versions, although not guaranteed.
 
 Installation
 ============
@@ -45,17 +46,11 @@ Installation
 
         pip install django-rest-framework-tricks
 
-    or latest stable version from GitHub:
+    or latest development version from GitHub:
 
     .. code-block:: sh
 
-        pip install https://github.com/barseghyanartur/django-rest-framework-tricks/archive/stable.tar.gz
-
-    or latest stable version from BitBucket:
-
-    .. code-block:: sh
-
-        pip install https://bitbucket.org/barseghyanartur/django-rest-framework-tricks/get/stable.tar.gz
+        pip install https://github.com/barseghyanartur/django-rest-framework-tricks/archive/master.tar.gz
 
 (2) Add ``rest_framework`` and ``rest_framework_tricks`` to ``INSTALLED_APPS``:
 
@@ -705,28 +700,19 @@ To test against specific environment, type:
 
 .. code-block:: sh
 
-    tox -e py38-django30
+    tox -e py39-django32
 
 To test just your working environment type:
 
 .. code-block:: sh
 
-    ./runtests.py
+    pytest -vvv
 
 To run a single test in your working environment type:
 
 .. code-block:: sh
 
-    ./runtests.py src/rest_framework_tricks/tests/test_nested_proxy_field.py
-
-Or:
-
-.. code-block:: sh
-
-    ./manage.py test rest_framework_tricks.tests.test_nested_proxy_field
-
-It's assumed that you have all the requirements installed. If not, first
-install the test requirements:
+    pytest -vvv src/rest_framework_tricks/tests/test_nested_proxy_field.py
 
 .. code-block:: sh
 

README.rst

@@ -15,25 +15,24 @@
 import os
 import sys
 
-from nine import versions
-
 # 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('.'))
-sys.path.insert(0, os.path.abspath(os.path.join('..', 'src')))
-sys.path.insert(0, os.path.abspath(os.path.join('..', 'examples')))
-sys.path.insert(0, os.path.abspath(os.path.join('..', 'examples', 'simple')))
+sys.path.insert(0, os.path.abspath(os.path.join("..", "src")))
+sys.path.insert(0, os.path.abspath(os.path.join("..", "examples")))
+sys.path.insert(0, os.path.abspath(os.path.join("..", "examples", "simple")))
 try:
     import rest_framework_tricks
     from simple import settings as example_settings
+
     version = rest_framework_tricks.__version__
     project = rest_framework_tricks.__title__
     copyright = rest_framework_tricks.__copyright__
 except Exception as e:
-    version = '0.1'
-    project = u'django-rest-framework-tricks'
-    copyright = u'2017, Artur Barseghyan <artur.barseghyan@gmail.com>'
+    version = "0.1"
+    project = u"django-rest-framework-tricks"
+    copyright = u"2017, Artur Barseghyan <artur.barseghyan@gmail.com>"
 
 # -- Django configuration -----------------------------------------------------
 import django
@@ -43,30 +42,21 @@
     INSTALLED_APPS = list(example_settings.INSTALLED_APPS)
 
     configure_kwargs = {
-        'DATABASES': example_settings.DATABASES,
-        'INSTALLED_APPS': INSTALLED_APPS,
-        'MEDIA_ROOT': example_settings.MEDIA_ROOT,
-        'MEDIA_URL': example_settings.MEDIA_URL,
-        'MIDDLEWARE_CLASSES': example_settings.MIDDLEWARE_CLASSES,
-        'ROOT_URLCONF': example_settings.ROOT_URLCONF,
-        'SECRET_KEY': example_settings.SECRET_KEY,
-        'SITE_ID': example_settings.SITE_ID,
-        'STATICFILES_DIRS': example_settings.STATICFILES_DIRS,
-        'STATICFILES_FINDERS': example_settings.STATICFILES_FINDERS,
-        'STATIC_URL': example_settings.STATIC_URL,
-        'STATIC_ROOT': example_settings.STATIC_ROOT,
+        "DATABASES": example_settings.DATABASES,
+        "INSTALLED_APPS": INSTALLED_APPS,
+        "MEDIA_ROOT": example_settings.MEDIA_ROOT,
+        "MEDIA_URL": example_settings.MEDIA_URL,
+        "MIDDLEWARE_CLASSES": example_settings.MIDDLEWARE_CLASSES,
+        "ROOT_URLCONF": example_settings.ROOT_URLCONF,
+        "SECRET_KEY": example_settings.SECRET_KEY,
+        "SITE_ID": example_settings.SITE_ID,
+        "STATICFILES_DIRS": example_settings.STATICFILES_DIRS,
+        "STATICFILES_FINDERS": example_settings.STATICFILES_FINDERS,
+        "STATIC_URL": example_settings.STATIC_URL,
+        "STATIC_ROOT": example_settings.STATIC_ROOT,
     }
 
-    if versions.DJANGO_GTE_1_8:
-        configure_kwargs.update({'TEMPLATES':example_settings.TEMPLATES})
-    else:
-        configure_kwargs.update({
-            'TEMPLATE_CONTEXT_PROCESSORS':
-                example_settings.TEMPLATE_CONTEXT_PROCESSORS,
-            'TEMPLATE_DIRS': example_settings.TEMPLATE_DIRS,
-            'TEMPLATE_LOADERS': example_settings.TEMPLATE_LOADERS,
-        })
-
+    configure_kwargs.update({"TEMPLATES": example_settings.TEMPLATES})
 
     settings.configure(**configure_kwargs)
 
@@ -79,19 +69,19 @@
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
 # project = u'django-rest-framework-tricks'
@@ -119,7 +109,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ["_build"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -137,7 +127,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -147,7 +137,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = "default"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -176,7 +166,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
@@ -220,31 +210,31 @@
 # html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'django-rest-framework-tricksdoc'
+htmlhelp_basename = "django-rest-framework-tricksdoc"
 
 
 # -- Options for LaTeX output -------------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-# 'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-# 'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-# 'preamble': '',
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass
 # [howto/manual]).
 latex_documents = [
-  ('index',
-   'django-rest-framework-tricks.tex',
-   u'django-rest-framework-tricks Documentation',
-   u'Artur Barseghyan \\textless{}artur.barseghyan@gmail.com\\textgreater{}',
-   'manual'),
+    (
+        "index",
+        "django-rest-framework-tricks.tex",
+        u"django-rest-framework-tricks Documentation",
+        u"Artur Barseghyan \\textless{}artur.barseghyan@gmail.com\\textgreater{}",
+        "manual",
+    ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top
@@ -273,11 +263,13 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index',
-     'django-rest-framework-tricks',
-     u'django-rest-framework-tricks Documentation',
-     [u'Artur Barseghyan <artur.barseghyan@gmail.com>'],
-     1)
+    (
+        "index",
+        "django-rest-framework-tricks",
+        u"django-rest-framework-tricks Documentation",
+        [u"Artur Barseghyan <artur.barseghyan@gmail.com>"],
+        1,
+    )
 ]
 
 # If true, show URL addresses after external links.
@@ -290,12 +282,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'django-rest-framework-tricks',
-   u'django-rest-framework-tricks Documentation',
-   u'Artur Barseghyan <artur.barseghyan@gmail.com>',
-   'django-rest-framework-tricks',
-   "Integrate Elasticsearch DSL with Django REST framework.",
-   'Miscellaneous'),
+    (
+        "index",
+        "django-rest-framework-tricks",
+        u"django-rest-framework-tricks Documentation",
+        u"Artur Barseghyan <artur.barseghyan@gmail.com>",
+        "django-rest-framework-tricks",
+        "Integrate Elasticsearch DSL with Django REST framework.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -311,10 +306,10 @@
 # -- Options for Epub output --------------------------------------------------
 
 # Bibliographic Dublin Core info.
-epub_title = u'django-rest-framework-tricks'
-epub_author = u'Artur Barseghyan <artur.barseghyan@gmail.com>'
-epub_publisher = u'Artur Barseghyan <artur.barseghyan@gmail.com>'
-epub_copyright = u'2017, Artur Barseghyan <artur.barseghyan@gmail.com>'
+epub_title = u"django-rest-framework-tricks"
+epub_author = u"Artur Barseghyan <artur.barseghyan@gmail.com>"
+epub_publisher = u"Artur Barseghyan <artur.barseghyan@gmail.com>"
+epub_copyright = u"2017, Artur Barseghyan <artur.barseghyan@gmail.com>"
 
 # The language of the text. It defaults to the language option
 # or en if the language is not set.

docs/conf.py

@@ -0,0 +1,4 @@
+python-memcached==1.58
+pytz
+six>=1.9
+Pillow

examples/requirements/base.in

@@ -1,6 +1,16 @@
-#mysqlclient
-#psycopg2
+#
+# This file is autogenerated by pip-compile with python 3.8
+# To update, run:
+#
+#    pip-compile common.in
+#
+pillow==8.4.0
+    # via -r common.in
 python-memcached==1.58
-pytz
-six>=1.9
-Pillow
+    # via -r common.in
+pytz==2021.3
+    # via -r common.in
+six==1.16.0
+    # via
+    #   -r common.in
+    #   python-memcached

examples/requirements/base.txt

@@ -0,0 +1,2 @@
+ipython
+ipdb