{"id":24811089,"url":"https://github.com/thin-edge/robotframework-devicelibrary","last_synced_at":"2025-10-13T12:31:35.038Z","repository":{"id":69665440,"uuid":"579425224","full_name":"thin-edge/robotframework-devicelibrary","owner":"thin-edge","description":null,"archived":false,"fork":false,"pushed_at":"2025-10-07T09:44:50.000Z","size":160,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-07T11:36:51.118Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thin-edge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-12-17T16:50:12.000Z","updated_at":"2025-10-07T09:44:32.000Z","dependencies_parsed_at":"2023-10-04T09:34:57.900Z","dependency_job_id":"329396a5-fd99-49f2-a953-43acd3c174ad","html_url":"https://github.com/thin-edge/robotframework-devicelibrary","commit_stats":null,"previous_names":["thin-edge/robotframework-devicelibrary"],"tags_count":129,"template":false,"template_full_name":null,"purl":"pkg:github/thin-edge/robotframework-devicelibrary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thin-edge%2Frobotframework-devicelibrary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thin-edge%2Frobotframework-devicelibrary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thin-edge%2Frobotframework-devicelibrary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thin-edge%2Frobotframework-devicelibrary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thin-edge","download_url":"https://codeload.github.com/thin-edge/robotframework-devicelibrary/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thin-edge%2Frobotframework-devicelibrary/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279015056,"owners_count":26085643,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-30T12:19:16.566Z","updated_at":"2025-10-13T12:31:34.678Z","avatar_url":"https://github.com/thin-edge.png","language":"Python","funding_links":[],"categories":["Libraries"],"sub_categories":["IoT"],"readme":"# robotframework-devicelibrary\n\nRobot Framework Library for creating and interacting with devices using various adapters such as ssh, docker and local devices using the same interface.\n\n# Using it\n\n1. Install via pip\n\n    ```sh\n    pip install robotframework-devicelibrary[all]  git+https://github.com/reubenmiller/robotframework-devicelibrary.git@0.24.4\n    ```\n\n    Or add it to your `requirements.txt` file\n\n    ```sh\n    robotframework-devicelibrary[all] @ git+https://github.com/reubenmiller/robotframework-devicelibrary.git@0.24.4\n    ```\n\n    Then install it via\n\n    ```sh\n    pip install -r requirements.txt\n    ```\n\n2. Create a `.env` file with the following environment variables (which will be the secrets)\n\n    ```sh\n    # SSH config (which device should be tested when using ssh)\n    SSH_CONFIG_HOSTNAME=\n    SSH_CONFIG_USERNAME=\n    SSH_CONFIG_PASSWORD=\n    ```\n\n3. Create a common resource which contains your settings `tests/common.resource`\n\n    ```robot\n    ${DEVICE_ADAPTER}    docker\n    \u0026{SSH_CONFIG}        hostname=%{SSH_CONFIG_HOSTNAME= }    username=%{SSH_CONFIG_USERNAME= }    password=%{SSH_CONFIG_PASSWORD= }\n    \u0026{DOCKER_CONFIG}     image=%{DOCKER_CONFIG_IMAGE=debian-systemd}\n    ```\n\n    **Note**\n\n    The common resource references the secrets stored in the .env file so secrets can be kept out of the repository.\n\n4. Create a Robot test `tests/Example.robot`\n\n    ```robot\n    *** Settings ***\n    Resource       common.resource\n    Library        DeviceLibrary    adapter=ssh\n\n    *** Test Cases ***\n    Check command execution\n        Setup Device\n        Execute Command On Device    ls -la /etc/\n        Process Should Be Running On Device    ssh\n    ```\n\n5. Run the test\n\n    ```sh\n    robot tests/Example.robot\n    ```\n\n## Library docs\n\nCheckout the [DeviceLibrary docs](./docs/DeviceLibrary.rst)\n\nYou can generate the docs yourself using:\n\n```sh\nlibdoc DeviceLibrary/DeviceLibrary.py show \u003e docs/DeviceLibrary.rst\n```\n\nOr you can create the html docs using:\n\n```sh\nlibdoc ./DeviceLibrary/DeviceLibrary.py docs/DeviceLibrary.html\n```\n\nThen open the [docs/DeviceLibrary.html](docs/DeviceLibrary.html) file in your local web browser.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthin-edge%2Frobotframework-devicelibrary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthin-edge%2Frobotframework-devicelibrary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthin-edge%2Frobotframework-devicelibrary/lists"}