Metadata-Version: 1.0
Name: narcolepsy
Version: 0.0.2
Summary: Give your application a break.
Home-page: https://github.com/bworrell
Author: Bryan Worrell
Author-email: bworrell@notmyemail.com
License: UNKNOWN
Description: narcolepsy
        ==========
        
        Sleep soundly. Sleep randomly.
        
        
        Overview
        --------
        
        The ``narcolepsy`` package contains code which alters the behavior of your
        application/api by injecting random sleep calls into decorated functions.
        
        
        Usage
        -----
        
        The following code is an example of using the ``@narcoleptic`` decorator.
        
        ::
        
            from narcolepsy import narcoleptic
        
            @narcoleptic(max=5)  # sleep for 5 seconds at max
            def foobar():
                for x in xrange(1024):
                    nested_function(x)
                    
        The ``@narcoleptic`` decorator takes three parameters (all optional):
        
        *  ``min``: The minimum sleep time in seconds.
        *  ``max``: The maximum sleep time in seconds.
        *  ``chance``: The maximum number of lines that will be executed before a ``sleep()`` 
           call is injected.
        
        If no ``min`` or ``max`` are passed in, the constants defined in 
        ``narcolepsy.constants`` will be used instead.
        If no ``chance`` is passed in, a value will be derived from the number of lines 
        in the input function.
        
        Installation
        ------------
        
        The easiest way to install ``narcolepsy`` is via ``pip``:
        
        ::
        
            $ pip install narcolepsy
        
        
        Why?
        ----
        
        Playing around with line tracers. In theory this could help test time-critical
        code (multi-producer/consumer concurrent applications).
        
        LICENSE
        -------
        
        See the LICENSE file for details.
        
Keywords: narcolepsy sleep timing useless
Platform: UNKNOWN
