ADX-206 Updated license to CC By-NC-SA 4.0

Also converted README to markdown, and updated --extra-index-url to https.

LICENSE.md

@@ -0,0 +1,3 @@
+The [django-adelaidex-lti](https://github.com/pomegranited/django-adelaidex-lti/) library was written for the [AdelaideX Think.Create.Code Gallery](https://github.com/pomegranited/think-create-code) for the [University of Adelaide](https://www.adelaide.edu.au/adelaidex), and is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-nc-sa/4.0/).
+
+Please [contact the AdelaideX initiative](mailto:[email protected]) to discuss licensing this product for commercial use.

README.md

@@ -0,0 +1,129 @@
+django\_adelaidex.lti
+====================
+
+LTI integration used by the AdelaideX Django applications.
+
+Usage
+-----
+
+1. Update your user model::
+
+        AUTH_USER_MODEL = 'lti.User'
+
+*Note:* This is a pretty drastic to an existing application, but can be done relatively easily in a new application.  See [Django Topics :: Authentication : Substituting a Custom User Model](https://docs.djangoproject.com/en/1.9/topics/auth/customizing/#substituting-a-custom-user-model) for details.
+
+2. Configure `settings.ADELAIDEX_LTI`, e.g.:
+
+        ADELAIDEX_LTI = {
+            'LOGIN_URL': None,
+            'COURSE_URL': 'https://courses.edx.org/courses...',
+            'ENROL_URL': 'https://edx.org/course/...',
+            'LINK_TEXT': 'Course Name Goes Here',
+            'PERSIST_NAME': 'lti-myapp',
+            'PERSIST_PARAMS': ['next'],
+            'STAFF_MEMBER_GROUP': 1,
+        }
+        LTI_OAUTH_CREDENTIALS': {
+            'mykey': 'mysecret'
+        },
+
+3. Add `django_adelaidex.lti` to your `settings.INSTALLED_APPS`.
+
+        INSTALLED_APPS = (
+            ...
+            'django_adelaidex.util', # for django_adelaidex.util.templatetags.dict_filters
+            'django_adelaidex.lti',
+        )
+
+4. Add `django_adelaidex.lti.middleware` to `settings.MIDDLEWARE_CLASSES`.
+
+        MIDDLEWARE_CLASSES = (
+            ...
+            'django_auth_lti.middleware.LTIAuthMiddleware',
+            'django_adelaidex.lti.middleware.TimezoneMiddleware',
+        )
+
+5. Add `django_adelaidex.lti.context_processors` to `settings.TEMPLATES`:
+
+        TEMPLATES = [
+        {
+            ...
+            'OPTIONS': {
+                'context_processors': [
+                    'django.core.context_processors.request', # required by _profile.html
+                    'django_adelaidex.lti.context_processors.lti_settings',
+                    ...
+                ],
+            },
+        )
+
+6. Include the `django_adelaidex.lti.urls` in your project's `urls.urlpatterns`, e.g.,
+
+        urlpatterns = [
+            ...
+            url(r'^lti/', include('django_adelaidex.lti.urls')),
+        ]
+
+7. Optionally configure overriding your default 'login' url with our 403 page,
+   to disallow normal Django user authentication when running under LTI mode, e.g.::
+
+        # in settings.py
+        LOGIN_URL='login'
+
+        # in urls.py
+        if getattr(settings, 'ADELAIDEX_LTI', {}).get('LOGIN_URL'):
+            urlpatterns.append(url(r'^login/$',
+                               LTIPermissionDeniedView.as_view(),
+                               name='login'))
+        else:
+            urlpatterns.append(url(r'^login/$',
+                               auth_views.login,
+                               kwargs={'template_name': 'login.html'},
+                               name='login'))
+Test
+----
+
+To set up the virtualenv::
+
+    virtualenv .virtualenv
+    source .virtualenv/bin/activate
+    pip install --extra-index-url=https://lti-adx.adelaide.edu.au/pypi/ -U -r django_adelaidex/lti/tests/pip.txt 
+    sudo find .virtualenv/lib/python2.7/site-packages -name \*.so -exec chcon -t shlib_t {} \;
+
+To run the tests::
+
+    python manage.py test
+
+To check coverage::
+
+    coverage run --include=django_adelaidex/*  ./manage.py test     
+    Name                                                         Stmts   Miss  Cover
+    --------------------------------------------------------------------------------
+    django_adelaidex/__init__.py                                     2      0   100%
+    django_adelaidex/lti/__init__.py                                 0      0   100%
+    django_adelaidex/lti/context_processors.py                      35      0   100%
+    django_adelaidex/lti/middleware.py                              10      0   100%
+    django_adelaidex/lti/migrations/0001_initial.py                  8      0   100%
+    django_adelaidex/lti/migrations/0002_auto_20151230_1212.py       6      0   100%
+    django_adelaidex/lti/migrations/__init__.py                      0      0   100%
+    django_adelaidex/lti/models.py                                  71      2    97%
+    django_adelaidex/lti/tests/__init__.py                           0      0   100%
+    django_adelaidex/lti/tests/settings.py                          21      0   100%
+    django_adelaidex/lti/tests/test_contextprocessors.py            74      3    96%
+    django_adelaidex/lti/tests/test_integration.py                 317      3    99%
+    django_adelaidex/lti/tests/test_middleware.py                   42      0   100%
+    django_adelaidex/lti/tests/test_models.py                      122      0   100%
+    django_adelaidex/lti/tests/test_views.py                       324      0   100%
+    django_adelaidex/lti/tests/urls.py                              10      0   100%
+    django_adelaidex/lti/tests/views.py                              3      0   100%
+    django_adelaidex/lti/urls.py                                     4      0   100%
+    django_adelaidex/lti/views.py                                  106      5    95%
+    --------------------------------------------------------------------------------
+    TOTAL                                                         1155     13    99%
+
+Build
+-----
+
+To build the pip package::
+
+    python setup.py sdist

setup.py

@@ -40,7 +40,7 @@
         'mock==1.0.1',
     ],
     dependency_links=[
-        'http://lti-adx.adelaide.edu.au/pypi/django-auth-lti',
+        'https://lti-adx.adelaide.edu.au/pypi/django-auth-lti',
     ],
     zip_safe=False,
 )