README

   1 minibook
   2 --------
   3
   4 A cross-platform desktop Facebook (FB) status updater and lister
   5 written in Python. Uses PyFacebook to make FB API calls.
   6
   7
   8 Requirements
   9 ------------
  10
  11 python
  12 pygtk
  13 pyfacebook: http://github.com/sciyoshi/pyfacebook/tree/master
  14
  15 minibook should run on all platforms where these are available,
  16 currently tested on Linux and Windows XP.
  17
  18 How to use it for your own good?
  19 --------------------------------
  20
  21 Every application has to register on FB, cannot just fool around...
  22 The FB API uses two keys, an API_KEY and a SECRET_KEY to check the
  23 application making any API request on behalf of the user. The API_KEY is
  24 unique for an application, the SECRET_KEY makes sure that other people
  25 cannot hijack the identity of the app. Thus FB does not allow the
  26 SECRET_KEY to be made public.
  27
  28 The only problem is, that in an Open Source desktop app, this is not
  29 possible...
  30
  31 Then there is only one solution (I know of at the moment): everyone has
  32 to have their own version of the application... (silly, isn't it?)
  33
  34 So, to use this project, you have to do the following:
  35
  36 1) Create a new application on FB
  37 http://www.facebook.com/developers/
  38 Set it's type to "desktop".
  39
  40 2) On your app's page, note the "API Key" and "Application Secret".
  41 Put them in a file called "config" in the root directory of minibook.
  42 The first line is the "API Key", the second is "Application Secret".
  43
  44 3) Setup the permission for this app to update your status. See:
  45 http://wiki.developers.facebook.com/index.php/Extended_permission
  46 More specifically, point your browser to these address:
  47 http://www.facebook.com/authorize.php?api_key=YOUR_API_KEY&v=1.0&ext_perm=publish_stream
  48 http://www.facebook.com/authorize.php?api_key=YOUR_API_KEY&v=1.0&ext_perm=read_stream
  49 where you replace "YOUR_API_KEY" appropriately
  50
  51 4) Install dependencies, specifically PyFacebook
  52
  53 5) Run app, if everythings fine it should start the browser to log you
  54 in, after which you can read your friends' status updates andupdate your
  55 profile!
  56
  57
  58 Inherent limitations
  59 --------------------
  60 Facebook privacy settings grately affect the behaviour of this app. If you have
  61 friends whose updates are not shown but everyone else's are there, or whose
  62 pictures regularly cannot be displayed, most likely they disabled sharing those
  63 information with applications. You can check and change your own settings after
  64 logging into Facebook:
  65 Menu Bar > Settings > Privacy Settings > Applications > Settings
  66
  67
  68 Licensing
  69 ---------
  70 Minibook, it's source code and artwork is released under the MIT License,
  71 basically giving you complete control of how do you use, modify and share
  72 this code, as long as the appropriate copyright information is maintained.
  73 See the file "LICENSE.txt" for detailed terms and conditions for usage.