Metadata-Version: 1.0
Name: django-vkontakte-iframe
Version: 0.3
Summary: Django app for developing vk.com (aka vkontakte.ru) iframe applications
Home-page: http://bitbucket.org/kmike/django-vkontakte-iframe/
Author: Mikhail Korobov
Author-email: kmike84@gmail.com
License: MIT license
Download-URL: http://bitbucket.org/kmike/django-vkontakte-iframe/get/tip.zip
Description: =======================
        django-vkontakte-iframe
        =======================
        
        Django app for developing vk.com (aka vkontakte.ru largest,
        Russian social network) iframe applications.
        
        Handles user authentication and registration.
        
        Installation
        ============
        
        ::
        
            $ pip install django-vkontakte-iframe
        
        
        Requirements
        ============
        
        * django-annoying for AutoOneToOneField
        
        Optional:
        
        * vkontakte >= 0.9.4.1 for populating cities and countries info via admin action
        
        Usage
        =====
        
        1. Register and configure vkontakte iframe application here:
           http://vkontakte.ru/apps.php?act=add
        
        2. Add your app's settings to settings.py::
        
                VK_APP_ID = '1234567'                   # Application ID
                VK_APP_KEY = 'M1gytuHwni'               # Application key
                VK_APP_SECRET = 'MiRFwrDYwcYFCTD18EcY'  # Secure key
        
        3. Add 'vk_iframe' to INSTALLED_APPS
        
        4. Add 'vk_iframe.backends.VkontakteUserBackend' to AUTHENTICATION_BACKENDS::
        
                AUTHENTICATION_BACKENDS = (
                    'django.contrib.auth.backends.ModelBackend',
                    'vk_iframe.backends.VkontakteUserBackend',
                )
        
        
        5. Put 'vk_iframe.middleware.AuthenticationMiddleware',
           'vk_iframe.middleware.IFrameFixMiddleware' and
           'vk_iframe.middleware.LoginRequiredMiddleware' to MIDDLEWARE_CLASSES::
        
                MIDDLEWARE_CLASSES = [
                    # ...
                    'django.contrib.auth.middleware.AuthenticationMiddleware',
                    # ...
                    'vk_iframe.middleware.IFrameFixMiddleware',
                    'vk_iframe.middleware.AuthenticationMiddleware',
                    # ...
                    'django.middleware.locale.LocaleMiddleware',
                    # ...
                    'vk_iframe.middleware.LoginRequiredMiddleware',
                ]
        
           Please note that 'vk_iframe.middleware.AuthenticationMiddleware' must be
           after 'django.contrib.auth.middleware.AuthenticationMiddleware' but before
           'django.middleware.locale.LocaleMiddleware'.
        
           'vk_iframe.middleware.LoginRequiredMiddleware' must be after
           'vk_iframe.middleware.AuthenticationMiddleware'.
        
           Vkontakte visitors will be automatically registered and authorized as django
           users (username == vkontakte user id).
        
           LoginRequiredMiddleware is an optional. It returns 403 for all unauthorized
           requests with urls not listed in settings.PUBLIC_URLS. You should
           enable it for security reasons. Example of PUBLIC_URLS::
        
                PUBLIC_URLS = [
                    '^admin/$',
                    '^my-callback/',
                ]
        
           If i18n is in use then vkontakte user's language will be used as django's
           user language.
        
        
        6. Run ``python ./manage.py syncdb`` (or ``python ./manage.py migrate vk_iframe`` if
           South is used)
        
        7. Optional: load initial geo data (cities and countries)::
        
              python manage loaddata vk-geo
        
        8. If you want to store more user data then put the following line as
           the 'First API request' ('Первый запрос к API') option (in your app edit
           page at vkontakte.ru)::
        
                method=getProfiles&uids={viewer_id}&format=json&v=3.0&fields=uid,first_name,last_name,nickname,domain,sex,bdate,city,country,timezone,photo,photo_medium,photo_big,photo_rec,has_mobile,rate,contacts,education
        
        9. For IE: adjust P3P policy header value according to your site privacy policy
           by providing VK_P3P_POLICY option in your settings.py::
        
                VK_P3P_POLICY = 'IDC DSP COR IVAi IVDi OUR TST'
        
           Default value is 'IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT'.
           See http://www.p3pwriter.com/LRN_111.asp for the full set of tags.
        
        10. That's all. All your app's visitors are now registered and authenticated
            django users. Additional profile data is available as user.vk_profile.
        
        CHANGES
        =======
        
        0.3 (2011-11-28)
        ----------------
        
        * Auth backend is fixed (thanks Evgeniy Kirov and http://habrahabr.ru/users/Zaharov/);
        * improved README;
        * IE fix: P3P policy headers are added (thanks Maxim Syabro for suggestion);
        * Opera and Safari cookies fix (thanks Evgeniy Kirov);
        * alternative OpenAPI authorization (thanks Evgeniy Kirov).
        
        0.2 (2010-10-30)
        ----------------
        
        * Vkontakte user language is integrated with django i18n. Thanks Vasyl Nakvasiuk.
        * Error with InnoDB fixture loading is fixed.
        
        0.1.1 (2010-10-09)
        ------------------
        
        Bugfix: login was not allowed if user language was unknown.
        Full vkontakte language list. Thanks Vasyl Nakvasiuk.
        
        0.1 (2010-09-06)
        ----------------
        
        The first release
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
