Metadata-Version: 1.0
Name: dendrite
Version: 1.1.0
Summary: Social connectivitiy as a library
Home-page: https://github.com/caffeinehit/dendrite
Author: Alen Mujezinovic
Author-email: alen@caffeinehit.com
License: Copyright (c) 2013, Caffeinehit Ltd.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.



Description: dendrite, social connectivity as a library
        ==========================================
        
        Barebones social connection library. Tries to not do everything so you
        can do anything. Only OAuth1 and OAuth2 currently. Python 3 compatible.
        
        Usage
        -----
        
        Dendrite doesn't give you any models, URLS or finished views. It's up to
        you to define the behaviour, URLs and models. An example using Instagram
        follows.
        
        **``models.py``**
        
        We copy the full Instagram profile. If you don't want the full profile,
        you can change the behaviour of ``OAuth2CallbackView.create_profile`` in
        your views.
        
        .. code:: python
        
            class InstagramProfile(models.Model):
                id              = models.CharField(max_length=255, primary_key=True)
                username        = models.CharField(max_length=255, blank=True)
                full_name       = models.CharField(max_length=255, blank=True)
                profile_picture = models.URLField(blank=True)
                bio             = models.TextField(blank=True)
                website         = models.URLField(blank=True)
                user            = models.ForeignKey(settings.AUTH_USER_MODEL, related_name='instagram_profiles')
                access_token    = models.CharField(max_length=255, blank=True)
        
                def __unicode__(self):
                    return self.full_name
        
        **``views.py``**
        
        Create views to handle connection. You can customize the views to behave
        differently.
        
        .. code:: python
        
            from dendrite.views import OAuth2Mixin, OAuth2ConnectView, OAuth2CallbackView
        
            from .models import InstagramProfile
        
            class InstagramMixin(OAuth2Mixin):
                client_id         = settings.INSTAGRAM_CLIENT_ID
                client_secret     = settings.INSTAGRAM_CLIENT_SECRET
                site              = 'https://api.instagram.com'
                authorization_url = 'https://api.instagram.com/oauth/authorize/'
                token_url         = 'https://api.instagram.com/oauth/access_token'
                redirect_uri      = 'callback' # Name or full URL
        
                profile_class     = InstagramProfile
                scope             = "basic"
        
                
            class InstagramConnectView(InstagramMixin, OAuth2ConnectView):
                pass
        
            class InstagramCallbackView(InstagramMixin, OAuth2CallbackView):
                def get_remote_profile(self, request, token):
                    return token["user"]
        
        **``urls.py``**
        
        Include *your* social views into your urls.
        
        .. code:: python
        
            urlpatterns = patterns(
                '',
                url('^social/instagram/connect/$', InstagramConnectView.as_view(), name='connect'),
                url('^social/instagram/callback/$', InstagramCallbackView.as_view(), name='callback'),
            )
        
        **``backends.py``**
        
        Create an additional `authentication
        backend <https://docs.djangoproject.com/en/1.5/topics/auth/customizing/#other-authentication-sources>`__
        that uses ``InstagramProfile``.
        
        ``DendriteBackend`` objects receive the profile class and the full
        profile information returned by
        ``InstagramCallbackView.get_remote_profile``.
        
        .. code:: python
        
            from dendrite.backends import DendriteBackend
        
            from .models import InstagramProfile
        
            class InstagramBackend(DendriteBackend):
                profile_class = InstagramProfile
        
        **``settings.py``**
        
        Adding API keys and authentication backend.
        
        .. code:: python
        
            AUTHENTICATION_BACKENDS = (
                'django.contrib.auth.backends.ModelBackend',
                'app.InstagramBackend',
        
            )
        
            INSTAGRAM_CLIENT_ID = os.environ.get('INSTAGRAM_CLIENT_ID', '')
            INSTAGRAM_CLIENT_SECRET = os.environ.get('INSTAGRAM_CLIENT_SECRET, '')
        
        
Keywords: django social login registration oauth2
Platform: UNKNOWN
