Metadata-Version: 1.1
Name: TwitterMonitor
Version: 0.1.4
Summary: Small library to create monitoring routines with Twitter DM
Home-page: https://github.com/alissonperez/TwitterMonitor
Author: Alisson R. Perez
Author-email: alissonperez@gmail.com
License: UNKNOWN
Description: About
        =====
        
        .. image:: https://travis-ci.org/alissonperez/TwitterMonitor.svg?branch=develop
         :target: https://travis-ci.org/alissonperez/TwitterMonitor :alt:Tests status
        
        .. image:: https://coveralls.io/repos/alissonperez/TwitterMonitor/badge.png?branch=master
         :target: https://coveralls.io/r/alissonperez/TwitterMonitor?branch=master :alt:Code coverage status
        
        .. image:: https://readthedocs.org/projects/twittermonitor/badge/?version=latest
         :target: https://readthedocs.org/projects/twittermonitor/?badge=latest :alt: Documentation Status
        
        TwitterMonitor is a small open source library to create monitoring routines of any nature using **Twitter direct messages (DM)**.
        
        For each notification request, the library will take all the followers of the configured account and instantly send a DM to each one.
        
        Please, send me a feedback: arp-pp@outlook.com.br
        
        Code example
        ------------
        
        There is an example below of a simple routine (RoutineTest class) that sends "A test message" to all of the followers of the account configured in the dictionary *twitter_keys* with a minimum interval of 10 minutes between each notification::
        
            from twitter_monitor import core
        
        
            # A simple routine example
            class RoutineTest(core.Routine):
        
                name = u"Test Routine 1"  # Routine full name. ALWAYS USE UNICODE
                short_name = u"RT1"       # Routine short name (it'll be used in message). ALWAYS USE UNICODE
        
                interval_minutes = 10     # You can put a execution interval in minutes
        
                def _execute(self):
                    # Put your logic here and use self.notify (bellow) to send messages. ALWAYS USE UNICODE MESSAGES
                    self.notify(u"A test message...")
        
        
            # Manage your keys and tokens on https://apps.twitter.com/
            twitter_keys = {
                "consumer_key": "AaAaAaAaAaAaAaAaAaAaAaAaA",
                "consumer_secret": "AaAaAaAaAaAaAaAaAaAaAaAaAAaAaAaAaAaAaAaAaAaAaAaAaA",
                "access_token_key": "999999999-AaAaAaAaAaAaAaAaAaAaAaAaA",
                "access_token_secret": "AaAaAaAaAaAaAaAaAaAaAaAaAAaAaAaAaAaAaAaAaAaAaAaAaA",
            }
        
            # A list of routine classes
            routines = [
                RoutineTest
            ]
        
            core.ExecutorFactory(routines, twitter_keys).create_default().run()
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Information Technology
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: Utilities
