https://github.com/thin-edge/robotframework-c8y
Robot Framework Library for Cumulocity
https://github.com/thin-edge/robotframework-c8y
Last synced: 6 days ago
JSON representation
Robot Framework Library for Cumulocity
- Host: GitHub
- URL: https://github.com/thin-edge/robotframework-c8y
- Owner: thin-edge
- License: mit
- Created: 2022-12-12T19:51:18.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-06-27T05:19:10.000Z (4 months ago)
- Last Synced: 2025-10-12T06:15:28.201Z (8 days ago)
- Language: Python
- Size: 126 KB
- Stars: 1
- Watchers: 2
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-robotframework - Cumulocity Library
README
# robotframework-c8y
Robot Framework Library for Cumulocity IoT
# Using it
1. Install via pip
```sh
pip install git+https://github.com/reubenmiller/robotframework-c8y.git@0.11.0
```
Or add it to your `requirements.txt` file
```sh
robotframework-c8y @ git+https://github.com/reubenmiller/robotframework-c8y.git@0.11.0
```
Then install it via
```sh
pip install -r requirements.txt
```
2. Create a `.env` file with the following environment variables
```sh
C8Y_BASEURL=https://example.tenant.c8y.com
C8Y_USER=
C8Y_TENANT=t12345
C8Y_PASSWORD=""
```
3. Create a Robot test `tests/Example.robot`
```robot
*** Settings ***
Library Cumulocity
*** Test Cases ***
Device initialization sequence
Device Should Exist tedge01
Device Should Have Installed Software tedge
Device Should Have Measurements minimum=1 type=myCustomMeasurement
```
4. Run the test
```sh
robot tests/Example.robot
```
## Library docs
Checkout the [Cumulocity Library docs](./Cumulocity/Cumulocity.rst)
You can generate the docs yourself using:
```sh
libdoc Cumulocity/Cumulocity.py show > Cumulocity/Cumulocity.rst
```
Or the more interactive html documentation using:
```sh
libdoc Cumulocity/Cumulocity.py Cumulocity/Cumulocity.html
```