From: Matías Aguirre Date: Thu, 19 May 2011 15:02:19 +0000 (-0300) Subject: Docs X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=01495665833755d21eddd895d990dbecccfd0b82;p=django-social-auth.git Docs --- diff --git a/README.rst b/README.rst index e547a6a..37e803b 100644 --- a/README.rst +++ b/README.rst @@ -39,6 +39,7 @@ credentials, some features are: * `LiveJournal OpenID`_ * `Orkut OAuth`_ * `Linkedin OAuth`_ + * `Foursquare OAuth2`_ - Basic user data population and signaling, to allows custom fields values from providers response @@ -109,6 +110,7 @@ Configuration 'social_auth.backends.contrib.linkedin.LinkedinBackend', 'social_auth.backends.contrib.LiveJournalBackend', 'social_auth.backends.contrib.orkut.OrkutBackend', + 'social_auth.backends.contrib.orkut.FoursquareBackend', 'social_auth.backends.OpenIDBackend', 'django.contrib.auth.backends.ModelBackend', ) @@ -130,19 +132,22 @@ Configuration Take into account that backends *must* be defined in AUTHENTICATION_BACKENDS_ or Django won't pick them when trying to authenticate the user. -- Setup Twitter, Facebook, Orkut and Google OAuth keys (see OAuth_ section - for details):: - - TWITTER_CONSUMER_KEY = '' - TWITTER_CONSUMER_SECRET = '' - FACEBOOK_APP_ID = '' - FACEBOOK_API_SECRET = '' - LINKEDIN_CONSUMER_KEY = '' - LINKEDIN_CONSUMER_SECRET = '' - ORKUT_CONSUMER_KEY = '' - ORKUT_CONSUMER_SECRET = '' - GOOGLE_CONSUMER_KEY = '' - GOOGLE_CONSUMER_SECRET = '' +- Setup needed OAuth keys (see OAuth_ section for details):: + + TWITTER_CONSUMER_KEY = '' + TWITTER_CONSUMER_SECRET = '' + FACEBOOK_APP_ID = '' + FACEBOOK_API_SECRET = '' + LINKEDIN_CONSUMER_KEY = '' + LINKEDIN_CONSUMER_SECRET = '' + ORKUT_CONSUMER_KEY = '' + ORKUT_CONSUMER_SECRET = '' + GOOGLE_CONSUMER_KEY = '' + GOOGLE_CONSUMER_SECRET = '' + GOOGLE_OAUTH2_CLIENT_KEY = '' + GOOGLE_OAUTH2_CLIENT_SECRET = '' + FOURSQUARE_CONSUMER_KEY = '' + FOURSQUARE_CONSUMER_SECRET = '' - Setup login URLs:: @@ -323,6 +328,7 @@ Example:: Settings must be a list of tuples mapping value name in response and value alias used to store. + ----- OAuth ----- @@ -348,6 +354,7 @@ Example:: Settings must be a list of tuples mapping value name in response and value alias used to store. + ------- Twitter ------- @@ -392,6 +399,7 @@ define http://127.0.0.1:8000 or http://localhost:8000 because it won't work when testing. Instead I define http://myapp.com and setup a mapping on /etc/hosts or use dnsmasq_. + ----- Orkut ----- @@ -553,6 +561,9 @@ Attributions to whom deserves: - OAuth2 migration +bedspax_ + + - Foursquare support ---------- Copyrights @@ -605,6 +616,7 @@ Base work is copyrighted by: .. _Orkut OAuth: http://code.google.com/apis/orkut/docs/rest/developers_guide_protocol.html#Authenticating .. _myOpenID: https://www.myopenid.com/ .. _LiveJournal OpenID: http://www.livejournal.com/support/faqbrowse.bml?faqid=283 +.. _Foursquare OAuth2: https://developer.foursquare.com/docs/oauth.html .. _pypi: http://pypi.python.org/pypi/django-social-auth/ .. _github: https://github.com/omab/django-social-auth .. _issues in github: https://github.com/omab/django-social-auth/issues @@ -616,3 +628,4 @@ Base work is copyrighted by: .. _Quard: https://github.com/Quard .. _micrypt: https://github.com/micrypt .. _South: http://south.aeracode.org/ +.. _bedspax: https://github.com/bedspax diff --git a/doc/configuration.rst b/doc/configuration.rst index 6248972..4e7cbf9 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -20,6 +20,7 @@ Configuration 'social_auth.backends.contrib.linkedin.LinkedinBackend', 'social_auth.backends.contrib.LiveJournalBackend', 'social_auth.backends.contrib.orkut.OrkutBackend', + 'social_auth.backends.contrib.orkut.FoursquareBackend', 'social_auth.backends.OpenIDBackend', 'django.contrib.auth.backends.ModelBackend', ) @@ -41,19 +42,22 @@ Configuration Take into account that backends **must** be defined in AUTHENTICATION_BACKENDS_ or Django won't pick them when trying to authenticate the user. -- Setup Twitter, Facebook, Orkut and Google OAuth keys (see OAuth_ section - for details):: - - TWITTER_CONSUMER_KEY = '' - TWITTER_CONSUMER_SECRET = '' - FACEBOOK_APP_ID = '' - FACEBOOK_API_SECRET = '' - LINKEDIN_CONSUMER_KEY = '' - LINKEDIN_CONSUMER_SECRET = '' - ORKUT_CONSUMER_KEY = '' - ORKUT_CONSUMER_SECRET = '' - GOOGLE_CONSUMER_KEY = '' - GOOGLE_CONSUMER_SECRET = '' +- Setup needed OAuth keys (see OAuth_ section for details):: + + TWITTER_CONSUMER_KEY = '' + TWITTER_CONSUMER_SECRET = '' + FACEBOOK_APP_ID = '' + FACEBOOK_API_SECRET = '' + LINKEDIN_CONSUMER_KEY = '' + LINKEDIN_CONSUMER_SECRET = '' + ORKUT_CONSUMER_KEY = '' + ORKUT_CONSUMER_SECRET = '' + GOOGLE_CONSUMER_KEY = '' + GOOGLE_CONSUMER_SECRET = '' + GOOGLE_OAUTH2_CLIENT_KEY = '' + GOOGLE_OAUTH2_CLIENT_SECRET = '' + FOURSQUARE_CONSUMER_KEY = '' + FOURSQUARE_CONSUMER_SECRET = '' - Setup login URLs:: diff --git a/doc/contributions.rst b/doc/contributions.rst index 0dab4c2..9c37e6d 100644 --- a/doc/contributions.rst +++ b/doc/contributions.rst @@ -33,6 +33,9 @@ bernardokyotoku_ (Bernardo Kyotoku) maraujop_ (Miguel Araujo) * Improvements +bedspax_ + * Foursquare support + .. _caioariede: https://github.com/caioariede .. _krvss: https://github.com/krvss .. _jezdez: https://github.com/jezdez @@ -43,4 +46,5 @@ maraujop_ (Miguel Araujo) .. _djm: https://github.com/djm .. _bernardokyotoku: https://github.com/bernardokyotoku .. _maraujop: https://github.com/maraujop +.. _bedspax: https://github.com/bedspax .. _python-oauth2: https://github.com/simplegeo/python-oauth2 diff --git a/social_auth/backends/contrib/foursquare.py b/social_auth/backends/contrib/foursquare.py old mode 100755 new mode 100644 index 9743ff8..f0def0d --- a/social_auth/backends/contrib/foursquare.py +++ b/social_auth/backends/contrib/foursquare.py @@ -51,4 +51,4 @@ class FoursquareAuth(BaseOAuth2): # Backend definition BACKENDS = { 'foursquare': FoursquareAuth, -} \ No newline at end of file +}