Metadata-Version: 1.1
Name: simple_timer
Version: 0.2
Summary: A timer module. Makes it easy to track elapsed time.
Home-page: https://bitbucket.org/barseghyanartur/timer
Author: Artur Barseghyan
Author-email: artur.barseghyan@gmail.com
License: GPL 2.0/LGPL 2.1
Description: ===============
        simple_timer
        ===============
        
        Description
        -----------------
        A timer module. Makes it easy to track elapsed time.
        
        Installation
        -----------------
        Latest stable version on PyPI:
        
        $ pip install simple_timer
        
        Latest stable version on bitbucket:
        
        $ pip install -e hg+http://bitbucket.org/barseghyanartur/timer@stable#egg=simple_timer
        
        Usage example
        -------------------------------------
        Required imports.
        
        >>> from simple_timer import Timer
        
        Initialise timer.
        
        >>> timer = Timer()
        
        Print elapsed duration.
        
        >>> print timer.duration
        0.16
        
        Print elapsed timedelta.
        
        >>> print timer.timedelta
        datetime.timedelta(0, 0, 7)
        
        Stop the timer. Stopping the timer makes the ``duration`` and ``timedelta`` properties to freeze.
        
        >>> timer.stop()
        
        Print frozen timedelta value.
        
        >>> print timer.timedelta
        datetime.timedelta(0, 2, 943660)
        
        Print frozen duration value.
        
        >>> print timer.duration
        2.94366
        
        Once stoped, when calling the ``stop`` method again unfreezes the timer, calculates the new values and
        freezes the timer again.
        
        >>> timer.stop_and_return_duration()
        143.230978
        
        >>> timer.stop_and_return_timedelta()
        datetime.timedelta(0, 170, 351115)
        
        License
        -----------------
        GPL 2.0/LGPL 2.1
        
        Author
        -----------------
        Artur Barseghyan <artur.barseghyan@gmail.com>
        
Keywords: timer
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
