[Python-modules-commits] [python-social-auth] 52/322: Quick khan academy docs

[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 02bed89211aa96c19c0e776f83d2d84679841f1f
Author: Matías Aguirre <matiasaguirre at gmail.com>
Date:   Sat Nov 22 13:25:50 2014 -0200

    Quick khan academy docs
---
 docs/backends/index.rst       |  1 +
 docs/backends/khanacademy.rst | 25 +++++++++++++++++++++++++
 2 files changed, 26 insertions(+)

diff --git a/docs/backends/index.rst b/docs/backends/index.rst
index e7d4c41..ae9afe5 100644
--- a/docs/backends/index.rst
+++ b/docs/backends/index.rst
@@ -74,6 +74,7 @@ Social backends
    instagram
    jawbone
    kakao
+   khanacademy
    lastfm
    linkedin
    livejournal
diff --git a/docs/backends/khanacademy.rst b/docs/backends/khanacademy.rst
new file mode 100644
index 0000000..79e2f61
--- /dev/null
+++ b/docs/backends/khanacademy.rst
@@ -0,0 +1,25 @@
+Khan Academy
+============
+
+Khan Academy uses a variant of OAuth1 authentication flow. Check the API
+details at `Khan Academy API Authentication`_.
+
+Follow this steps in order to use the backend:
+
+- Register a new application at `Khan Academy API Apps`_,
+
+- Fill **Consumer Key** and **Consumer Secret** values::
+
+    SOCIAL_AUTH_KHANACADEMY_OAUTH1_KEY = ''
+    SOCIAL_AUTH_KHANACADEMY_OAUTH1_SECRET = ''
+
+- Add the backend to ``AUTHENTICATION_BACKENDS`` setting::
+
+    AUTHENTICATION_BACKENDS = (
+        ...
+        'social.backends.khanacademy.KhanAcademyOAuth1',
+        ...
+    )
+
+.. _Khan Academy API Authentication: https://github.com/Khan/khan-api/wiki/Khan-Academy-API-Authentication
+.. _Khan Academy API Apps: http://www.khanacademy.org/api-apps/register

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