Metadata-Version: 2.1
Name: robotframework-async-keyword
Version: 1.1.6
Summary: Generic Robot Framework library for asynchronous keyword execution
Author-email: René Lehfeld <54720674+rlehfeld@users.noreply.github.com>
License: The MIT License (MIT)
        Copyright (c) 2015-2023 Fredrik Reveny, René Lehfeld and others
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/rlehfeld/robotframework-async-keyword
Project-URL: Bug Reports, https://github.com/rlehfeld/robotframework-async-keyword/issues
Project-URL: Source, https://github.com/rlehfeld/robotframework-async-keyword/
Keywords: async,robotframework
Classifier: Programming Language :: Python :: 3
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE.txt

Robot Framework AsyncLibrary
============================
Generic Robot Framework library for asynchronous keyword execution

Installation
============
Install the latest release via PyPi using pip:

::

    pip install robotframework-async-keyword

Or add to your ``conda.yaml`` file:

::

    - pip:
        - robotframework-async-keyword


In oder to help with development you can directly install from GitHub via:

::

    pip install git+https://github.com/rlehfeld/robotframework-async-keyword.git

Or add to your ``conda.yaml`` file:

::

    - pip:
        - git+https://github.com/rlehfeld/robotframework-async-keyword.git


Usage
=====

#) Import into a test suite with:

   .. code:: robotframework

      Library AsyncLibrary

#) To run a keyword asynchronously:

   .. code:: robotframework

      ${handle}    Async Run    some keyword    first argument    second argument

#) To retrieve the return value, a blocking call to ``Async Get`` is called with the handle:

   .. code:: robotframework

      ${return_value}    Async Get    ${handle}

#) To wait with a timeout use

   .. code:: robotframework

      ${return_value}    Async Get    ${handle}    timeout=5 sec
