Metadata-Version: 2.1
Name: play_websocket
Version: 0.0.2
Summary: pytest-play support for websockets
Home-page: https://github.com/davidemoro/play_websocket
Author: Davide Moro
Author-email: davide.moro@gmail.com
License: Apache Software License 2.0
Description: ==============
        play websocket
        ==============
        
        
        .. image:: https://img.shields.io/pypi/v/play_websocket.svg
                :target: https://pypi.python.org/pypi/play_websocket
        
        .. image:: https://travis-ci.org/davidemoro/play_websocket.svg?branch=develop
               :target: https://travis-ci.org/davidemoro/play_websocket
        
        .. image:: https://readthedocs.org/projects/play-websocket/badge/?version=latest
                :target: https://play-websocket.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        .. image:: https://codecov.io/gh/davidemoro/play_websocket/branch/develop/graph/badge.svg
                :target: https://codecov.io/gh/davidemoro/play_websocket
        
        
        pytest-play support for websockets
        
        More info and examples on:
        
        * pytest-play_, documentation
        * cookiecutter-qa_, see ``pytest-play`` in action with a working example if you want to start hacking
        
        
        Features
        --------
        
        This project defines new pytest-play_ commands.
        
        Connect
        =======
        
        ::
        
            - type: connect
              provider: play_websocket
              options:
                url: wss://echo.websocket.org/
                timeout: 2
        
        Send
        ====
        
        ::
        
            - type: send
              provider: play_websocket
              url: wss://echo.websocket.org/
              payload: Hello!
        
        
        
        Receive
        =======
        
        ::
        
            - type: recv
              provider: play_websocket
              url: wss://echo.websocket.org/
              variable: data
              variable_expression: response.upper()
              assertion: data == 'HELLO!'
              timeout: 10
        
        
        Receive until
        =============
        
        If you want to filter the data returned by the websocked
        until you get what you expect::
        
            - provider: python
              type: wait_until
              expression: variables['data'] == 'HELLO!'
              timeout: 60
              poll: 0
              sub_commands:
              - type: recv
                provider: play_websocket
                url: wss://echo.websocket.org/
                variable: data
                variable_expression: response.upper()
                timeout: 60
        
        Twitter
        -------
        
        ``pytest-play`` tweets happens here:
        
        * `@davidemoro`_
        
        Credits
        -------
        
        This package was created with Cookiecutter_ and the cookiecutter-play-plugin_ (based on `audreyr/cookiecutter-pypackage`_ project template).
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        .. _`cookiecutter-play-plugin`: https://github.com/davidemoro/cookiecutter-play-plugin
        .. _pytest-play: https://github.com/davidemoro/pytest-play
        .. _cookiecutter-qa: https://github.com/davidemoro/cookiecutter-qa
        .. _`@davidemoro`: https://twitter.com/davidemoro
        
        
        =======
        CHANGES
        =======
        
        0.0.2 (2019-01-25)
        ------------------
        
        - Supports new pytest-play >= 2.0 YAML based syntax (json no more supported)
        
        
        0.0.1 (2018-01-25)
        ------------------
        
        * First release.
        
Keywords: play_websocket
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Provides-Extra: tests
