change gtk.Entry into gtk.TextView
[minibook.git] / README
blob37a3608d79be84e30229ab225e52588f1d8c7968
1 minibook
2 --------
4 A Facebook (FB) status updater and lister in Python. Uses PyFacebook to 
5 make FB API calls.
8 Requirements
9 ------------
11 pygtk
12 pyfacebook: http://github.com/sciyoshi/pyfacebook/tree/master
16 How to use it for your own good?
17 --------------------------------
19 Every application has to register on FB, cannot just fool around...
20 The FB API uses two keys, an API_KEY and a SECRET_KEY to check the 
21 application making any API request on behalf of the user. The API_KEY is 
22 unique for an application, the SECRET_KEY makes sure that other people 
23 cannot hijack the identity of the app. Thus FB does not allow the 
24 SECRET_KEY to be made public.
26 The only problem is, that in an Open Source desktop app, this is not 
27 possible...
29 Then there is only one solution (I know of at the moment): everyone has 
30 to have their own version of the application... (silly, isn't it?)
32 So, to use this project, you have to do the following:
34 1) Create a new application on FB
35 http://www.facebook.com/developers/
36 Set it's type to "desktop".
38 2) On your app's page, note the "API Key" and "Application Secret".
39 Put them in a file called "config" in the root directory of minibook. 
40 The first line is the "API Key", the second is "Application Secret".
42 3) Setup the permission for this app to update your status. See:
43 http://wiki.developers.facebook.com/index.php/Extended_permission
44 More specifically, point your browser to this address:
45 http://www.facebook.com/authorize.php?api_key=YOUR_API_KEY&v=1.0&ext_perm=publish_stream
46 where you replace "YOUR_API_KEY" appropriately
48 4) Install dependencies, specifically PyFacebook
50 5) Run app, if everythings fine it should start the browser to log you 
51 in, after which you can update your profile!
54 Licensing
55 ---------
56 Minibook is released under the MIT License, basically giving you 
57 complete control of how do you use, modify and share this code, as long 
58 as the appropriate copyright information is maintained.
59 See the file "LICENSE.txt" for detailed terms and conditions for usage.