===========
RPITwit - The (very simple) Raspberry PI Remote Controller for Tweeter
===========

RPITwit is a really simple script to execute remote shell commands on
your RaspberryPI using your twitter account.

Just write a status on your twitter account with the following format:

    #RPITwit script command

The scripts are saved on ~/rpitwit_commands/scripts they could be
shell scripts or python scripts. For python scripts do not include the
".py" extension when calling the command on twitter.

Installing RPITwit
===========

Just extract the package and run:

    sudo python setup.py install


Running on Raspberry PI
==========

**IMPORTANT Never run the rpitwit-daemon as root**

Execute the following command:

   rpitwit

To stop press Ctrl+C

TODO: install rpitwit as service.


Configuration
===========
The firs time that you run rpitwit is going to ask you for
authorization on twitter, follow the instructions.

The script is going to ask you for the twitter usernames
who are going to be able to execute scripts. Don't allow
access to unkown people.

The configuracion options are stored in ~/.rpitwit_config

You can modify the followin options:

   magicword: keyword used to run commands, this must be
     the first word on your tweet.
   follow: list of twitter user IDs that who are going
     to be able to execute commands.
   AppName: Name of the application on Twitter. Do not
     modify unless you are using your own keys.
   oauth_token: generated automatically. Do not modify.
   oauth_secret: generated automatically. Do not modify.

If you are using your own application keys you must add
this tree lines to your ~./rpitwit_config file:

   AppName=<your twitter application name>
   CONSUMER_KEY=<your twitter application key>
   CONSUMER_SECRET=<your twitter application secret>

For more info about generating your application keys look
in the documentation directory.

Warning
===========

This very simple tool that justs execute shell and python
scripts contained within the script directory.

It doesn't limit what the commands can do to your system.

If you are going to use

Credits and more Info
==========

maintainer: Mario Gomez (http://fuenteabierta.teubi.co/)
