Metadata-Version: 2.1
Name: whirlwind-web
Version: 0.5.1
Summary: Wrapper around the tornado web server library
Home-page: http://github.com/delfick/whirlwind
Author: Stephen Moore
Author-email: delfick755@gmail.com
License: MIT
Description: Whirlwind
        =========
        
        A wrapper around the tornado web server.
        
        Changlog
        --------
        
        0.5 - Oct 22 2018
            * Initial Release
        
        0.5.1 - Oct 24 2018
            * Made the ``__server_time__`` message for SimpleWebSocketBase optional.
            * Made sure to actually use the reprer set on request handlers
            * ProgressMessageMaker doesn't nest dictionaries it receives
            * Added a transform_progress hook to SimpleWebSocketBase
        
        Installation
        ------------
        
        This package is released to pypi under the name ``whirlwind-web``. When you add
        this package to your setup.py it is recommended you either specify ``[peer]`` as
        well or pin ``input_algorithms``, ``option_merge`` and ``tornado`` to particular
        versions.  See https://github.com/delfick/whirlwind/blob/master/setup.py#L24-L28
        for the recommended versions.
        
        For example:
        
        .. code-block:: python
        
        
            from setuptools import setup, find_packages
            
            setup(
                  name = "test"
                , version = "0.1"
                , include_package_data = True
            
                , install_requires =
                  [ "whirlwind-web[peer]"
                  , "whirlwind-web==0.5.1"
                  ]
                )
        
        Running the tests
        -----------------
        
        To run the tests, create and activate a virtualenv somewhere and then::
        
            $ pip install -e ".[peer,tests]"
            $ pip install -e .
        
        followed by ``./test.sh``
        
        Alternatively::
            
            $ pip install tox
            $ tox
        
        Usage
        -----
        
        See https://whirlwind.readthedocs.io/en/latest/ for usage documentation.
        
Keywords: tornado web
Platform: UNKNOWN
Provides-Extra: peer
Provides-Extra: tests
