[Python-modules-commits] [python-social-auth] 87/322: Docs for coursera backend

[Wolfgang Borgert]

This is an automated email from the git hooks/post-receive script.

debacle pushed a commit to tag v0.2.10
in repository python-social-auth.

commit 50a4bc70ee13ca5ae48f89e7a1e6784855322a9b
Author: Adam Babik <adam.babik at 10clouds.com>
Date:   Tue Jan 27 10:15:17 2015 +0100

    Docs for coursera backend
---
 docs/backends/coursera.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/docs/backends/coursera.rst b/docs/backends/coursera.rst
new file mode 100644
index 0000000..5e23a7a
--- /dev/null
+++ b/docs/backends/coursera.rst
@@ -0,0 +1,26 @@
+Coursera
+============
+
+Coursera uses a variant of OAuth2 authentication. The details of the API
+can be found at `OAuth2-based APIs - Coursera Technology`_.
+
+Take the following steps in order to use the backend:
+
+1. Create an account at `Coursera`_.
+
+2. Open `Developer Console`_, create an organisation and application.
+
+3. Set **Client ID** as a ``SOCIAL_AUTH_COURSERA_KEY`` and
+**Secret Key** as a ``SOCIAL_AUTH_COURSERA_SECRET`` in your local settings.
+
+4. Add the backend to ``AUTHENTICATION_BACKENDS`` setting::
+
+    AUTHENTICATION_BACKENDS = (
+        ...
+        'social.backends.coursera.CourseraOAuth2',
+        ...
+    )
+
+.. _OAuth2-based APIs - Coursera Technology: https://tech.coursera.org/app-platform/oauth2/
+.. _Coursera: https://accounts.coursera.org/console
+.. _Developer Console: https://accounts.coursera.org/console

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-social-auth.git