Merge pull request #456 from edx/schen/upgrade_django32

[Feat]: Upgrade django from 2.2 to 3.2

Author: schenedx

.travis.yml

@@ -20,7 +20,7 @@ matrix:
     - python: '3.8'
       env: TESTNAME=test-python-3.8 TARGETS="PYTHON_ENV=py38 main.test"
     - python: '3.8'
-      env: TESTNAME=test-python-3.8-django-3.0 TARGETS="PYTHON_ENV=py38 DJANGO_VERSION=django30 main.test"
+      env: TESTNAME=test-python-3.8-django-3.0 TARGETS="PYTHON_ENV=py38 DJANGO_VERSION=django32 main.test"
       after_success:
         - docker exec analytics_api_testing /edx/app/analytics_api/analytics_api/.travis/run_coverage.sh
         - codecov --disable pycov

Makefile

@@ -3,7 +3,7 @@ COVERAGE_DIR = $(ROOT)/build/coverage
 PACKAGES = analyticsdataserver analytics_data_api
 DATABASES = default analytics
 PYTHON_ENV=py38
-DJANGO_VERSION=django22
+DJANGO_VERSION=django32
 .DEFAULT_GOAL := help
 
 help: ## display this help message

analyticsdataserver/settings/base.py

@@ -244,8 +244,9 @@
     'rest_framework',
     'rest_framework.authtoken',
     'rest_framework_jwt',
-    'rest_framework_swagger',
     'django_countries',
+    'drf_yasg',
+    'edx_api_doc_tools',
     'storages',
     'enterprise_data',
     'rules.apps.AutodiscoverRulesConfig',

analyticsdataserver/urls.py

@@ -1,22 +1,30 @@
 from django.conf.urls import include, url
 from django.contrib import admin
 from django.views.generic import RedirectView
+from edx_api_doc_tools import make_api_info, make_docs_ui_view
 from rest_framework.authtoken.views import obtain_auth_token
 
 from analyticsdataserver import views
 
 admin.site.site_header = 'Analytics Data API Service Administration'
 admin.site.site_title = admin.site.site_header
 
+api_ui_view = make_docs_ui_view(
+    make_api_info(
+        title="edX Analytics Data API",
+        version="v1",
+        email="program-cosmonauts@edx.org"
+    )
+)
+
 urlpatterns = [
     url(r'^$', RedirectView.as_view(url='/docs')),  # pylint: disable=no-value-for-parameter
 
     url(r'^api-auth/', include('rest_framework.urls', 'rest_framework')),
     url(r'^api-token-auth/', obtain_auth_token),
 
     url(r'^api/', include('analytics_data_api.urls')),
-    url(r'^docs/', views.SwaggerSchemaView.as_view()),
-
+    url(r'^docs/$', api_ui_view, name='api-docs'),
     url(r'^status/$', views.StatusView.as_view(), name='status'),
     url(r'^authenticated/$', views.AuthenticationTestView.as_view(), name='authenticated'),
     url(r'^health/$', views.HealthView.as_view(), name='health'),

analyticsdataserver/views.py

@@ -3,12 +3,10 @@
 from django.conf import settings
 from django.db import connections
 from django.http import HttpResponse
-from rest_framework import permissions, schemas
-from rest_framework.permissions import AllowAny
+from rest_framework import permissions
 from rest_framework.renderers import JSONRenderer
 from rest_framework.response import Response
 from rest_framework.views import APIView
-from rest_framework_swagger.renderers import OpenAPIRenderer, SwaggerUIRenderer
 
 logger = logging.getLogger(__name__)
 
@@ -33,21 +31,6 @@ def _handle_error(status_code):
     return HttpResponse(renderer.render(info), content_type=content_type, status=status_code)
 
 
-class SwaggerSchemaView(APIView):
-    """
-    Renders the swagger schema for the documentation regardless of permissions.
-    """
-    permission_classes = [AllowAny]
-    renderer_classes = [
-        OpenAPIRenderer,
-        SwaggerUIRenderer
-    ]
-
-    def get(self, _request):
-        generator = schemas.SchemaGenerator(title='Analytics API')
-        return Response(generator.get_schema())
-
-
 class StatusView(APIView):
     """
     Simple check to determine if the server is alive

requirements/base.in

@@ -2,20 +2,21 @@
 
 -c constraints.txt
 
+edx-api-doc-tools
 boto==2.42.0                        # MIT
 boto3
+coreapi
 Django                              # BSD License
 django-countries                    # MIT
 python-memcached                    # Python Software Foundation License v2
 djangorestframework                 # BSD
-django-rest-swagger                 # BSD
 djangorestframework-csv             # BSD
 django-storages                     # BSD
 elasticsearch-dsl                   # Apache 2.0
 ordered-set                         # MIT
 tqdm                                # MIT
 urllib3                             # MIT
-Markdown==2.6.6                     # BSD:markdown is used by swagger for rendering the api docs
+Markdown                            # BSD:markdown is used by swagger for rendering the api docs
 edx-ccx-keys
 edx-django-release-util
 edx-opaque-keys