This repository has been archived on 2019-12-04. You can view files and clone it, but cannot push or open issues or pull requests.
hrafn/README.markdown

40 lines
1.6 KiB
Markdown
Raw Normal View History

2010-05-20 19:33:05 +00:00
Hrafn is a python twitter application. It started because no existing client supported the Lists API, but has grown to be a general-purpose Twitter client.
2010-04-21 17:58:15 +00:00
### Installation
2010-04-21 17:58:15 +00:00
You'll need the following python modules:
* pyGTK
2010-04-08 14:56:21 +00:00
* dateutil
2010-05-21 18:03:19 +00:00
* python-oauth
* python-twitter (the dev version, not 0.6), along with my patches (included here)
2010-04-08 14:56:21 +00:00
For the twitter module, you can download and install it with:
hg clone https://python-twitter.googlecode.com/hg/ python-twitter
cd python-twitter
hg update dev
2010-05-24 19:54:08 +00:00
for i in ../hrafn/patches/python-twitter-*.patch; do patch p1 < $i; done
python setup.py build
python setup.py install --user
This will install python-twitter in your ~/.local/lib directory, which python 2.6 will automatically include in PYTHONPATH.
2010-04-21 17:58:15 +00:00
### Usage
Just run ./hrafn.py, and start playing around. Right now, it is best to run this file in-place; it expects all the .py files and default.glade to be in the same directory.
2010-04-21 17:58:15 +00:00
To register an account with hrafn, simply click File -> Add Account. An authorization screen will launch in your web browser. When you finish there, you should have a PIN. Copy this into the popup that hrafn created, and click 'ok'.
2010-04-21 17:58:15 +00:00
To search for a user, prepend the search with 'user: '.
2010-04-21 17:58:15 +00:00
After the first run, the program will write a file called ~/.hrafn.conf, with default configuration. Feel free to edit this file if needed.
If things get really mucked up, deleting ~/.hrafn.db will reset the application to a pristine state. You will have to re-authenticate, though.
### Notes
The system tray icon is Public Domain from: http://commons.wikimedia.org/wiki/File:Capi_x_Raven.svg