Index of /python/flgrowler

Icon  Name                    Last modified      Size  Description
[PARENTDIR] Parent Directory - [   ] Changes 2008-11-22 11:33 1.7K [   ] flgrowler-1.0.tar.gz 2008-11-22 11:33 7.0K GZIP compressed docume> [   ] flgrowler-1.1.tar.gz 2008-11-22 11:33 7.3K GZIP compressed docume>
NAME
    flgrowler - a series of Python daemons for polling Flickr and displaying
    updates with Growl notifications

SYNOPSIS
     145 ->/usr/local/bin/flcontacts  -c ~/.flickr/flgrowler.cfg
     [Tue Dec 18 23:26:52 2007][flcontacts] 00:18:99:99:30:4b is nearby
     [Tue Dec 18 23:27:10 2007][flcontacts] received 50 new events (50 total)
     [Tue Dec 18 23:27:29 2007][flcontacts] sleep for 120 seconds
     [Tue Dec 18 23:29:30 2007][flcontacts] 00:18:99:99:30:4b is nearby
     [Tue Dec 18 23:29:32 2007][flcontacts] received 3 new events (50 total)
     [Tue Dec 18 23:29:32 2007][flcontacts] sleep for 120 seconds

DESCRIPTION
    "flgrowler" is a series of Python daemons for polling Flickr and
    displaying updates with Growl notifications. It consists of a base class
    and three separate applications :

    * flactivity
        Display recent activity on your photos.

    * flcontacts
        Display recent photos from your contacts.

    * flavourites
        Display recently favorited photos from one or more of your contacts.

    If configured properly, these applications can also be made to read and
    write previously displayed items to the Intercloud, more better known as
    Amazon S3 servers, to allow for a mostly chronological and seamless
    chain of notifications between multiple machines, say work and home.

    The mostliness can be made more moster by identifying one or more
    Bluetooth devices whose proximity will be measured and used as a
    determining factor whether or not to display notification events.

    At the moment, these are strictly command-line applications that are
    driven by config files. There are no sexy UIs or helper tools. Yet.

OPTIONS
    Options are passed to flgrowler applications using an ".ini" formatted
    config file. Options are grouped by "block" matching the application's
    name.

    For example, the config file for the *flcontacts.py* application would
    be :

  flcontacts
    * api_key
        Your Flickr API key

    * api_secret
        Your Flickr API key application secret

    * auth_token
        A Flickr API auth token for a specific user (presumably you)

    * interval
        The number of seconds to wait before polling a service (Flickr, in
        this case) again

    * datastore
        Where to store data about "already seen" items. Possible values are:
        s3, default

    * storepath
        If the value of 'datastore' is default, then this should be a path
        where a new local database file can be created

    * s3_access_key
        If the value of 'datastore' is s3, a valid Amazon Web Services
        "access" key for reading and writing data from the S3 servers.

    * s3_secret_key
        If the value of 'datastore' is s3, a valid Amazon Web Services
        "secret" key for reading and writing data from the S3 servers.

    * s3_bucket_prefix
        The 's3_bucket_prefix' is required to create a uniquely named bucket
        for storing your data. For example, if your prefix was 'asc', the
        AWS S3 bucket name would be: info.aaronland.asc

        (*info.aaronland.flgrowler* is already taken.)

    * nfc_beacon_watchlist
        Any number Bluetooth addresses to locate before polling a service
        (in this case Flickr).

        If none of the addresses listed are present then the application
        will sleep for 'interval' seconds before trying again.

        There is currently no support for anything other than Bluetooth
        devices.

    * nfc_beacon_stoplist
        Any number Bluetooth addresses to locate before polling a service
        (in this case Flickr).

        If any of the addresses listed are present then the application will
        sleep for 'interval' seconds before trying again.

        There is currently no support for anything other than Bluetooth
        devices.

    * thumb_folder
        The path to a directory where thumbnails, for icon and buddy icons,
        should be stored (cached) on your local machine.

        If not defined the application will use whatever your operating
        system thinks is its *temporary directory*.

    * thumb_max_age
        The maximum age a thumbnail or buddyicon may reach before being
        removed from your hard-drive.

        The syntax is (n)(modifier) where (n) is a positive integer and
        (modifier) may be one of the following :

        * h Remove photos that are older than (n) hours.

        * d Remove photos that are older than (n) days.

        * w Remove photos that are older than (n) weeks.

        * M Remove photos that are older than (n) months.

        If not defined the application will never delete any files it
        downloads.

    * skip_items_older_than
        Skip photos, or photo events, whose creation date is older a given
        age.

        The syntax is (n)(modifier) where (n) is a positive integer and
        (modifier) may be one of the following :

        * h Skip photos that are older than (n) hours.

        * d Skip photos that are older than (n) days.

        * w Skip photos that are older than (n) weeks.

        * M Skip photos that are older than (n) months.

APPLICATION SPECIFIC OPTIONS
  flavourites
    * users
        A comma separated list of Flickr screennames whose favourited photos
        should be displayed.

VERSION
    1.1

DATE
    $Date: 2008/01/04 07:52:25 $

AUTHOR
    Aaron Straup Cope <http://www.aaronland.info>

SEE ALSO
    <http://www.aaronland.info/weblog/2007/12/20/castles/#zomg>

    <http://aws.amazon.com/s3>

REQUIREMENTS
    * Growl
        <http://growl.info/>

    * Growl Python bindings
        <http://growl.info/downloads_developers.php>

    * <growler.py>
        <http://www.aaronland.info/python/growler>

    * ElementTree.py
        <http://effbot.org/zone/element-index.htm>

    * boto.py
        <http://code.google.com/p/boto/>

        Required for use with AWS S3

    * pyobjc.py
        <http://pyobjc.sourceforge.net/>

        Required for use with Bluetooth/NFC detection

    * Mac OSX 10.4 or higher
        But only for use with Bluetooth/NFC detection

NOTES
    Given the Growl-iness of this package, OS X is also required. It
    wouldn't be very much work to add support for Windows or Linux though...

LICENSE
    Copyright (c) 2007 Aaron Straup Cope. All Rights Reserved.

    This is free software. You may redistribute it and/or modify it under
    the same terms as Perl itself.