[Python-modules-commits] [python-social-auth] 45/89: Add itembase docs

[Wolfgang Borgert]

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

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

commit aeaa946c325ab71d09eda0a2c9400c116e210f22
Author: Julian Bez <jb at itembase.biz>
Date:   Tue Feb 16 11:18:37 2016 +0100

    Add itembase docs
---
 docs/backends/itembase.rst | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

diff --git a/docs/backends/itembase.rst b/docs/backends/itembase.rst
new file mode 100644
index 0000000..dcaa491
--- /dev/null
+++ b/docs/backends/itembase.rst
@@ -0,0 +1,34 @@
+Itembase
+=========
+
+Itembase uses OAuth2 for authentication.
+
+- Register a new application for the `Itembase API`_, and
+
+- Add itembase live backend and/or sandbox backend to ``AUTHENTICATION_SETTINGS``::
+
+      AUTHENTICATION_SETTINGS = (
+        ...
+        'social.backends.itembase.ItembaseOAuth2',
+        'social.backends.itembase.ItembaseOAuth2Sandbox',
+        ...
+      )
+
+- fill ``Client Id`` and ``Client Secret`` values in the settings::
+
+    SOCIAL_AUTH_ITEMBASE_KEY = ''
+    SOCIAL_AUTH_ITEMBASE_SECRET = ''
+
+    SOCIAL_AUTH_ITEMBASE_SANDBOX_KEY = ''
+    SOCIAL_AUTH_ITEMBASE_SANDBOX_SECRET = ''
+
+
+- extra scopes can be defined by using::
+
+    SOCIAL_AUTH_ITEMBASE_SCOPE = ['connection.transaction',
+                                          'connection.product',
+                                          'connection.profile',
+                                          'connection.buyer']
+    SOCIAL_AUTH_ITEMBASE_SANDBOX_SCOPE = SOCIAL_AUTH_ITEMBASE_SCOPE
+
+.. _Itembase API: http://developers.itembase.com/authentication/index

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