Login

Facebook shell

Author:
stephenemslie
Posted:
September 4, 2009
Language:
Python
Version:
1.1
Tags:
management shell facebook command
Score:
3 (after 3 ratings)

This adds an 'fbshell' management command which starts up a Python shell with an authenticated pyfacebook instance ready to make requests.

This is very useful for testing out facebook requests or performing administration tasks without hooking a debugger into your application.

This snippet should be saved to

/yourproject/management/commands/fbshell.py

See custom management commands for a description of how this works.

If you are already using pyfacebook in your app then you'll already have the right settings, so just run :

$ python manage.py fbshell

A browser window will pop up, prompting you for authentication (unless you're already logged in to facebook). Press enter in the shell when you're finished this, and you'll be dropped into a shell with the session key, uuid, and name printed.

Now you can use the facebook instance:

>>> facebook.friends.get()
>>> [...]

If you haven't used pyfacebook in your app, you'll need at least the following settings in your settings.py

FACEBOOK_API_KEY = 'your_api_key'
FACEBOOK_SECRET_KEY = 'your_secret_key'
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
#management/commands/fbshell.py
from optparse import make_option
from facebook import Facebook
from django.core.management.base import NoArgsCommand, CommandError
from django.conf import settings

class Command(NoArgsCommand):
    option_list = NoArgsCommand.option_list + (
        make_option('--plain', action='store_true', dest='plain',
            help='Tells Django to use plain Python, not IPython.'),
    )
    help = "Runs a Python interactive interpreter with an active facebook"\
    "session. Tries to use IPython, if it's available."

    requires_model_validation = False

    def _start_fb_session(self):
        api_key = settings.FACEBOOK_API_KEY
        secret_key = settings.FACEBOOK_SECRET_KEY
        app_name = getattr(settings, 'FACEBOOK_APP_NAME', None)
        callback_path = getattr(settings, 'FACEBOOK_CALLBACK_PATH', None)
        internal = getattr(settings, 'FACEBOOK_INTERNAL', True)
        proxy = getattr(settings, 'HTTP_PROXY', None)
        facebook = Facebook(api_key, secret_key, app_name=app_name,
                            internal=internal, callback_path=callback_path,
                            proxy=proxy)
        facebook.auth.createToken()
        # Show login window
        # Set popup=True if you want login without navigational elements
        facebook.login()
        # Login to the window, then press enter
        print 'After logging in, press enter...'
        raw_input()
        facebook.auth.getSession()
        print 'Session Key:   ', facebook.session_key
        print 'Your UID:      ', facebook.uid
        info = facebook.users.getInfo([facebook.uid], ['name', 'birthday', 'affiliations', 'sex'])[0]
        print 'Hi ', info['name']
        return facebook

    def handle_noargs(self, **options):
        facebook = self._start_fb_session()
        # XXX: (Temporary) workaround for ticket #1796: force early loading of all
        # models from installed apps.
        from django.db.models.loading import get_models
        loaded_models = get_models()

        use_plain = options.get('plain', False)

        try:
            if use_plain:
                # Don't bother loading IPython, because the user wants plain Python.
                raise ImportError
            import IPython
            # Explicitly pass an empty list as arguments, because otherwise IPython
            # would use sys.argv from this script.
            local_dict = dict(facebook=facebook)
            shell = IPython.Shell.IPShell(argv=[], user_ns=local_dict)
            shell.mainloop()
        except ImportError:
            import code
            # Set up a dictionary to serve as the environment for the shell, so
            # that tab completion works on objects that are imported at runtime.
            # See ticket 5082.
            imported_objects = {}
            try: # Try activating rlcompleter, because it's handy.
                import readline
            except ImportError:
                pass
            else:
                # We don't have to wrap the following import in a 'try', because
                # we already know 'readline' was imported successfully.
                import rlcompleter
                readline.set_completer(rlcompleter.Completer(imported_objects).complete)
                readline.parse_and_bind("tab:complete")

            imported_objects['facebook'] = facebook
            # We want to honor both $PYTHONSTARTUP and .pythonrc.py, so follow system
            # conventions and get $PYTHONSTARTUP first then import user.
            if not use_plain: 
                pythonrc = os.environ.get("PYTHONSTARTUP") 
                if pythonrc and os.path.isfile(pythonrc): 
                    try: 
                        execfile(pythonrc) 
                    except NameError: 
                        pass
                # This will import .pythonrc.py as a side-effect
                import user
            code.interact(local=imported_objects)

More like this

  1. Facebook Authentication Backend by barnardo 4 years, 8 months ago
  2. Command Line Script Launcher by dakrauth 6 years, 7 months ago
  3. Automagically import settings from installed applications by jezdez 7 years, 1 month ago
  4. Shortcuts to your code organized by type (views, models, admin, ...) by stdbrouw 4 years, 12 months ago
  5. Facebook Connect Middleware by bretwalker 6 years, 2 months ago

Comments

Please login first before commenting.