Metadata-Version: 1.0
Name: django-facebook
Version: 3.0.5
Summary: Facebook open graph API client in python. Enables django applications to register users using facebook.
Fixes issues with the official but unsupported Facebook python-sdk. Enables mobile facebook authentication.
Canvas page authentication for facebook applications. FQL access via the server side api.

Home-page: http://github.com/tschellenbach/Django-facebook
Author: Thierry Schellenbach
Author-email: thierryschellenbach@gmail.com
License: Copyright (c) Thierry Schellenbach

 (http://www.mellowmorning.com)
All rights reserved.

Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of Thierry Schellenbach. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission of Thierry Schellenbach.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Description: ######################################################################
        Django Facebook by Thierry Schellenbach (http://www.mellowmorning.com)
        ######################################################################
        
        First
        -----
        Facebook is changing their authentication flow. Expect Django Facebook to upgrade in the coming week.
        You will need to upgrade to a new version of Django Facebook to keep things working.
        Read more about the changes here:
        http://developers.facebook.com/blog/post/499/
        http://developers.facebook.com/roadmap/ (migrations)
        http://developers.facebook.com/docs/authentication/
        Their migration is now scheduled for September 1st so we still have some time :)
        
        Please contribute code :)
        
        This project is actively maintained and I appreciate improvements to the code.
        
        Contact me here or `@tschellenbach <http://www.twitter.com/tschellenbach>`_
        
        New in Version 2.0 Alpha
        ------------------------
        * canvas page support for facebook applications
        * mobile facebook registration support (tested with titanium FB flow)
        * less requirements (jinja, view decorator, django notify and cjson requirements removed)
        * fql support
        * django static support
        
        About Django Facebook
        ---------------------
        Django Facebook allows you to connect to the Facebook Open Graph API.
        Integrated with Django it becomes easy to setup a login/register via Facebook flow for your users.
        
        **Features**
        
        * Access the Facebook API, from:
           * Your website (Using javascript OAuth)
           * Facebook canvas pages (For building facebook applications)
           * Mobile (Or any other flow giving you a valid access token)
        * Django User Registration (Convert Facebook user data into a user model)
        * Use Facebook data to register a user with your Django app. Facebook connect using the open graph API.
        * Facebook FQL access
        
        Works best with (not required)
        ------------------------------
        * Django registration
        * Django 1.3
        * Django static files
        
        TODO (again help is appreciated!)
        ---------------------------------
        * simplify these instructions
        * separate user data conversion and FB api improvements
        * fully replace the facebook GraphAPI which they no longer support
        * add nice exception classes to the facebook official sdk replacement
        
        Installation
        ------------
        
        Download the source code or use ``pip install django_facebook``.
        
        
        **Create a Facebook App**
        
        In case you don't yet have a facebook app. You need an app to use the open graph api and make the login process work.
        You can create a facebook app at this url: http://www.facebook.com/developers/createapp.php
        
        **Settings**
        
        Define the following settings in your settings.py file:
        
        ::
        
            FACEBOOK_API_KEY
            FACEBOOK_APP_ID
            FACEBOOK_APP_SECRET
        
        **Url config, context processor, auth backend**
        
        add django facebook to your installed apps::
        
            'django_facebook',
        
        add this line to your url config::
        
            (r'^facebook/', include('django_facebook.urls')),
        
        add this line to your context processors (``TEMPLATE_CONTEXT_PROCESSORS``
        setting)::
        
            'django_facebook.context_processors.facebook',
        
        add this to your ``AUTHENTICATION_BACKENDS`` setting::
        
            'django_facebook.auth_backends.FacebookBackend',
        
        **Update your models**
        
        Add the following fields to your profile model:
        
        ::
        
            about_me = models.TextField(blank=True, null=True)
            facebook_id = models.IntegerField(blank=True, null=True)
            facebook_name = models.CharField(max_length=255, blank=True, null=True)
            facebook_profile_url = models.TextField(blank=True, null=True)
            website_url = models.TextField(blank=True, null=True)
            blog_url = models.TextField(blank=True, null=True)
            image = models.ImageField(blank=True, null=True, upload_to='profile_images')
            date_of_birth = models.DateField(blank=True, null=True)
            raw_data = models.TextField(blank=True, null=True)
        
        An abstract model is specified for convenience django_facebook/models.py FacebookProfileModel
        
        **Check the example**
        
        Right now you should have a working registration/connect/login in flow available at /facebook/connect/
        Test if everything is working and ensure you didn't miss a step somewhere.
        
        **Common bugs**
        
        Django Facebook expects that you are using static files in order to load the required javascript.
        If you are not using staticfiles you should load facebook.js provided in the static directory manually.
        
        Another common issue are the url matching settings from Facebook. Facebook requires you to fill in a domain for your application.
        In order for things to work with local development you need to use the same domain. So if you production site is www.mellowmorning.com you
        should run your development server on something like local.mellowmorning.com in order for facebook to allow authentication.
        
        If you encounter any difficulties please open an issue.
        
        **Customize and integrate into your site**
        
        This is the hardest step of the install.
        For an example you can look at connect.html in the templates directory.
        
        First load the javascript (it loads the facebook library asynchronously).
        I recommend that you insert this code at the bottom of your page.
        
        ::
        
            <script src="{{ MEDIA_URL }}js/facebook.js" type="text/javascript"></script>
            <script>
            facebookAppId = '{{ FACEBOOK_APP_ID }}';
            function facebookJSLoaded(){
            FB.init({appId: facebookAppId, status: false, cookie: true, xfbml: true, oauth: true});
            }
            window.fbAsyncInit = facebookJSLoaded;
            F = new facebookClass(facebookAppId);
            F.load();
            </script>
        
        Subsequently implement a form which calls Facebook via javascript.
        Note that you can control which page to go to after connect using the next input field.
        
        ::
        
        <form action="{% url facebook_connect %}?facebook_login=1" method="post">
        <a href="javascript:void(0);" style="font-size: 20px;" onclick="F.connect(this.parentNode);">Register, login or connect with facebook</a>
        <input type="hidden" value="{{ request.path }}" name="next" />
        </form>
        
        On a final note the Facebook javascript SDK requires you to place a ``'fb-root'`` div somewhere on your page. (See the example).
        
        Django Jobs
        -----------
        Do you also see the beauty in clean code? Are you experienced with high scalability web apps?
        Currently we're looking for additional talent over at our Amsterdam office.
        Feel free to drop me a line at my personal email for more information: thierryschellenbach[at]gmail.com
        
        
        
        
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Framework :: Django
