Metadata-Version: 2.1
Name: rallf
Version: 0.1.9
Summary: rallf.com Software Development Kit (SDK)
Home-page: https://github.com/robotunion/rallf-python-sdk
Author: Lluis Santos
Author-email: lluis@rallf.com
License: UNKNOWN
Description: # RALF Python SDK
        RALLF SDK provides the tools to create tasks for rallf robots (rallf.com) using python3.
        
        ## Installation
        ### Using Python Package Index (PyPI)
        ```bash
        pip3 install rallf
        ```
        
        ### From source
        ```bash
        git clone https://github.com/RobotUnion/rallf-python-sdk
        cd rallf-python-sdk
        python3 setup.py install
        ```
        
        ## Basic usage (hello bot)
        ### Create `hello.py`
        ```python3
        # File: hello.py
        
        import rallf
        
        '''
          Hello task opens github and returns the title of the page upon it is loaded.
          To learn more about python selenium api, see https://selenium-python.readthedocs.io/
        '''
        class Hello(rallf.Task):
        
            # implementing self.run is required for tasks
            def run(self, input):
                # Log stuff via the available logger
                self.logger.debug('Hello Bot')
            
                # get a firefox instance
                browser = self.robot.devices['firefox']
                browser.get('https://github.com')
                return browser.getTitle()
            
        ```
        ### Try it
        ```bash
        rallf start hello
        ```
        
        ## Extended usage
        ### Task Manifest
        ### Injected objects
        - `self.robot`: this object is injected in the task creation
        - `input`: this parameter is passed to the `run(self, input)` function
        ### Inter-task communication (task delegates)
        ### Task lifecycle callbacks
        - `warmup(self)`: this optional method is executed some time before the task starts to speed-up the `run` function.
        - `run(self, input)`: this required method handles the work of the task and is triggered at start of the task.
        - `cooldown(self)`: this method is called when the task is going to be some time without use.
        
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Description-Content-Type: text/markdown
