https://github.com/ramusus/django-social-api

Django social networks API abstraction layer
https://github.com/ramusus/django-social-api

Last synced: 7 months ago
JSON representation

Django social networks API abstraction layer

• Host: GitHub
• URL: https://github.com/ramusus/django-social-api
• Owner: ramusus
• License: bsd-3-clause
• Created: 2016-02-10T21:15:30.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-01-18T22:13:12.000Z (over 9 years ago)
• Last Synced: 2024-08-09T11:16:36.999Z (almost 2 years ago)
• Language: Python
• Size: 26.4 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Django Social API

====================

[![PyPI version](https://badge.fury.io/py/django-social-api.png)](http://badge.fury.io/py/django-social-api) [![Build Status](https://travis-ci.org/ramusus/django-social-api.png?branch=master)](https://travis-ci.org/ramusus/django-social-api) [![Coverage Status](https://coveralls.io/repos/ramusus/django-social-api/badge.png?branch=master)](https://coveralls.io/r/ramusus/django-social-api)

Django social networks API abstraction layer. Application allows to use family of social network API applications, such as:

* (django-facebook-api)[https://github.com/ramusus/django-facebook-api]

* (django-instagram-api)[https://github.com/ramusus/django-instagram-api]

* (django-twitter-api)[https://github.com/ramusus/django-twitter-api]

* (django-vkontakte-api)[https://github.com/ramusus/django-vkontakte-api]

* (django-odniklassniki-api)[https://github.com/ramusus/django-odniklassniki-api]

This application provides access tokens from different storages.

# Settings

Context of API calls. You can provide static tokens here in format {'facebook': {'token': '...'}}

    SOCIAL_API_CALL_CONTEXT = {}

You can temporary override this settings using context manager `override_api_context`:

    from social_api.api import override_api_context

    with override_api_context('facebook', context_key=context_value):

        api.call(..)

Available storages, you can add your own storages inherited from social_api.storages.base.TokensStorageAbstractBase

    SOCIAL_API_TOKENS_STORAGES = {

        'social_api.storages.oauthtokens.OAuthTokensStorage',

        'social_api.storages.social_auth.SocialAuthTokensStorage',

    }

# Storages

## Python Social Auth

(python-social-auth)[https://github.com/omab/python-social-auth] is an easy-to-setup social authentication/registration

mechanism with support for several frameworks and auth providers. Crafted using base code from django-social-auth,

it implements a common interface to define new authentication providers from third parties, and to bring support for

more frameworks and ORMs.

Mapping settings between provider codes {'social_api': 'social_auth'}

    SOCIAL_API_SOCIAL_AUTH_PROVIDERS_MAP = {

        'vkontakte': 'vk-oauth2',

        'instagram': 'instagram',

        'facebook': 'facebook',

        'odnoklassniki': 'odnoklassniki-oauth2',

        'twitter': 'twitter',

    }

If you want to make a API call by exact user, use `override_api_context` with `social_auth_user` argument:

    from social_api.api import override_api_context

    with override_api_context('facebook', social_auth_user=user):

        api.call(..)

## Django Oauth Tokens

(django-oauth-tokens)[https://github.com/ramusus/django-oauth-tokens] is application to make silent oauth

authentication from bunch of user credentials and collect access tokens. All user credentials could be stored in

settings or database and for each of them application request access token via Oauth mechanism. It's allowed to tag

any of user credentials.

If you want to make a API call with access token of tagged user credentials, use `override_api_context` with

`oauth_tokens_tag` argument:

    from social_api.api import override_api_context

    with override_api_context('facebook', oauth_tokens_tag='tag'):

        api.call(..)