bas-remote-python-v2 2.0.2
Python library, which allows you to automate Google Chrome browser via BAS software.
License: MIT
Requires Python: >=3.7,<4.0
Keywords: visual-programming-language,browserautomationstudio,bas-remote-control,bas-remote-client,bot-framework,bas-remote,bas-client,automation,chromium,imacros,windows,desktop,browser,grabber,poster,macros,bas,ide,cef,bot

## This is a fork of https://github.com/CheshireCaat/bas-remote-python

# bas-remote-python

[![PyPI version](https://badge.fury.io/py/bas-remote-python.svg)](https://badge.fury.io/py/bas-remote-python)
[![GitHub issues](https://img.shields.io/github/issues/sergerdn/bas-remote-python-v2)](https://github.com/CheshireCaat/bas-remote-python/issues)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

**bas-remote-python** - Python library, which allows you to **automate Google Chrome browser via BAS software**.

In order to make it possible, BrowserAutomationStudio application is used. **bas-remote-python** allows you to call and
control execution of functions created in BAS. Consider following example, you have a BAS function, which executes
specified Google search query and returns result as a list of urls. Using this library, you can call that function in
any Python application and obtain result. You can distribute applications written with **bas-remote-python** library as
well.

# BrowserAutomationStudio

**BAS** - is application that allows you to automate any activities in Google Chrome browser with a help of visual
programming and without knowing of any programming language. You can think of it as IDE created especially for browser
automation:

![](docs/bas_screen.png)

Check following link for more info:

[https://bablosoft.com/shop/BrowserAutomationStudio](https://bablosoft.com/shop/BrowserAutomationStudio)

# Installation

- via pip:

```
pip install bas-remote-python-v2
```

- via poetry:

```
poetry add bas-remote-python-v2
```

# Quick example

Following code will search for _cats_ query in Google and output result into console. You can just copy and paste this
code
and run it.

```python
import asyncio

from bas_remote import BasRemoteClient
from bas_remote import Options


async def main():
    # Set script name, and optionally auth details (login, password).
    options = Options(script_name='TestRemoteControl')

    # Create client.
    script_client = BasRemoteClient(options)

    # Start application, this may take some time.
    await script_client.start()

    # Set parameters for function.
    script_params = {'Query': 'cats'}

    # Run function and wait for result.
    # Following function will return list of strings.
    result = await script_client.run_function(
        'GoogleSearch',  # or 'YourFunctionName'
        script_params)

    # Iterate and output results.
    for link in result:
        print(link)

    await script_client.close()


if __name__ == '__main__':
    asyncio.run(main())
```

Checkout [wiki](https://github.com/CheshireCaat/bas-remote-python/wiki) for more examples.

# Running custom code

Previous example used _TestRemoteControl_ project and _GoogleSearch_ function defined in it.
In most cases you want to use your own projects and functions. In order to do it:

- Install BAS. Download using following [link](https://bablosoft.com/shop/BrowserAutomationStudio#download).
  **IMPORTANT** You need to be a premium user in order to create project with custom functions.
- Start [record mode](./docs/bas_record_mode.png) and create new function by
  using [function manager](./docs/bas_create_new_func.png). BAS functions works like functions in any other languages.
  They can be called with parameters and can return value as a result. Functions help to incapsulate and reuse your
  code.
- Implement it. On following step you need to implement required functionality. Place code into the function that you
  have created on previous step. They will be called from Python code later. Function parameters will be sent from
  Python to BAS, while return value will be sent from BAS to Python. Working with BAS is out of scope of this article,
  check [BAS wiki](https://wiki.bablosoft.com/doku.php) for more info.
- Compile it and give it a name. Check this [article](https://wiki.bablosoft.com/doku.php?id=how_to_protect_your_script)
  more instruction for compilation.
- Finally, **allow remote function execution** flag for script must be set. You can do that on
  following [page](https://bablosoft.com/bas/scripts). See [screenshot](./docs/bas_allow_remote_func_exec.png) for more
  details.

After project with function is prepared, you can use it from Python.
In order to do that, change script and function name in example above.

# How it works

Following diagram will explain project architecture:

![](./docs/arch.png)

**Running custom code** section explains how to prepare your project and upload it into the cloud. Portable BAS instance
is downloaded and started automatically, it is also closed automatically when `BasRemoteClient` gets closed. Folder,
where portable BAS instance is located by default is _data_ folder relative to executable. It can be customized by
using `options.working_dir` setting.

# Project example

You can use _TestRemoteControl_ project in order to test **bas-remote-python** library. It is already uploaded into the
cloud and can be used without authentication. List of available functions:

- `Add(X,Y)` - adds two numbers and return their sum.
- `SetProxy(Proxy,IsSocks5)` - sets proxy for current thread. _Proxy_ param is proxy string, _IsSocks5_ is string("true"
  , "false") value indicates if proxy type is socks5. No return value.
- `CheckIp()` - returns remote IP of current thread. Uses ip.bablosoft.com service to test. Can be combined with _
  SetProxy_ function.
- `GoogleSearch(Query)` - performs Google query, returns result as a list of urls.

Project source code can be downloaded [here](./docs/TestRemoteControl.xml)

# License

**bas-remote-python** has MIT license.

You can distribute applications using **bas-remote-python** library, including commercial, to user, who don't have BAS
premium subscription without any fees.

In order to create project with custom functions you need to have a BAS premium subscription.

In other words, only developers must have BAS premium subscription, not users.