Sysrepo Robot Framework Library

Development • Documentation • Support • Contribute • Contributors • Licensing

The goal of this project is to provide a way to use sysrepo with the Robot Framework.

About this component

This repository contains a Robot Framework Python library wrapper around the sysrepo-python sysrepo bindings.

The examples directory contains a simple example test that connects to sysrepo and does some basic validity checks.

Development

The following additional dependencies are required to work on the library:

• libyang
• sysrepo
• xmltodict
• pip
• setuptools
• wheel
• build

Installation

The recommended installation method is using pip:

$ python3 -m pip install robotframework-sysrepolibrary

With recent versions of pip it is also possible to install directly from the GitHub repository. To install from the latest source from the master branch, use the following command:

$ python3 -m pip install git+https://github.com/telekom/sysrepo-library-robot-framework.git

Build

First clone the repository:

$ git clone https://github.com/telekom/sysrepo-library-robot-framework

To build the library run the following commands:

$ python3 -m venv sysrepolibrary-venv
$ source sysrepolibrary-venv/bin/activate
$ python3 -m pip install --upgrade pip setuptools wheel build

To install it:

$ python3 -m pip install .

To install the additional dependencies as well (generating the documentation and testing):

$ python3 -m pip install .[docs,tests]

Code of Conduct

This project has adopted the Contributor Covenant in version 2.0 as our code of conduct. Please see the details in our CODE_OF_CONDUCT.md. All contributors must abide by the code of conduct.

Working Language

We decided to apply English as the primary project language.

Consequently, all content will be made available primarily in English. We also ask all interested people to use English as language to create issues, in their code (comments, documentation etc.) and when you send requests to us. The application itself and all end-user facing content will be made available in other languages as needed.

Documentation

The documentation for the Sysrepo Robot Framework Library can be generated using the Sphinx documentation generator tool. The documentation sources are located in docs/source

To build the documentation as HTML files run while in the root directory:

$ sphinx-build -b html docs/source docs/build/html

The -b option selects a builder in this example it's HTML.

To quickly generate the docs use the scripts in the docs/ directory. Execute make without an argument while in the directory to see which targets are available.

Example for HTML:

docs/$ make html

Support and Feedback

The following channels are available for discussions, feedback, and support requests:

Type	Channel
Issues
Other Requests

How to Contribute

Contribution and feedback is encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines. By participating in this project, you agree to abide by its Code of Conduct at all times.

Contributors

Our commitment to open source means that we are enabling -in fact encouraging- all interested parties to contribute and become part of its developer community.

Licensing

Copyright (C) 2023 Deutsche Telekom AG.

Licensed under the BSD 3-Clause License (the "License"); you may not use this file except in compliance with the License.

You may obtain a copy of the License by reviewing the file LICENSE in the repository.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.