Installation & Setup

Prerequisites

• Python 3.7+
• A BotCity account (required for Orchestrator integration)

Setup Steps

1. Clone or Download the Project

Download or clone the BeaPro template to your local machine from BotCity's public GitHub page:

beapro-framework

2. Install Dependencies

pip install -r requirements.txt

3. Configure Environment Variables

Edit the .env file with your BotCity credentials:

SERVER=<your server URL>
LOGIN=<your botcity login>
KEY=<your botcity key>
TASK_ID=<your test task ID>

Note

The .env file is only used for local runs with authentication. It is not required for test mode.

4. Configure Your Data Source

Open framework/datasources.py and choose between CSVSource, DatapoolSource, or implement your own by extending BaseSource.

Execution Modes

BeaPro supports three execution modes:

Mode	Description
Test Mode	Runs locally without any credentials. Mock objects replace Orchestrator features.
Local with Authentication	Uses .env credentials for full Orchestrator integration. Ideal for development.
BotCity Runner	Deployed to BotCity Orchestrator. Credentials are injected automatically.

To run locally in test mode:

python bot.py

To build and deploy to BotCity Orchestrator:

build\build.bat

Monitoring Your Run

After execution, check the following:

• Console output for the execution flow
• output/ folder for log files and CSV results
• temp/ folder for screenshots captured on errors
• BotCity Orchestrator for real-time execution logs and result files (when running with authentication)