Documentation for the Twitterwatch project¶

You’ll find below anything you need to install, configure or run Twitterwatch.

Guide¶

How to install Twitterwatch¶

From PyPI¶

$ pip3 install twitterwatch

From sources¶

You need at least Python 3.4.
On some Linux Distribution setuptools package does not come with default python install, you need to install it.

Install PIP:

$ wget https://bootstrap.pypa.io/get-pip.py -O - | sudo python3.4

Install setuptools module:

$ wget https://bootstrap.pypa.io/ez_setup.py -O - | sudo python3.4

(Alternatively, Setuptools may be installed to a user-local path):

$ wget https://bootstrap.pypa.io/ez_setup.py -O - | python3.4 - --user

Untar the tarball and go to the source directory with the following commands:
```
$ tar zxvf twitterwatch-0.1.tar.gz
$ cd twitterwatch
```
Next, to install Twitterwatch on your computer, type the following command with the root user:
```
$ python3.4 setup.py install
$ # or
$ python3.4 setup.py install --install-scripts=/usr/bin
```

Configure Twitterwatch¶

As a prerequisite to use Twitterwatch, you need a Twitter app. Log in Twitter, go to https://apps.twitter.com, create an app and generate the access token.

In order to configure Twitterwatch, you need to create a twitterwatch.ini file (or any name you prefer, finishing with the extension .ini) with the following parameters:

[twitter]
consumer_key=ml9jaiBnf3pmU9uIrKNIxAr3v
consumer_secret=8Cmljklzerkhfer4hlj3ljl2hfvc123rezrfsdctpokaelzerp
access_token=213416590-jgJnrJG5gz132nzerl5zerwi0ahmnwkfJFN9nr3j
access_token_secret=3janlPMqDKlunJ4Hnr90k2bnfk3jfnwkFjeriFZERj32Z

[schedule]
check_interval=60

[mail]
host=localhost
from=admin@myserver.org
to=foo@mylaptop.org

For the [twitter] section:

consumer_key: the Twitter consumer key (see your apps.twitter.com webpage)
consumer_secret: the Twitter consumer secret key (see your apps.twitter.com webpage)
access_token: the Twitter access token key (see your apps.twitter.com webpage)
access_token_secret: the Twitter access token secret key (see your apps.twitter.com webpage)

For the [mail] section:

host: the name of the mail server to connect with SMTP
from: mail address sending the email alerts
to: mail address of the recipient of the email alerts

Use Twitterwatch¶

After the configuration of Twitterwatch, just launch the following command:

$ twitterwatch /path/to/twitterwatch.ini

License¶

This software comes under the terms of the GPLv3+. See the LICENSE file for the complete text of the license.

Authors¶

Carl Chenet <chaica@ohmytux.com>