https://github.com/robocorp/template-extended
Template for extended robot using Robot Framework
https://github.com/robocorp/template-extended
Last synced: over 1 year ago
JSON representation
Template for extended robot using Robot Framework
- Host: GitHub
- URL: https://github.com/robocorp/template-extended
- Owner: robocorp
- License: apache-2.0
- Created: 2021-09-28T15:16:52.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-09T05:54:15.000Z (almost 2 years ago)
- Last Synced: 2025-01-09T09:26:23.493Z (over 1 year ago)
- Language: RobotFramework
- Size: 32.2 KB
- Stars: 5
- Watchers: 20
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# README for the robot
Describe your robot here. E.g., what it does, what the requirements are, how to run it.
## Development guide
Run the robot locally:
```
rcc run
```
Provide access credentials for Control Room connectivity:
```
rcc configure credentials
```
Upload to Control Room:
```
rcc cloud push --workspace --robot
```
### Suggested directory structure
The directory structure given by the template:
```
├── devdata
├── keywords
│ └── keywords.robot
├── libraries
│ └── MyLibrary.py
├── resources
│ └── variables.py
├── conda.yaml
├── robot.yaml
└── tasks.robot
```
where
- `devdata`: A place for all data/material related to development, e.g., test data. Do not put any sensitive data here!
- `keywords`: Robot Framework keyword files.
- `libraries`: Python library code.
- `resources`: Define your resources in a centralized place. For example the robot variables can be defined in here. Do not put any sensitive data here!
- `conda.yaml`: Environment configuration file.
- `robot.yaml`: Robot configuration file.
- `tasks.robot`: Robot Framework task suite - high-level process definition.
In addition to these, you can create your own directories (e.g. `bin`, `tmp`). Add these directories to the `PATH` or `PYTHONPATH` section of `robot.yaml` if necessary.
Logs and artifacts are stored in `output` by default - see `robot.yaml` for configuring this.
Learn how to [handle variables and secrets](https://robocorp.com/docs-robot-framework/development-guide/variables-and-secrets/secret-management).
### Configuration
Give the task name and startup commands in `robot.yaml` with some additional configuration. See [Docs](https://robocorp.com/docs-robot-framework/setup/robot-yaml-format) for more.
Put all the robot dependencies in `conda.yaml`. These are used for managing the execution environment.
### Additional documentation
See [Robocorp Docs](https://robocorp.com/docs-robot-framework) for more documentation.