Metadata-Version: 2.1
Name: robot-lockable
Version: 0.2.1
Summary: Robot Framework plugin for lockable resources
Home-page: https://github.com/jupe/robot-lockable
Author: Jussi Vatjus-Anttila
Author-email: jussiva@gmail.com
License: MIT
Project-URL: Bug Reports, https://github.com/jupe/robot-lockable
Project-URL: Source, https://github.com/jupe/robot-lockable/
Description: # Robot Framework Remote Resource Allocator
        
        Resource locking library for Robot Framework.
        
        # Usage
        
        Library import
        ```
        Library     RobotLockable       lock_folder=.   resource_list_file=example/resource.json    (hostname=hostname)
        ```
        
        Available Keywords
        
        | keyword | arguments | note | 
        |---------|----|----|
        | `lock` | `<requirements>` (`<timeout_s>`)   | Allocate resource using giving requirements |
        | `unlock` | `<resource>` | Release resource |
        
        See more details using Remote library CLI to generate documentation:
        `python3 RobotLockable/Remote.py --doc`
        
        # Remote server
        
        Library provide command line util `robot_lockable` that provide robot remote 
        server for lockable functionality. 
        This is useful when resources located remotely 
        for test case.
        
        ```
        robot_lockable --help
        Usage: robot_lockable [OPTIONS]
        
          main function for remote plugin
        
        Options:
          --port INTEGER              RemoteLockable server Port
          --host TEXT                 Interface to listen. Use "0.0.0.0" to get access
                                      from external machines
        
          --hostname TEXT             Hostname
          --resources_list_file TEXT  Resources list file
          --lock_folder TEXT          Lock folder
          --doc TEXT                  generate documentation. E.g. doc.html or list
          --help                      Show this message and exit.
        ```
        
        # Run Remote Server In Docker Container
        
        Docker container is run using command below. Replace path to resource.json and hostname with project specific values:
        
            docker run \
              -p 8270:8270 \
              -v <local path to the resource.json folder>:/<path to resource.json folder> \
              --hostname $(hostname) \
              jussiva/robot-lockable:latest \
              --resources_list_file <path to resource.json folder>
        
        ## Full example
        
        To run example resource allocator located in this repository, docker run command is:
        
            docker run \
              -p 8270:8270 \
              -v $PWD/example:/example/ \
              --hostname hostname \
              --rm \
              jussiva/robot-lockable:latest \
              --resources_list_file /example/resource.json
        
Keywords: robot-framework lockable framework resource
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Software Development :: Testing
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Testing
Classifier: Framework :: Robot Framework
Classifier: Framework :: Robot Framework :: Library
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
